openapi: 3.0.0
info:
  title: Ciena MCP 5.3
  description: Ciena MCP API specification
  contact: {}
  version: '5.3.0'
servers:
- url: http://localhost/
  variables: {}
- url: https://localhost/
  variables: {}
paths:
  /nsa/api/v1/alarms/alarmRecordsCounts:
    get:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: getTotalRecordsCount
      description: Alarm record counts returned in JSON format.
      operationId: getTotalRecordsCount
      parameters: []
      responses:
        '200':
          description: Successfully retrieved the total number of alarm records
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TotalAlarmRecordsCount'
        '500':
          description: Request failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v1/alarms/device-types:
    get:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: getDeviceTypes
      description: Device types returned in JSON format.
      operationId: getDeviceTypes
      parameters: []
      responses:
        '200':
          description: Successfully retrieved device types
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceTypesRO'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No device types found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Returning collection of device types failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v1/alarms/deviceAttributes/{Id}:
    get:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: getDeviceAttributes
      description: Device specific attributes returned in JSON format.
      operationId: getDeviceAttributes
      parameters:
      - name: Id
        in: path
        description: Requested node Identifier.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved device attributes by device session id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceAttributesRO'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Device attributes not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Device attributes request failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v1/alarms/historicalAlarms/{retentionDate}:
    delete:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: removeOldHistoricalAlarms
      description: Use with caution!
      operationId: removeOldHistoricalAlarms
      parameters:
      - name: retentionDate
        in: path
        description: Removed date in _yyyymmdd_ format
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully removed historical alarms
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Removing historical alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v1/alarms/historicalChangePartition:
    get:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: getHistoricalChangePartition
      description: Get configuration of if historical alarms change partition.
      operationId: getHistoricalChangePartition
      parameters: []
      responses:
        '200':
          description: Successfully return the configured historical change partition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionDaysRO'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to get the historical change partition (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v1/alarms/historicalDataRetentionDays:
    get:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: getHistoricalDataRetentionDays
      description: Get configuration of historical data retention days.
      operationId: getHistoricalDataRetentionDays
      parameters: []
      responses:
        '200':
          description: Successfully return the configured historical data retention days
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionDaysRO'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to get the historical data retention days (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v1/alarms/historicalDataRetentionDays/{retentionDays}:
    put:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: setHistoricalDataRetentionDays
      description: Use with caution! The expired data based on the new retention day will be deleted.
      operationId: setHistoricalDataRetentionDays
      parameters:
      - name: retentionDays
        in: path
        description: Number of historical data retention days. Must be between 1 - 365
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successfully set the new historical data retention days
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Set the new historical data retention days failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v1/alarms/{Id}/acknowledge:
    post:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: acknowledgeAlarmV1
      description: Only active Alarms can be acknowledged.
      operationId: acknowledgeAlarmV1
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _acknowledged_.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully acknowledged alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Acknowledging a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v1/alarms/{Id}/force-clear:
    post:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: forceClearAlarmV1
      description: Never use this REST API unless you have no other option.
      operationId: forceClearAlarmV1
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _cleared_.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully force cleared alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Clearing a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v1/alarms/{Id}/manual-clear:
    post:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: manualClearAlarmV1
      description: Only manually clearable alarms can be cleared.
      operationId: manualClearAlarmV1
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _cleared_.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully manually cleared alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Clearing a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v1/alarms/{Id}/unacknowledge:
    post:
      tags:
      - Retrieve and modify alarms (version 1)
      summary: unacknowledgeAlarmV1
      description: Only active Alarms can be unacknowledged.
      operationId: unacknowledgeAlarmV1
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _unacknowledged_.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully un-acknowledged alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Un-acknowledging a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v2_0/alarms/alarm-sync-states:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: getAlarmSyncStates
      description: Get a collection of alarm sync states of given nodes
      operationId: getAlarmSyncStates
      parameters: []
      requestBody:
        description: Alarm query list
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AlarmQueryList'
              - description: Alarm query list
        required: true
      responses:
        '200':
          description: Successfully retrieved alarm sync states
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeAlarmStateRO'
        '500':
          description: Internal error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/resetRequestId/{serverId}:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: resetRequestIdsForServerId
      description: Reset request IDs for all alarms/events for this server ID to zero in order to recover from an early request ID roll over
      operationId: resetRequestIdsForServerId
      parameters:
      - name: serverId
        in: path
        description: Requested node Identifier.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully reset request IDs
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to reset request IDs (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/{Id}/acknowledge/{sequenceId}:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: acknowledgeAlarm
      description: Only active Alarms can be acknowledged.
      operationId: acknowledgeAlarm
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _acknowledged_.
        required: true
        style: simple
        schema:
          type: string
      - name: sequenceId
        in: path
        description: The alarm's last raise time in milliseconds.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully acknowledged alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Acknowledging a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/{Id}/annotate:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: annotateAlarm
      description: Only active Alarms can be annotated.
      operationId: annotateAlarm
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _annotated_.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Annotation event
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Annotation'
              - description: Annotation event
        required: true
      responses:
        '204':
          description: Successfully annotate alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Annotating a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/{Id}/force-clear/{sequenceId}:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: forceClearAlarm
      description: Never use this REST API unless you have no other option.
      operationId: forceClearAlarm
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _cleared_.
        required: true
        style: simple
        schema:
          type: string
      - name: sequenceId
        in: path
        description: The alarm's last raise time in milliseconds.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully force cleared alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Clearing a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/{Id}/manual-clear/{sequenceId}:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: manualClearAlarm
      description: Only manually clearable alarms can be cleared.
      operationId: manualClearAlarm
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _cleared_.
        required: true
        style: simple
        schema:
          type: string
      - name: sequenceId
        in: path
        description: The alarm's last raise time in milliseconds.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully manually cleared alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Clearing a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/{Id}/removeAnnotation:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: removeAnnotation
      description: Only active Alarms can be annotated.
      operationId: removeAnnotation
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _annotated_.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully un-annotated alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Un-annotating a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/{Id}/unacknowledge/{sequenceId}:
    post:
      tags:
      - Retrieve and modify alarms (version 2)
      summary: unacknowledgeAlarm
      description: Only active Alarms can be unacknowledged.
      operationId: unacknowledgeAlarm
      parameters:
      - name: Id
        in: path
        description: Identifier of the alarm to be marked as _unacknowledged_.
        required: true
        style: simple
        schema:
          type: string
      - name: sequenceId
        in: path
        description: The alarm's last raise time in milliseconds.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully un-acknowledged alarm
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Un-acknowledging a specific active alarm failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v1/alarms/filter/activeAlarmCountsBasic:
    get:
      tags:
      - Search and filter alarms (version 1)
      summary: getActiveAlarmCounts
      description: Query active alarm counts of severity CRITICAL, MAJOR, MINOR and WARNING.
      operationId: getActiveAlarmCounts
      parameters: []
      responses:
        '200':
          description: Successfully retrieved alarm counts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Alarm counts retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v1/alarms/filter/activeAlarms:
    get:
      tags:
      - Search and filter alarms (version 1)
      summary: searchActiveAlarms
      description: List of active Alarms returned in JSON format.
      operationId: searchActiveAlarms
      parameters:
      - name: severity
        in: query
        description: 'Severity values as a comma separated list. Example: CRITICAL, MAJOR, MINOR, WARNING'
        style: form
        explode: true
        schema:
          type: string
      - name: serviceAffecting
        in: query
        description: 'Service Affecting values as a comma separated list. Example: SERVICE_AFFECTING, NON_SERVICE_AFFECTING'
        style: form
        explode: true
        schema:
          type: string
      - name: deviceType
        in: query
        description: 'Device type values as a comma separated list. Example: OPENSTACK, CN6500, NUAGE'
        style: form
        explode: true
        schema:
          type: string
      - name: acknowledgeState
        in: query
        description: 'Acknowledgment state values as a comma separated list.Example: ACKNOWLEDGED, NOT_ACKNOWLEDGED'
        style: form
        explode: true
        schema:
          type: string
      - name: keytext
        in: query
        description: "Key text to be present in the supported alarm fields. Supported fields include: condition-severity, node-name, resource, acknowledge-state, native-condition-type, and additional-text. Several operators are available including '+' (AND), '|' (OR), '-' (negate)."
        style: form
        explode: true
        schema:
          type: string
      - name: range
        in: query
        description: 'Comma separated last raised time range in format: yyyy-MM-ddTHH:mm:ss.SSS. Example: 1900-01-01T00:00:00.000,2999-12-31T23:59:59.999'
        style: form
        explode: true
        schema:
          type: string
      - name: sorting
        in: query
        description: 'Alarm attribute that the response will be sorted on, such as raiseTime, either in ascending or descending order. Example: last-raise-time:DESC'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Offset for the next page of results. Example: 50'
        style: form
        explode: true
        schema:
          type: string
          default: '0'
      - name: pageSize
        in: query
        description: Limit of the number of alarms present in a page.
        style: form
        explode: true
        schema:
          type: string
          default: '500'
      responses:
        '200':
          description: Successfully retrieved filtered list of alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveAlarms'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Search on alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v1/alarms/filter/historicalAlarms:
    get:
      tags:
      - Search and filter alarms (version 1)
      summary: searchHistoricalAlarms
      description: List of historical cleared Alarms returned in JSON format.
      operationId: searchHistoricalAlarms
      parameters:
      - name: severity
        in: query
        description: 'Severity values as a comma separated list. Example: CRITICAL, MAJOR, MINOR, WARNING'
        style: form
        explode: true
        schema:
          type: string
      - name: serviceAffecting
        in: query
        description: 'Service Affecting values as a comma separated list. Example: SERVICE_AFFECTING, NON_SERVICE_AFFECTING'
        style: form
        explode: true
        schema:
          type: string
      - name: deviceType
        in: query
        description: 'Device type values as a comma separated list. Example: OPENSTACK, CN6500, NUAGE'
        style: form
        explode: true
        schema:
          type: string
      - name: keytext
        in: query
        description: "Key text to be present in the supported alarm fields. Supported fields include: condition-severity, node-name, resource, acknowledge-state, native-condition-type, and additional-text. Several operators are available including '+' (AND), '|' (OR), '-' (negate)."
        style: form
        explode: true
        schema:
          type: string
      - name: range
        in: query
        description: 'Comma separated clear time range in format: yyyy-MM-ddTHH:mm:ss.SSS. Example: 1900-01-01T0:0:0.000,2999-12-31T23:59:59.999'
        style: form
        explode: true
        schema:
          type: string
      - name: sorting
        in: query
        description: 'Alarm attribute that the response will be sorted on, such as raiseTime, either in ascending or descending order. Example: last-raise-time:DESC'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Offset for the next page of results. Example: 50'
        style: form
        explode: true
        schema:
          type: string
          default: '0'
      - name: pageSize
        in: query
        description: Limit of the number of alarms present in a page.
        style: form
        explode: true
        schema:
          type: string
          default: '500'
      responses:
        '200':
          description: Successfully retrieved filtered list of alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalAlarms'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Search on alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v2_0/alarms/filter:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getAllFilters
      description: Get all alarm filters active on the system.
      operationId: getAllFilters
      parameters: []
      responses:
        '200':
          description: Successfully retrieved alarm filters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filters'
        '500':
          description: Filter creation failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Search and filter alarms (version 2)
      summary: createFilter
      description: Create a unique Alarm filter.
      operationId: createFilter
      parameters: []
      requestBody:
        description: Alarm filter
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Filter'
              - description: Alarm filter
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filter'
        '201':
          description: Filter successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filter'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Filter creation failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/activeAlarmCounts:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: GetgetActiveAlarmCounts
      description: Query active alarm counts of severity CRITICAL, MAJOR, MINOR and WARNING.
      operationId: GetgetActiveAlarmCounts
      parameters: []
      responses:
        '200':
          description: Successfully retrieved alarm counts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Alarm counts retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/activeAlarms:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: searchActiveAlarmsV2
      description: List of active Alarms returned in JSON format.
      operationId: searchActiveAlarmsV2
      parameters:
      - name: filter[severity]
        in: query
        description: 'Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL,MAJOR,MINOR,WARNING_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[serviceAffecting]
        in: query
        description: 'Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING,NON_SERVICE_AFFECTING_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[deviceType]
        in: query
        description: 'Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500,OPENSTACK,NUAGE_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[acknowledgeState]
        in: query
        description: 'Acknowledgment state values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _ACKNOWLEDGED,NOT_ACKNOWLEDGED_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[deviceId]
        in: query
        description: 'Device id values as a comma separated list.<p>**Example**: _ID1,ID2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[deviceName]
        in: query
        description: 'Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1,NAME2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[ipAddress]
        in: query
        description: 'IP address values as a comma separated list.<p>**Example**: _192.168.42.2,192.168.42.3_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[macAddress]
        in: query
        description: 'Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[additionalText]
        in: query
        description: 'Additional text values as a comma separated list.<p>**Example**: _TEXT1,TEXT2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[annotation]
        in: query
        description: 'Annotation text values as a comma separated list.<p>**Example**: _ANNOTATION1,ANNOTATION2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[nativeConditionType]
        in: query
        description: 'Native condition type values as a comma separated list.<p>**Example**: _TYPE1,TYPE2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[resource]
        in: query
        description: 'Resource values as a comma separated list.<p>**Example**: _RESOURCE1,RESOURCE2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[subnetName]
        in: query
        description: 'Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01,SUBNET02_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[cardType]
        in: query
        description: 'Card type values as a comma separated list.<p>**Example**: _SP-2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clfi]
        in: query
        description: 'CLFI values as a comma separated list.<p>**Example**: _CLFI01,CLFI02_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[fic]
        in: query
        description: 'FIC values as a comma separated list.<p>**Example**: _FIC01,FIC02_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: sorting
        in: query
        description: 'Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Offset for the next page of results.<p>**Example**: _50_</p>'
        style: form
        explode: true
        schema:
          type: string
          default: '0'
      - name: pageSize
        in: query
        description: Limit of the number of alarms present in a page.
        style: form
        explode: true
        schema:
          type: string
          default: '500'
      responses:
        '200':
          description: Successfully retrieved filtered list of alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Search on alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v2_0/alarms/filter/additionalTextAggregations:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getAdditionalTexts
      description: Returned in JSON format.
      operationId: getAdditionalTexts
      parameters:
      - name: filter[additionalText]
        in: query
        description: 'Partial additional text filter value with a minimum of 3 characters.<p>**Example**: _TEX_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: selected[additionalText
        in: query
        description: 'Additional text values as a comma separated list.<p>**Example**: _TEXT1,TEXT2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved additional texts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdditionalTextsAggregation'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Additional texts retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/deviceNamesAggregations:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getDeviceNames
      description: Returned in JSON format.
      operationId: getDeviceNames
      parameters:
      - name: filter[deviceName]
        in: query
        description: 'Partial case sensitive device name filter value with a minimum of 3 characters.<p>**Example**: _NAME1_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: selected[deviceName
        in: query
        description: 'Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1,NAME2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved device names
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceNamesAggregation'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Device names retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/filteredAlarms:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: searchFilteredAlarms
      description: List of filtered Alarms returned in JSON format.
      operationId: searchFilteredAlarms
      parameters:
      - name: filter[alarmId
        in: query
        description: 'Alarm id values as a comma separated list.<p>**Example**: _ID1,ID2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[state
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[severity
        in: query
        description: 'Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL,MAJOR,MINOR,WARNING_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[serviceAffecting
        in: query
        description: 'Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING,NON_SERVICE_AFFECTING_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceType
        in: query
        description: 'Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500,OPENSTACK,NUAGE_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[acknowledgeState
        in: query
        description: 'Acknowledgment state values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _ACKNOWLEDGED,NOT_ACKNOWLEDGED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceId
        in: query
        description: 'Device id values as a comma separated list.<p>**Example**: _ID1,ID2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceName
        in: query
        description: 'Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1,NAME2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[ipAddress
        in: query
        description: 'IP address values as a comma separated list.<p>**Example**: _192.168.42.2,192.168.42.3_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[macAddress
        in: query
        description: 'Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceTag
        in: query
        description: 'Device tag values as a comma separated list.<p>**Example**: _Tag1,Tag2_'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[additionalText
        in: query
        description: 'Additional text values as a comma separated list.<p>**Example**: _TEXT1,TEXT2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[annotation
        in: query
        description: 'Annotation text values as a comma separated list.<p>**Example**: _ANNOTATION1,ANNOTATION2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[nativeConditionType
        in: query
        description: 'Native condition type values as a comma separated list.<p>**Example**: _TYPE1,TYPE2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[resource
        in: query
        description: 'Resource values as a comma separated list.<p>**Example**: _RESOURCE1,RESOURCE2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[resourceList]
        in: query
        description: 'Resource values as a comma separated list.<p>**Example**: _RESOURCE1,RESOURCE2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[resourceId
        in: query
        description: 'Resource ID values as a comma separated list.<p>**Example**: _RESOURCEID1,RESOURCEID2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[subnetName
        in: query
        description: 'Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01,SUBNET02_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[cardType
        in: query
        description: 'Card type values as a comma separated list.<p>**Example**: _SP-2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[clfi
        in: query
        description: 'CLFI values as a comma separated list.<p>**Example**: _CLFI01,CLFI02_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[fic
        in: query
        description: 'FIC values as a comma separated list.<p>**Example**: _FIC01,FIC02_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[partition
        in: query
        description: 'Partition values as a comma separated list. "none" for alarms of NEs with no partition <p>**Example**: _a08a7792-27a5-42d3-9169-2826d3d32b0c,3541ccf8-03d2-3c0a-a7e5-3b88ca78df35_'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTimeFrom]
        in: query
        description: 'Last raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTimeTo]
        in: query
        description: 'Last raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTimeFrom]
        in: query
        description: 'Last clear time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTimeTo]
        in: query
        description: 'Last clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: 'Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[refinedRaisedTimeFrom]
        in: query
        description: 'Refined raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[refinedRaisedTimeTo]
        in: query
        description: 'Refined raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[refinedClearTimeFrom]
        in: query
        description: 'Refined cleared time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[refinedClearTimeTo]
        in: query
        description: 'Refined clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[allTime]
        in: query
        description: 'Comma separated time range to be searched in both active and historical alarms, in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Offset for the next page of results.<p>**Example**: _50_</p>'
        style: form
        explode: true
        schema:
          type: string
          default: '0'
      - name: pageSize
        in: query
        description: Limit of the number of alarms present in a page.
        style: form
        explode: true
        schema:
          type: string
          default: '500'
      responses:
        '200':
          description: Successfully retrieved filtered list of alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Search on alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Search and filter alarms (version 2)
      summary: searchFilteredAlarmsWithBody
      description: List of filtered Alarms returned in JSON format.
      operationId: searchFilteredAlarmsWithBody
      parameters: []
      requestBody:
        description: Filtered alarms parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FilteredAlarmsParams'
              - description: Filtered alarms parameters
        required: false
      responses:
        '200':
          description: Successfully retrieved filtered list of alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Search on alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/filteredAlarms/{Id}:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getFilteredAlarm
      description: Alarm returned in JSON format.
      operationId: getFilteredAlarm
      parameters:
      - name: Id
        in: path
        description: Requested alarm identifier.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved alarm by ID
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarm'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: A specific active alarm retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/getCorrelatedAlarmsByService:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: searchCorrelatedAlarms
      description: List of filtered correlated alarms returned in JSON format.
      operationId: searchCorrelatedAlarms
      parameters:
      - name: serviceId
        in: query
        description: service Id
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: filter[severity
        in: query
        description: 'Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL,MAJOR,MINOR,WARNING_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[serviceAffecting
        in: query
        description: 'Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING,NON_SERVICE_AFFECTING_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceType
        in: query
        description: 'Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500,OPENSTACK,NUAGE_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[acknowledgeState
        in: query
        description: 'Acknowledgment state values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _ACKNOWLEDGED,NOT_ACKNOWLEDGED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceId
        in: query
        description: 'Device id values as a comma separated list.<p>**Example**: _ID1,ID2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceName
        in: query
        description: 'Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1,NAME2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[ipAddress
        in: query
        description: 'IP address values as a comma separated list.<p>**Example**: _192.168.42.2,192.168.42.3_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[macAddress
        in: query
        description: 'Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[deviceTag
        in: query
        description: 'Device tag values as a comma separated list.<p>**Example**: _Tag1,Tag2_'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[additionalText
        in: query
        description: 'Additional text values as a comma separated list.<p>**Example**: _TEXT1,TEXT2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[annotation
        in: query
        description: 'Annotation text values as a comma separated list.<p>**Example**: _ANNOTATION1,ANNOTATION2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[nativeConditionType
        in: query
        description: 'Native condition type values as a comma separated list.<p>**Example**: _TYPE1,TYPE2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[resource
        in: query
        description: 'Resource values as a comma separated list.<p>**Example**: _RESOURCE1,RESOURCE2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[resourceList]
        in: query
        description: 'Resource values as a comma separated list.<p>**Example**: _RESOURCE1,RESOURCE2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[resourceId
        in: query
        description: 'Resource ID values as a comma separated list.<p>**Example**: _RESOURCEID1,RESOURCEID2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[subnetName
        in: query
        description: 'Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01,SUBNET02_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[cardType
        in: query
        description: 'Card type values as a comma separated list.<p>**Example**: _SP-2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[clfi
        in: query
        description: 'CLFI values as a comma separated list.<p>**Example**: _CLFI01,CLFI02_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[fic
        in: query
        description: 'FIC values as a comma separated list.<p>**Example**: _FIC01,FIC02_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[partition
        in: query
        description: 'Partition values as a comma separated list. "none" for alarms of NEs with no partition <p>**Example**: _a08a7792-27a5-42d3-9169-2826d3d32b0c,3541ccf8-03d2-3c0a-a7e5-3b88ca78df35_'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTimeFrom]
        in: query
        description: 'Last raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTimeTo]
        in: query
        description: 'Last raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTimeFrom]
        in: query
        description: 'Last clear time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTimeTo]
        in: query
        description: 'Last clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: 'Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[refinedRaisedTimeFrom]
        in: query
        description: 'Refined raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[refinedRaisedTimeTo]
        in: query
        description: 'Refined raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[refinedClearTimeFrom]
        in: query
        description: 'Refined cleared time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[refinedClearTimeTo]
        in: query
        description: 'Refined clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Offset for the next page of results.<p>**Example**: _50_</p>'
        style: form
        explode: true
        schema:
          type: string
          default: '0'
      - name: pageSize
        in: query
        description: Limit of the number of alarms present in a page.
        style: form
        explode: true
        schema:
          type: string
          default: '500'
      responses:
        '200':
          description: Successfully retrieved filtered list of correlated alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Search on alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/historicalAlarms:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: searchHistoricalAlarmsV2
      description: List of historical cleared Alarms returned in JSON format.
      operationId: searchHistoricalAlarmsV2
      parameters:
      - name: filter[severity]
        in: query
        description: 'Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL,MAJOR,MINOR,WARNING_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[serviceAffecting]
        in: query
        description: 'Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING,NON_SERVICE_AFFECTING_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[deviceType]
        in: query
        description: 'Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500,OPENSTACK,NUAGE_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[deviceId]
        in: query
        description: 'Device id values as a comma separated list.<p>**Example**: _ID1,ID2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[deviceName]
        in: query
        description: 'Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1,NAME2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[ipAddress]
        in: query
        description: 'IP address values as a comma separated list.<p>**Example**: _192.168.42.2,192.168.42.3_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[macAddress]
        in: query
        description: 'Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[additionalText]
        in: query
        description: 'Additional text values as a comma separated list.<p>**Example**: _TEXT1,TEXT2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[nativeConditionType]
        in: query
        description: 'Native condition type values as a comma separated list.<p>**Example**: _TYPE1,TYPE2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[resource]
        in: query
        description: 'Resource values as a comma separated list.<p>**Example**: _RESOURCE1,RESOURCE2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[subnetName]
        in: query
        description: 'Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01,SUBNET02_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[cardType]
        in: query
        description: 'Card type values as a comma separated list.<p>**Example**: _SP-2_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clfi]
        in: query
        description: 'CLFI values as a comma separated list.<p>**Example**: _CLFI01,CLFI02_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[fic]
        in: query
        description: 'FIC values as a comma separated list.<p>**Example**: _FIC01,FIC02_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: sorting
        in: query
        description: 'Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Offset for the next page of results.<p>**Example**: _50_</p>'
        style: form
        explode: true
        schema:
          type: string
          default: '0'
      - name: pageSize
        in: query
        description: Limit of the number of alarms present in a page.
        style: form
        explode: true
        schema:
          type: string
          default: '500'
      responses:
        '200':
          description: Successfully retrieved filtered list of alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Search on alarms failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsa/api/v2_0/alarms/filter/ipAddressesAggregations:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getIpAddresses
      description: Returned in JSON format.
      operationId: getIpAddresses
      parameters:
      - name: filter[ipAddress]
        in: query
        description: 'Partial IP address filter value with a minimum of 3 characters.<p>**Example**: _192.168_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: selected[ipAddress
        in: query
        description: 'IP address values as a comma separated list.<p>**Example**: _192.168.42.2,192.168.42.3_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved IP addresses
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpAddressesAggregation'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: IP addresses retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/macAddressesAggregations:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getMacAddresses
      description: Returned in JSON format.
      operationId: getMacAddresses
      parameters:
      - name: filter[macAddress]
        in: query
        description: 'Partial MAC address filter value with a minimum of 3 characters.<p>**Example**: _00-04-DC_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: selected[macAddress
        in: query
        description: 'Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved MAC addresses
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MacAddressesAggregation'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: MAC addresses retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/nativeConditionTypeAggregations:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getNativeConditionTypes
      description: Returned in JSON format.
      operationId: getNativeConditionTypes
      parameters:
      - name: filter[nativeConditionType]
        in: query
        description: 'Partial native condition type filter value with a minimum of 3 characters.<p>**Example**: _TEX_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: selected[nativeConditionType
        in: query
        description: 'Native condition type values as a comma separated list.<p>**Example**: _TYPE1,TYPE2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved additional texts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NativeConditionTypesAggregation'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Native condition types retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/resourceAggregations:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getResources
      description: Returned in JSON format.
      operationId: getResources
      parameters:
      - name: filter[resource]
        in: query
        description: 'Partial resource filter value with a minimum of 1 character.<p>**Example**: _RES_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: selected[resource
        in: query
        description: 'Resource values as a comma separated list.<p>**Example**: _RESOURCE1,RESOURCE2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved resources
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcesAggregation'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Resources retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/subnetNamesAggregations:
    get:
      tags:
      - Search and filter alarms (version 2)
      summary: getSubnetNames
      description: Returned in JSON format.
      operationId: getSubnetNames
      parameters:
      - name: filter[subnetName]
        in: query
        description: 'Partial case sensitive subnet name filter value with a minimum of 3 characters.<p>**Example**: _NAME1_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: selected[subnetName
        in: query
        description: 'Case sensitive subnet name values as a comma separated list.<p>**Example**: _NAME1,NAME2_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[contextState
        in: query
        description: 'State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE,CLEARED,SUPERSEDED_</p>'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[keytext]
        in: query
        description: "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        style: form
        explode: true
        schema:
          type: string
      - name: filter[lastRaisedTime]
        in: query
        description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      - name: filter[clearTime]
        in: query
        description: 'Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000,2999-12-31T23:59:59.999_</p>'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved subnet names
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubnetNamesAggregation'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Subnet names retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa/api/v2_0/alarms/filter/{channel}:
    delete:
      tags:
      - Search and filter alarms (version 2)
      summary: deleteFilter
      description: Use caution when using this REST API. Active subscribers will no longer receive alarm notifications for their filter and may begin receiving notifications for a new filter.
      operationId: deleteFilter
      parameters:
      - name: channel
        in: path
        description: The channel attribute of the filter to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted alarm filter
          headers: {}
          content: {}
        '404':
          description: Alarm filter not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Alarm filter deletion failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa-correlation/api/v1/correlation/getAffectedInventoryIds:
    get:
      tags:
      - nsa-correlationapiv1correlation
      summary: getAffectedInventoryIds
      description: Get the inventory ids affected by an active alarm
      operationId: getAffectedInventoryIds
      parameters:
      - name: alarmId
        in: query
        description: alarm id
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved affected inventory ids
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: ''
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Get alarm's affected inventories failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa-correlation/api/v1/correlation/getAffectingAlarmIds:
    get:
      tags:
      - nsa-correlationapiv1correlation
      summary: getAffectingAlarmIds
      description: Get the active alarm ids affecting an inventory
      operationId: getAffectingAlarmIds
      parameters:
      - name: inventoryId
        in: query
        description: inventory id
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved affecting alarm ids
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: ''
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Get affecting alarms ids of inventory failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - nsa-correlationapiv1correlation
      summary: PostgetAffectingAlarmIds
      description: Get the active alarm ids affecting a list of inventory
      operationId: PostgetAffectingAlarmIds
      parameters: []
      requestBody:
        description: Affecting alarms parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AffectingAlarmsParams'
              - description: Affecting alarms parameters
        required: false
      responses:
        '200':
          description: Successfully retrieved affecting alarm ids
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: ''
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Get affecting alarms ids of inventory failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa-correlation/api/v1/correlation/getAffectingAlarms:
    get:
      tags:
      - nsa-correlationapiv1correlation
      summary: getAffectingAlarms
      description: Get the active alarms affecting an inventory
      operationId: getAffectingAlarms
      parameters:
      - name: inventoryId
        in: query
        description: inventory id
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved affecting alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Get affecting alarms of inventory failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - nsa-correlationapiv1correlation
      summary: PostgetAffectingAlarms
      description: Get the active alarms affecting a list of inventory
      operationId: PostgetAffectingAlarms
      parameters: []
      requestBody:
        description: Affecting alarms parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AffectingAlarmsParams'
              - description: Affecting alarms parameters
        required: false
      responses:
        '200':
          description: Successfully retrieved affecting alarms
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredAlarms'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Alarm not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Get affecting alarms of inventory failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsa-correlation/api/v1/correlation/ping:
    get:
      tags:
      - nsa-correlationapiv1correlation
      summary: ping
      description: Check if the inventory correlation service is up
      operationId: ping
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/files/{path}:
    get:
      tags:
      - areas
      summary: GetFile
      description: Files are a sub-resource of an area.
      operationId: GetFile
      parameters:
      - name: areaName
        in: path
        description: The name of the area to list the files
        required: true
        style: simple
        schema:
          type: string
      - name: path
        in: path
        description: The OS path to the file asset.  Forward slashes in the path may be directly included or URL encoded. Other URL unfriendly characters need to be URL encoded.
        required: true
        style: simple
        schema:
          type: string
      - name: commitHash
        in: query
        description: By default, get the current version of the file.  Optionally get the file as of a specific commit specified by a Git commit hash
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/RetrievedFile'
                - description: Container for a file retrieved from the Asset Manager
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/RetrievedFile'
                - description: Container for a file retrieved from the Asset Manager
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas:
    get:
      tags:
      - areas
      summary: ListAreas
      description: Areas are identified by unique strings
      operationId: ListAreas
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply1'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/count:
    get:
      tags:
      - areas
      summary: CountAreas
      description: Count the areas in the Asset Manager
      operationId: CountAreas
      parameters:
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/changes:
    get:
      tags:
      - areas
      summary: ListRecentChanges
      description: Areas are identified by unique strings
      operationId: ListRecentChanges
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose recent changes are being requested
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply4'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply4'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}:
    get:
      tags:
      - areas
      summary: GetArea
      description: Areas are identified by unique strings.  If the releaseSignature is different than the versionSignature, an upgrade is available.
      operationId: GetArea
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose information is being requested
        required: true
        style: simple
        schema:
          type: string
      - name: fields
        in: query
        description: Comma separated list of information fields being requested (if empty all fields are returned)
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/field'
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AreaInformationReplyExternal'
                - description: Requested information fields for an Area
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AreaInformationReplyExternal'
                - description: Requested information fields for an Area
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/pullrequests:
    get:
      tags:
      - areas
      summary: ListPullRequests
      description: A pull request is a sub-resource of an area
      operationId: ListPullRequests
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose pull requests are being requested
        required: true
        style: simple
        schema:
          type: string
      - name: pendingOnly
        in: query
        description: If true, returns only active pull requests; if false, returns all pull requests
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply2'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply2'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - areas
      summary: CreatePullRequest
      description: A pull request is a sub-resource of an area
      operationId: CreatePullRequest
      parameters:
      - name: areaName
        in: path
        description: Name of the area to perform the pull request
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Data describing the pull request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreAssetManagerApiV1AreasPullrequestsRequest'
              - description: Data describing the pull request
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PullRequest'
                - description: Identification and information associated with a PullRequest
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PullRequest'
                - description: Identification and information associated with a PullRequest
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/pullrequests/count:
    get:
      tags:
      - areas
      summary: CountPullRequests
      description: A pull request is a sub-resource of an area
      operationId: CountPullRequests
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose pull requests are being requested
        required: true
        style: simple
        schema:
          type: string
      - name: pendingOnly
        in: query
        description: If true, returns only active pull requests; if false, returns all pull requests
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply2'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply2'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/pullrequests/{requestId}:
    get:
      tags:
      - areas
      summary: GetPullRequest
      description: A pull request is a sub-resource of an area
      operationId: GetPullRequest
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose pull request is requested
        required: true
        style: simple
        schema:
          type: string
      - name: requestId
        in: path
        description: The requestId identifier for the pull request
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PullRequest'
                - description: Identification and information associated with a PullRequest
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PullRequest'
                - description: Identification and information associated with a PullRequest
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/raw-files/{path}:
    get:
      tags:
      - areas
      summary: GetFileBytes
      description: Files are a sub-resource of an area.
      operationId: GetFileBytes
      parameters:
      - name: areaName
        in: path
        description: The name of the area to list the files
        required: true
        style: simple
        schema:
          type: string
      - name: path
        in: path
        description: The OS path to the file asset.  Forward slashes in the path may be directly included or URL encoded. Other URL unfriendly characters need to be URL encoded.
        required: true
        style: simple
        schema:
          type: string
      - name: commitHash
        in: query
        description: By default, get the current version of the file.  Optionally get the file as of a specific commit specified by a Git commit hash.  It is strongly suggested to provide this parameter if linking to the image for display, as it makes the response cacheable.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/upgrades:
    get:
      tags:
      - areas
      summary: ListAreaUpgrades
      description: An upgrade is a sub-resource of an area
      operationId: ListAreaUpgrades
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose upgrade history is requested
        required: true
        style: simple
        schema:
          type: string
      - name: pendingOnly
        in: query
        description: If true, returns only active upgrade requests; if false, returns all upgrade requests
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply3'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply3'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - areas
      summary: CreateAreaUpgrade
      description: An upgrade is a sub-resource of an area
      operationId: CreateAreaUpgrade
      parameters:
      - name: areaName
        in: path
        description: Name of the area to upgrade
        required: true
        style: simple
        schema:
          type: string
      - name: sourceDir
        in: query
        description: Source directory path for the upgrade on the server (defaults to standard installation directory)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AreaUpgrade'
                - description: An asset area's upgrade request or event
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AreaUpgrade'
                - description: An asset area's upgrade request or event
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/upgrades/count:
    get:
      tags:
      - areas
      summary: CountAreaUpgrades
      description: Count the upgrade history events for an area
      operationId: CountAreaUpgrades
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose pull requests are being requested
        required: true
        style: simple
        schema:
          type: string
      - name: pendingOnly
        in: query
        description: If true, returns only active pull requests; if false, returns all pull requests
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply2'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply2'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/upgrades/{requestId}:
    get:
      tags:
      - areas
      summary: GetAreaUpgrade
      description: An upgrade is a sub-resource of an area
      operationId: GetAreaUpgrade
      parameters:
      - name: areaName
        in: path
        description: Name of the area whose upgrade is requested
        required: true
        style: simple
        schema:
          type: string
      - name: requestId
        in: path
        description: The requestId identifier for the area upgrade
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AreaUpgrade'
                - description: An asset area's upgrade request or event
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AreaUpgrade'
                - description: An asset area's upgrade request or event
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/areas/{areaName}/files:
    get:
      tags:
      - areas
      summary: ListFiles
      description: Files are a sub-resource of an area
      operationId: ListFiles
      parameters:
      - name: areaName
        in: path
        description: The name of the area to list the files
        required: true
        style: simple
        schema:
          type: string
      - name: commitHash
        in: query
        description: By default, list the current set of files.  Optionally list only the files as of a specific commit specified by a Git commit hash
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply5'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply5'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/keys:
    get:
      tags:
      - keys
      summary: ListKeys
      description: Keys are identified by their fingerprint (16 byte MD5 hash in hexadecimal format without byte separators)
      operationId: ListKeys
      parameters:
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - keys
      summary: CreateKey
      description: Keys are identified by their fingerprint (16 byte MD5 hash in hexadecimal format without byte separators). Adding a key which is already present results in 409 Conflict.
      operationId: CreateKey
      parameters: []
      requestBody:
        description: An RSA public key
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreAssetManagerApiV1KeysRequest'
              - description: An RSA public key
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuthorizedKey'
                - description: Ssh public keys authorized for git access
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuthorizedKey'
                - description: Ssh public keys authorized for git access
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/keys/count:
    get:
      tags:
      - keys
      summary: CountKeys
      description: List the SSH public keys authorized for git access in the Asset Manager
      operationId: CountKeys
      parameters:
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/keys/{keyId}:
    delete:
      tags:
      - keys
      summary: DeleteKey
      description: Remove an SSH public key from the list of the SSH public keys authorized for git access in the Asset Manager
      operationId: DeleteKey
      parameters:
      - name: keyId
        in: path
        description: The fingerprint of the key to remove (16 byte MD5 hash in hexadecimal format without byte separators)
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/asset-manager/api/v1/ping:
    get:
      tags:
      - ping
      summary: GetPing1
      description: Ping the system to see whether the component is ready to handle requests or not
      operationId: GetPing1
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/ping:
    get:
      tags:
      - ping
      summary: GetPing11
      description: Ping the system to see whether the component is ready to handle requests or not
      operationId: GetPing11
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /lekha/api/v1/:
    get:
      tags:
      - audit logs
      summary: Exportsauditlogsbasedonqueryparams.
      description: >-
        1. Exports audit logs based on query params.

        2. Exports all available audit logs if no query params are provided.


        Note: Present-day audit logs are downloaded from elastic search and not stored on disk.
      operationId: Exportsauditlogsbasedonqueryparams.
      parameters:
      - name: from
        in: query
        description: Start date in format yyyy-mm-dd.
        style: form
        explode: true
        schema:
          type: string
      - name: to
        in: query
        description: End date in format yyyy-mm-dd.
        style: form
        explode: true
        schema:
          type: string
      - name: last_days
        in: query
        description: Specify number of days for which audit logs to be exported. When this parameter is provided 'from' and 'to' params are not required.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Tar archive of audit logs
          headers: {}
          content:
            application/x-tar:
              schema: {}
        '400':
          description: Bad request.
          headers: {}
          content:
            application/x-tar:
              schema: {}
        '500':
          description: Some error occurred on server.
          headers: {}
          content:
            application/x-tar:
              schema: {}
      deprecated: false
    delete:
      tags:
      - audit logs
      summary: Deletelocallystoredauditlogsbasedonqueryparams.
      description: "1. Delete locally stored audit logs based on query params.\n2. Delete all locally stored audit logs if no query params are provided.\n \nNote: Audit logs will be deleted from disk but not from elastic search."
      operationId: Deletelocallystoredauditlogsbasedonqueryparams.
      parameters:
      - name: from
        in: query
        description: Start date in format yyyy-mm-dd.
        style: form
        explode: true
        schema:
          type: string
      - name: to
        in: query
        description: End date in format yyyy-mm-dd.
        style: form
        explode: true
        schema:
          type: string
      - name: last_days
        in: query
        description: Specify number of days for which audit logs to be deleted. When this parameter is provided 'from' and 'to' params are not required.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Audit logs deleted successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Some error occurred on server.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
  /audit/api/v1/testTypes:
    get:
      tags:
      - Retrieves a specific testType
      summary: getTestTypes
      description: '<p>LATEST VERSION: V1'
      operationId: getTestTypes
      parameters:
      - name: auditType
        in: query
        description: Optional, AuditType
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieve list of testTypes
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestTypeRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve list of testTypes
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/testTypes/{testTypeId}:
    get:
      tags:
      - Retrieves a specific testType
      summary: getTestTypeById
      description: '<p>LATEST VERSION: V1'
      operationId: getTestTypeById
      parameters:
      - name: testTypeId
        in: path
        description: Identifier for the testType to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved a testType
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestTypeRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: TestType specified does not exist
          headers: {}
          content: {}
        '500':
          description: Failed to retrieve the testType with a given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: AuditApp service unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/auditTargets:
    post:
      tags:
      - Retrieves and creates auditTargets
      summary: postAuditTarget
      description: "<p>LATEST VERSION: V1 <p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"data\" :\n   {\n      \"type\" : \"auditTargets\",\n      \"attributes\" : {\n          \"source\" : \"\",\n          \"queryParams\" : { \n             \"name\" : \"65_0068\"\n           }\n      },\n      \"relationships\" : {\n        \"resources\": {\n          \"data\": [\n           {\n            \"type\": \"Network element maintenance details\",\n            \"id\": \"29b17115-2c3f-35d8-b970-23075ed0e35a\"\n           },\n           {\n            \"type\": \"Network element maintenance details\",\n            \"id\": \"1392e643-ed1e-3182-9b40-dc750790286e\"\n           }\n          ]\n        }\n      }     \n    }\n}"
      operationId: postAuditTarget
      parameters: []
      requestBody:
        description: AuditTarget payload
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuditTargetRO'
              - description: AuditTarget payload
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditTargetRO'
        '201':
          description: Successfully created an auditTarget
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditTargetRO'
        '400':
          description: 'Bad request. Ex: Payload is not valid'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Can not create an auditTarget on StandBy
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create an auditTarget
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/auditTargets/{auditTargetId}:
    get:
      tags:
      - Retrieves and creates auditTargets
      summary: getAuditTargetById
      description: '<p>LATEST VERSION: V1'
      operationId: getAuditTargetById
      parameters:
      - name: auditTargetId
        in: path
        description: Identifier of the auditTarget to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieve auditTarget by a given id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditTargetRO'
        '404':
          description: Cannot find the auditTarget with a given id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve auditTarget with a given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/auditProfiles:
    get:
      tags:
      - Retrieves auditProfiles
      summary: getAuditProfiles
      description: '<p>LATEST VERSION: V1'
      operationId: getAuditProfiles
      parameters:
      - name: name
        in: query
        description: (Optional) A name of the  profile
        style: form
        explode: true
        schema:
          type: string
      - name: testType
        in: query
        description: (Optional) List of comma separated test type that the profiles support
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroups
        in: query
        description: (Optional) List of comma separated type groups that the profiles support
        style: form
        explode: true
        schema:
          type: string
      - name: auditType
        in: query
        description: (Optional) List of comma separated audit types that the profiles belong to
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: testType'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieve a list of auditProfiles
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditProfileRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve auditProfiles
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/auditProfiles/{auditProfileId}:
    get:
      tags:
      - Retrieves auditProfiles
      summary: getAuditProfileById
      description: '<p>LATEST VERSION: V1'
      operationId: getAuditProfileById
      parameters:
      - name: auditProfileId
        in: path
        description: Identifier for the auditProfile to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: testType'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved auditProfile
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditProfileRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: AuditProfile specified does not exist
          headers: {}
          content: {}
        '500':
          description: Failed to retrieve the auditProfile with a given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/audits:
    get:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: getAudits
      description: '<p>LATEST VERSION: V1'
      operationId: getAudits
      parameters:
      - name: auditType
        in: query
        description: (Optional) List of comma separated audit types that the audits belong to
        style: form
        explode: true
        schema:
          type: string
      - name: testType
        in: query
        description: (Optional) List of comma separated test types of the audits to be retrieved
        style: form
        explode: true
        schema:
          type: string
      - name: auditName
        in: query
        description: (Optional) List of comma separated names of the audits to be retrieved
        style: form
        explode: true
        schema:
          type: string
      - name: auditProfile.names
        in: query
        description: (Optional) List of comma separated name of the audit profiles that the audits have
        style: form
        explode: true
        schema:
          type: string
      - name: auditRun.auditState.state
        in: query
        description: (Optional) List of comma separated audit state that the audit runs belong to
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: auditProfile, auditRun, auditTarget'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieve audits
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve audits
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: postAudit
      description: >+
        <p>LATEST VERSION: V1 <p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
         "data" :
         {
           "type": "audits",
           "attributes": {
             "name": "NDP_Audit",
             "auditType" : "NeConfiguration",
             "description" : "Audit for NDP settings"
           },
           "relationships": {
            "auditProfiles": {
              "data": [
                   {
                   "type": "auditProfiles",
                   "id": "4522e2eb-5367-3763-8135-c157f8f11b6f"}
               ]
             },
             "auditTarget" : {
              "data": {
               "type": "auditTargets",
               "id": "527332b9-050b-47f5-b71f-1cbbb1c93670"
              }
             }
           }
         }
         }

      operationId: postAudit
      parameters: []
      requestBody:
        description: Audit payload
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuditRO'
              - description: Audit payload
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRO'
        '201':
          description: Successfully created an audit
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRO'
        '400':
          description: 'Bad request. Ex: Payload is not valid, auditProfile does not belong to this auditType,auditProfile does not support multiple audits,auditTarget does not exist.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: User can not post an audit on Standby.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create an audit
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/audits/{auditId}:
    get:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: getAuditById
      description: '<p>LATEST VERSION: V1'
      operationId: getAuditById
      parameters:
      - name: auditId
        in: path
        description: Identifier of the audit to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: auditProfile, auditRun, auditTarget'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieve audit by id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: User does not partition access to the audit
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the audit with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the audit with a given id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: deleteAudit
      description: '<p>LATEST VERSION: V1'
      operationId: deleteAudit
      parameters:
      - name: auditId
        in: path
        description: Identifier of the audit to be deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRO'
        '202':
          description: Delete has started
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRO'
        '204':
          description: Specified Audit does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: User can not delete and audit on StandBy
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Audit App service unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/audits/{auditId}/auditRuns:
    post:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: postAuditRun
      description: Creates an audit Run
      operationId: postAuditRun
      parameters:
      - name: auditId
        in: path
        description: Identifier for the auditId to be run
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRunRO'
        '201':
          description: Successfully run an Audit
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRunRO'
        '403':
          description: User can not run an audit on Standby.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Audit is already running.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '424':
          description: Failed to run because of MCP App failure.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to run
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/audits/{auditId}/auditRuns/{auditRunId}:
    delete:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: deleteAuditRun
      description: '<p>LATEST VERSION: V1'
      operationId: deleteAuditRun
      parameters:
      - name: auditId
        in: path
        description: Identifier of the audit to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: auditRunId
        in: path
        description: Identifier of the auditRun to be deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRO'
        '202':
          description: Delete has started
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRO'
        '204':
          description: Specified audit run does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Audit App service unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: patchAuditRun
      description: >-
        <p>LATEST VERSION: V1notes = <p>LATEST VERSION: V1<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>for all findings

        {
          "operations" : [
                {
                    "path" : "/data/attributes/auditState",
                     "op" : "replace",
                     "value" : {
                        "state" : "CancelRequested"
                     }
                }
           ]
        }
      operationId: patchAuditRun
      parameters:
      - name: auditId
        in: path
        description: Identifier for the auditId to be patched
        required: true
        style: simple
        schema:
          type: string
      - name: auditRunId
        in: path
        description: Identifier for the auditRuns to be patched
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given auditRun.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuditPatchRO'
              - description: A patch request to the given auditRun.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRunRO'
        '202':
          description: Successfully patch the given audit run
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRunRO'
        '400':
          description: Invalid patch attributes or values are given
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: User can not patch the given auditRun on Standby.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Audit or audit Run does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to patch
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/audits/{auditId}/auditRuns/{auditRunId}/auditFindings:
    get:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: getAuditFindings
      description: '<p>LATEST VERSION: V1'
      operationId: getAuditFindings
      parameters:
      - name: auditId
        in: path
        description: Identifier for the auditId to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: auditRunId
        in: path
        description: Identifier for the auditRuns to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: profileName
        in: query
        description: (Optional) List of comma separated profile names that the finding belongs to
        style: form
        explode: true
        schema:
          type: string
      - name: testType
        in: query
        description: (Optional) List of comma separated testType that the finding belongs to
        style: form
        explode: true
        schema:
          type: string
      - name: fixState.state
        in: query
        description: (Optional) List of comma separated fix states for the Findings
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be included. The allowed values are: audit, auditRun'
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: '(Optional) Maximum number of findings to return, default: 10000'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved list of auditFindings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditFindingListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve auditFindings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: fixAuditFindings
      description: >-
        <p>LATEST VERSION: V1notes = <p>LATEST VERSION: V1<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>request a fix for all findings

        {
          "operations" : [
                {
                    "path" : "/data/attributes/fixState",
                     "op" : "replace",
                     "value" : {
                        "state" : "FixRequested"
                     }
                }
           ]
        }

        for set of findings

        {
          "operations" : [
                {
                    "path" : "/data/attributes/fixState",
                     "op" : "replace",
                     "value" : {
                        "state" : "FixRequested"
                     },
                     "ids" : ["2034023754902357252905", "130-21482358043-5834588", "5409687504970978404590"]
                }
           ]
        }

        request a fix cancel for all findings

        {
          "operations" : [
                {
                    "path" : "/data/attributes/fixState",
                     "op" : "replace",
                     "value" : {
                        "state" : "FixCancelRequested"
                     }
                }
           ]
        }

        for set of findings

        {
          "operations" : [
                {
                    "path" : "/data/attributes/fixState",
                     "op" : "replace",
                     "value" : {
                        "state" : "FixCancelRequested"
                     },
                     "ids" : ["2034023754902357252905", "130-21482358043-5834588", "5409687504970978404590"]
                }
           ]
        }
      operationId: fixAuditFindings
      parameters:
      - name: auditId
        in: path
        description: Identifier for the auditId to be patched
        required: true
        style: simple
        schema:
          type: string
      - name: auditRunId
        in: path
        description: Identifier for the auditRuns to be patched
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given auditRun.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuditPatchRO'
              - description: A patch request to the given auditRun.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRunRO'
        '202':
          description: Successfully started fix
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditRunRO'
        '400':
          description: None of the findings are fixable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: "Patch is forbidden : None of the findings belong to the user's partitionsCan not patch the findings on StandBy"
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '424':
          description: Failed to patch the findings because of MCP App failure.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to patch
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /audit/api/v1/audits/{auditId}/auditRuns/{auditRunId}/auditFindings/{auditFindingId}:
    get:
      tags:
      - Retrieves, creates, updates and deletes audits
      summary: getAuditFindingById
      description: '<p>LATEST VERSION: V1'
      operationId: getAuditFindingById
      parameters:
      - name: auditId
        in: path
        description: Identifier for the auditId to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: auditRunId
        in: path
        description: Identifier for the auditRuns to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: auditFindingId
        in: path
        description: Identifier for the auditFindings to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be included. The allowed values are: audit, auditRun'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved auditFinding
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditFindingRO'
        '403':
          description: Does not belong to user's partition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Invalid character in auditFinding Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve auditFindings with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v2/schedules:
    get:
      tags:
      - Backup Schedule Rest Service V2
      summary: listBackupSchedules
      description: List all backup schedules
      operationId: listBackupSchedules
      parameters:
      - name: name
        in: query
        description: Backup schedule name
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: Backup schedule state
        style: form
        explode: true
        schema:
          type: string
      - name: name_contains
        in: query
        description: Backup schedule name contains
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: >-
          Backup schedule sorting, sorting on 'name' and 'state' are supported. By default sorted in ascending order on 'name'.

          Use a dash in front of the attribute name (e.g. ordering=-name) for sorting in descending order.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Details were found successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupScheduleListRO'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Backup Schedule Rest Service V2
      summary: backupSolution
      description: >-
        Create a backup schedule.<p>A backup request will be executed immediately if no schedule is provided in the request body.<p>A backup request can be scheduled for SITE or SOLUTION. When backup is scheduled for SITE, solutionName turns out to be optiotnal. <p>For Solution Backup, entityType turns out to be optional. Supported entityType values are SITE and SOLUTION<p>A backup request can be scheduled to the future, executed once or in a recurring manner. <p>Setting the force flag will force a backup to run even when some apps are stopped. The supported backup frequencies are ONCE, DAILY, WEEKLY and MONTHLY.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "schedules",
                "attributes": {
                    "entityType\": \"{{ENTITY_TYPE}}",
                    "solutionName": "{{TEST_SOLUTION}}",
                    "name": "daily",
                    "label": "daily",
                    "schedule": {
                        "frequency": "DAILY",
                        "utcTime": "01:00"
                    },
                    "force": false
                }
            }
        }

        </code></pre>
      operationId: backupSolution
      parameters: []
      requestBody:
        description: Backup schedule
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BackupScheduleRO'
              - description: Backup schedule
        required: true
      responses:
        '202':
          description: Backup request is accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupScheduleRO'
        '400':
          description: The backup request input is invalid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while backup
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v2/schedules/{id}:
    get:
      tags:
      - Backup Schedule Rest Service V2
      summary: getBackupSchedule
      description: List a particular backup schedule
      operationId: getBackupSchedule
      parameters:
      - name: id
        in: path
        description: Backup schedule Id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Backup schedule was found successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupScheduleRO'
        '404':
          description: The backup schedule doesn't exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Backup Schedule Rest Service V2
      summary: deleteBackupSchedule
      description: Delete a particular backup schedule
      operationId: deleteBackupSchedule
      parameters:
      - name: id
        in: path
        description: Backup schedule Id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: The backup schedule was successfully deleted
          headers: {}
          content: {}
        '400':
          description: Backup is in progress
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The backup schedule doesn't exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Backup Schedule Rest Service V2
      summary: updateBackupSchedule
      description: >-
        Update a particular active backup schedule. Full data should be provided in the request body for the update.<p>A backup request will be executed immediately if no schedule is provided in the request body.<p>A backup request can be scheduled to the future, executed once or in a recurring manner. <p>Setting the force flag will force a backup to run even when some apps are stopped. The supported backup frequencies are ONCE, DAILY, WEEKLY and MONTHLY.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "schedules",
                "attributes": {
                    "solutionName": "{{TEST_SOLUTION}}",
                    "name": "daily",
                    "label": "daily",
                    "schedule": {
                        "frequency": "DAILY",
                        "utcTime": "01:00"
                    },
                    "force": false
                }
            }
        }

        </code></pre>
      operationId: updateBackupSchedule
      parameters:
      - name: id
        in: path
        description: Backup schedule Id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Backup request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BackupScheduleRO'
              - description: Backup request
        required: true
      responses:
        '202':
          description: Backup schedule update request is accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupScheduleRO'
        '400':
          description: The backup schedule update request input is invalid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v2/schedules/{id}/backups:
    get:
      tags:
      - Backup Schedule Rest Service V2
      summary: getBackupDetails
      description: List details of a particular backup schedule
      operationId: getBackupDetails
      parameters:
      - name: id
        in: path
        description: Backup schedule Id
        required: true
        style: simple
        schema:
          type: string
      - name: status
        in: query
        description: Backup status
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: >-
          Backup sorting, sorting on 'executionTime', 'scheduleName' and 'status' are supported. By default sorted in descending order on 'executionTime'.

          Use a dash in front of the attribute name (e.g. ordering=-executionTime) for sorting in descending order.
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the next page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Backup details were found successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSnapshotListRO'
        '404':
          description: The backup schedule doesn't exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v1/backup:
    get:
      tags:
      - Backup Service API V1
      summary: listBackupJobs
      description: List all backup processes
      operationId: listBackupJobs
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Details were found successfully
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackupJobRO'
                description: ''
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackupJobRO'
                description: ''
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Backup Service API V1
      summary: PostbackupSolution
      description: Trigger Backup Process
      operationId: PostbackupSolution
      parameters: []
      requestBody:
        description: Backup request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BackupRequestRO'
              - description: Backup request
        required: true
      responses:
        '202':
          description: Backup request is accepted
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/BackupJob'
            application/json:
              schema:
                $ref: '#/components/schemas/BackupJob'
        '400':
          description: The backup request input is invalid
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while backup
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v1/backup/{jobId}:
    get:
      tags:
      - Backup Service API V1
      summary: getBackupJob
      description: List details of a particular backup process
      operationId: getBackupJob
      parameters:
      - name: jobId
        in: path
        description: Backup job Id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Backup job was found successfully
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BackupJobRO'
                - description: The information about a backup job
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BackupJobRO'
                - description: The information about a backup job
        '404':
          description: The job doesn't exist
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v1/restore:
    get:
      tags:
      - Backup Service API V1
      summary: listRestoreJobs
      description: List all restore processes
      operationId: listRestoreJobs
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Details were found successfully
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestoreJobRO'
                description: ''
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestoreJobRO'
                description: ''
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Backup Service API V1
      summary: restoreSolution
      description: Trigger Restore Process
      operationId: restoreSolution
      parameters: []
      requestBody:
        description: Restore request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RestoreRequestRO'
              - description: Restore request
        required: true
      responses:
        '202':
          description: Restore request is accepted
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/RestoreJobRO'
                - description: The information about a restore job
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/RestoreJobRO'
                - description: The information about a restore job
        '400':
          description: The restore request input is invalid
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while restoring
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v1/restore/{jobId}:
    get:
      tags:
      - Backup Service API V1
      summary: getRestoreJob
      description: List details of a particular restore process
      operationId: getRestoreJob
      parameters:
      - name: jobId
        in: path
        description: Job Id of restore job
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Restore job was found successfully
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/RestoreJobRO'
                - description: The information about a restore job
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/RestoreJobRO'
                - description: The information about a restore job
        '404':
          description: The job doesn't exist
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Backup Service API V1
      summary: deleteRestoreJob
      description: Delete a completed restore job
      operationId: deleteRestoreJob
      parameters:
      - name: jobId
        in: path
        description: Job Id of restore job
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Restore job was deleted successfully
          headers: {}
          content: {}
        '404':
          description: The restore job doesn't exist
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v1/snapshots:
    get:
      tags:
      - Backup Service API V1
      summary: listSnapshots
      description: List all existing snapshots
      operationId: listSnapshots
      parameters:
      - name: solutionName
        in: query
        description: Solution Name
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Snapshots were found successfully
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                type: array
                items:
                  type: string
                description: ''
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: ''
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v2/backupSettings:
    get:
      tags:
      - Backup Settings Rest Service V2
      summary: listBackupSettings
      description: List backup settings
      operationId: listBackupSettings
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Backup settings are retrieved successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSettingsRO'
        '500':
          description: The server encountered an error while retrieving backup settings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v2/backupSettings/{id}:
    patch:
      tags:
      - Backup Settings Rest Service V2
      summary: updateBackupSettings
      description: Update backup settings
      operationId: updateBackupSettings
      parameters:
      - name: id
        in: path
        description: Backup settings Id, valid value is '1'
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Backup settings
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BackupSettingsRO'
              - description: Backup settings
        required: true
      responses:
        '200':
          description: Backup settings are updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSettingsRO'
        '400':
          description: The backup settings update request input is invalid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while updating backup settings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /backupservice/api/v2/backups:
    get:
      tags:
      - Backup Snapshot Rest Service V2
      summary: listBackupDetails
      description: List details of all backup schedules
      operationId: listBackupDetails
      parameters:
      - name: scheduleName
        in: query
        description: Backup schedule name
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: Backup status
        style: form
        explode: true
        schema:
          type: string
      - name: scheduleName_contains
        in: query
        description: Backup schedule name contains
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: >-
          Backup sorting, sorting on 'executionTime', 'scheduleName' and 'status' are supported. By default sorted in descending order on 'executionTime'.

          Use a dash in front of the attribute name (e.g. ordering=-executionTime) for sorting in descending order.
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the next page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Details were found successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSnapshotListRO'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /commissioning/api/v1/scripts/:
    get:
      tags:
      - Scripts Management
      summary: Getcommissioningscripts
      description: >
        Use this API to fetch the commissioning scripts for a planned project.


        Prerequisite: Commissioning scripts must exist for specified project.
      operationId: Getcommissioningscripts
      parameters:
      - name: projectname
        in: query
        description: Project Name of planned network
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: devicetype
        in: query
        description: Device type planned network i.e., 6500, Waveserver
        style: form
        explode: true
        schema:
          type: string
      - name: nodename
        in: query
        description: Node name in a planned network
        style: form
        explode: true
        schema:
          type: string
      - name: shelfId
        in: query
        description: Shelf Id of the generated script e.g. Shelf number 0,1,2,11,21 etc or ALL
        style: form
        explode: true
        schema:
          type: string
      - name: format
        in: query
        description: Script format to be returned i.e., ztpScript, json, cli
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved commissioning scripts.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissioningScriptsData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/CommissioningScriptsData'
        '400':
          description: Bad request. Invalid parameters, could not find projectname parameter.
          headers: {}
          content: {}
        '500':
          description: Retrieval of commissioning scripts failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Scripts Management
      summary: Deletecommissioningscripts
      description: >
        Use this API to delete the commissioning scripts for a project name.


        Prerequisite: Commissioning scripts must exist for specified project.
      operationId: Deletecommissioningscripts
      parameters:
      - name: projectname
        in: query
        description: Project Name of planned network
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted commissioning scripts.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters, could not find projectname parameter.
          headers: {}
          content: {}
        '500':
          description: Deletion of commissioning scripts failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Scripts Management
      summary: Generateandreturncommissioningscripts
      description: >
        Use this API to generate the commissioning scripts for a planned project.


        Prerequisite: Project must have been planned, committed and deployment planning data(example: TID, IP and FIC) must have been provided.
      operationId: Generateandreturncommissioningscripts
      parameters:
      - name: projectname
        in: query
        description: Project Name of planned network
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: policyid
        in: query
        description: Policy id of commissioning policy to be used
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully generated commissioning scripts.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scriptsSummaryData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/scriptsSummaryData'
        '400':
          description: Bad request. Invalid parameters, could not find projectname parameter.
          headers: {}
          content: {}
        '500':
          description: Generation of commissioning scripts failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/scriptsSummary/:
    get:
      tags:
      - Scripts Management
      summary: Getcommissioningscriptssummary
      description: Use this API to retrieve summary of commissioning scripts.
      operationId: Getcommissioningscriptssummary
      parameters:
      - name: projectname
        in: query
        description: Project Name of planned network
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved commissioning scripts summary.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scriptssummarydata1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Scriptssummarydata1'
        '500':
          description: Retrieval of scripts summary failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/equipment/:
    post:
      tags:
      - Equipment Commissioning
      summary: Commissiontopologiesofanequipment
      description: "Use this API to commission the topologies of a provisioned equipment.\n\nPrerequiste: Equipment project must have been planned, committed and equipment must be provisioned. \n"
      operationId: Commissiontopologiesofanequipment
      parameters: []
      requestBody:
        description: New equipment to be commissioned.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/newEquipment'
              - description: New equipment to be commissioned.
        required: true
      responses:
        '201':
          description: Successfully submitted request to commission topologies of an equipment.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Failed to commission equipment topologies, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/policy/:
    get:
      tags:
      - Policy Management
      summary: Getpolicydetails
      description: >
        Use this API to retrieve a policy by id or to retrieve all policies.


        Prerequisite: Policy must exist for specified policy id.
      operationId: Getpolicydetails
      parameters:
      - name: id
        in: query
        description: Id of the policy
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved policy details.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policiesdata'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Policiesdata'
        '400':
          description: Bad request. Invalid parameters, could not find policy id parameter.
          headers: {}
          content: {}
        '500':
          description: Retrieval of policy failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Policy Management
      summary: Deletepolicydetails
      description: >
        Use this API to delete a policy.


        Prerequisite: Policy must exist for specified policy id.
      operationId: Deletepolicydetails
      parameters:
      - name: id
        in: query
        description: Id of the policy
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted policy.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters, could not find policy id parameter.
          headers: {}
          content: {}
        '500':
          description: Deletion of policy failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Policy Management
      summary: Createapolicy
      description: >
        Use this API to create a policy.


        Prerequisite: Policy type for this policy must exist in commissioning.
      operationId: Createapolicy
      parameters: []
      requestBody:
        description: Policy object.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/policy'
              - description: Policy object.
        required: true
      responses:
        '200':
          description: Successfully created policy.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PolicyData'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Policy creation failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Policy Management
      summary: Updateapolicy
      description: >
        Use this API to update a policy state.


        Prerequisite: Policy must exist in commissioning.
      operationId: Updateapolicy
      parameters:
      - name: id
        in: query
        description: Id of policy.
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Policy object.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/policy'
              - description: Policy object.
        required: true
      responses:
        '200':
          description: Successfully updated policy.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Policy update failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/policyTypes/:
    get:
      tags:
      - Policy Management
      summary: Getallpolicytypes
      description: Use this API to retrieve all policy types supported in commissioning.
      operationId: Getallpolicytypes
      parameters: []
      responses:
        '200':
          description: Successfully retrieved policy types.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyTypesData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PolicyTypesData'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Retrieval of policy types failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/policyDefaults/:
    get:
      tags:
      - Policy Defaults Management
      summary: Getdefaultsofapolicy
      description: >
        Use this API to retrieve defaults for a policy or to retrieve defaults for all policies of a specific policy type or to retrieve defaults for all policies.


        Prerequisite: Policy must exist for specified policy id.
      operationId: Getdefaultsofapolicy
      parameters:
      - name: id
        in: query
        description: Id of the policy
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: Type of the policy
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved defaults for specified policy id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultsData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DefaultsData'
        '400':
          description: Bad request. Invalid parameters, could not find policyId parameter.
          headers: {}
          content: {}
        '500':
          description: Retrieval of defaults failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Policy Defaults Management
      summary: Resetdefaultsofapolicy
      description: >
        Use this API to reset defaults for a policy.


        Prerequisite: Policy must exist for specified policy id.
      operationId: Resetdefaultsofapolicy
      parameters:
      - name: id
        in: query
        description: Id of the policy
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully reset defaults of a policy.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters, could not find policyId parameter.
          headers: {}
          content: {}
        '500':
          description: Reset of defaults failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Policy Defaults Management
      summary: Setcustomdefaultsforapolicy
      description: >
        Use this API to set the custom defaults for a policy.


        Prerequisite: Policy type for this policy must exist in commissioning.
      operationId: Setcustomdefaultsforapolicy
      parameters:
      - name: id
        in: query
        description: Id of policy.
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Value of defaults
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/defaults'
              - description: Value of defaults
        required: true
      responses:
        '201':
          description: Successfully updated defaults for a policy.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Defaults update failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Policy Defaults Management
      summary: Setcustomdefaultsforapolicy1
      description: >
        Use this API to set the custom defaults for a policy.


        Prerequisite: Policy must exist in commissioning.
      operationId: Setcustomdefaultsforapolicy1
      parameters:
      - name: id
        in: query
        description: Id of policy.
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Value of defaults.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/defaults'
              - description: Value of defaults.
        required: true
      responses:
        '201':
          description: Successfully updated defaults of a policy.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Defaults update failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v2/ipsubnet/:
    get:
      tags:
      - IP Subnet Management
      summary: GetIPSubnetdetails
      description: Use this API to retrieve allocated IP Subnet.
      operationId: GetIPSubnetdetails
      parameters: []
      responses:
        '200':
          description: Successfully retrieved allocated IPAddress Subnets.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSubnet1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/IPSubnet1'
        '500':
          description: Retrieval of IPSubnet failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - IP Subnet Management
      summary: DeleteIPSubnetOspfAreaAddress
      description: Use this API to delete allocated IPSubnet for given OspfArea.
      operationId: DeleteIPSubnetOspfAreaAddress
      parameters: []
      responses:
        '200':
          description: Successfully deleted IPSubnet.
          headers: {}
          content: {}
        '400':
          description: Bad Request OspfArea or subnetId is not valid or does not exist.
          headers: {}
          content: {}
        '500':
          description: Internal Error in deletion of OspfArea, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - IP Subnet Management
      summary: AllocateIPSubnetandospfAreaAddresses
      description: "Use this API to Allocate new IP Subnet and OspfArea for the Shelf,\n\n Provide IP address with Subnet and CIDR for Shelf "
      operationId: AllocateIPSubnetandospfAreaAddresses
      parameters: []
      requestBody:
        description: ipsubnet object.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/IPAddressSubnet'
              - description: ipsubnet object.
        required: false
      responses:
        '201':
          description: Successfully allocated IP Subnet and OspfArea.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters OspfArea or IPsubnet Parameter is wrong.
          headers: {}
          content: {}
        '500':
          description: Failed to Allocate IPSubnet, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/ipsubnet/:
    get:
      tags:
      - IPv4 Subnet Management
      summary: GetIPv4Subnetdetails
      description: Use this API to retrieve allocated IPv4 Subnet.
      operationId: GetIPv4Subnetdetails
      parameters: []
      responses:
        '200':
          description: Successfully retrieved allocated IPAddress Subnets.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSubnet2'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/IPSubnet2'
        '500':
          description: Retrieval of IPv4 Address allocation failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: true
    delete:
      tags:
      - IPv4 Subnet Management
      summary: DeleteIPv4OspfAreaAddress
      description: Use this API to delete allocated IPv4 OspfArea Address.
      operationId: DeleteIPv4OspfAreaAddress
      parameters: []
      responses:
        '200':
          description: Successfully deleted ospfArea.
          headers: {}
          content: {}
        '400':
          description: Bad Request OspfArea or subnetId is not valid or does not exist.
          headers: {}
          content: {}
        '500':
          description: Internal Error in deletion of OspfArea, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: true
    post:
      tags:
      - IPv4 Subnet Management
      summary: AllocateIPv4shelfsubnetandospfAreaAddresses
      description: "Use this API to Allocate new IPv4 Subnet and OspfArea for the Shelf,\n\n Provide IPv4 address with Subnet and CIDR for Shelf "
      operationId: AllocateIPv4shelfsubnetandospfAreaAddresses
      parameters: []
      requestBody:
        description: ipsubnet object.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ipsubnet'
              - description: ipsubnet object.
        required: true
      responses:
        '201':
          description: Successfully allocated IPv4 Address and OspfArea.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters OspfArea or ShelfIP Parameter is wrong.
          headers: {}
          content: {}
        '500':
          description: Failed to Allocate IPAddress, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: true
  /commissioning/api/v2/reservedIP/:
    get:
      tags:
      - Reserved IPAddress Management
      summary: GetReservedIPAddressdataofInterface(shelves,crafts)
      description: "Use this API to retrieve reserved network data for shelves, crafts. \n\nPrerequisite: IPAddress network data must be uploaded for deployed shelf or craft."
      operationId: GetReservedIPAddressdataofInterface(shelves,crafts)
      parameters:
      - name: tid
        in: query
        description: Target Identifier for shelves with reserved IPAddress
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved reserved shelves, crafts IPAddress data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservedIPAddressofShelvesorcrafts'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ReservedIPAddressofShelvesorcrafts'
        '500':
          description: Failed to retrieve  reserved shelves or craft IPAddress data, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Reserved IPAddress Management
      summary: ReservedIPAddressManagement
      description: Use this API to delete reserved shelf IPAddress data.
      operationId: ReservedIPAddressManagement
      parameters: []
      responses:
        '200':
          description: Successfully deleted reserved IPAddress data.
          headers: {}
          content: {}
        '400':
          description: Bad Request, ShelfNumber or Tid is not valid or does not exist.
          headers: {}
          content: {}
        '500':
          description: Internal Error in deletion of Shelf, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Reserved IPAddress Management
      summary: ReservedIPAddressoftheInterface(shelforcraft)data
      description: >-
        Use this API to load reserved shelf or craft IPAddress data into commissioning.


        Prerequisite: Shelves are already deployed in the network and are not commissioned using scripts generated by commissioning
      operationId: ReservedIPAddressoftheInterface(shelforcraft)data
      parameters: []
      requestBody:
        description: Reserved IPAddress of the Interface.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/reservedIP'
              description: Reserved IPAddress of the Interface.
        required: true
      responses:
        '201':
          description: Successfully loaded IPAddress data.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Failed to load IPAddress data, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/deployedIPv4Data/:
    get:
      tags:
      - Deployed Network IPv4 Management
      summary: GetdeployedshelvesIPv4data
      description: "Use this API to retrieve deployed IPv4 network data for shelves. \n\nPrerequisite: IPv4 network data must be uploaded for deployed shelf."
      operationId: GetdeployedshelvesIPv4data
      parameters:
      - name: tid
        in: query
        description: Target Identifier for shelves in deployed IPv4 network
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved deployed shelves IPv4 data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeployedShelf'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeployedShelf'
        '500':
          description: Failed to retrieve deployed shelves IPv4 data, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: true
    delete:
      tags:
      - Deployed Network IPv4 Management
      summary: DeletedeployedshelfIPv4data
      description: Use this API to delete deployed shelf IPv4 data.
      operationId: DeletedeployedshelfIPv4data
      parameters: []
      responses:
        '200':
          description: Successfully deleted shelf IPv4 data.
          headers: {}
          content: {}
        '400':
          description: Bad Request, ShelfNumber or Tid is not valid or does not exist.
          headers: {}
          content: {}
        '500':
          description: Internal Error in deletion of Shelf, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: true
    post:
      tags:
      - Deployed Network IPv4 Management
      summary: LoaddeployedshelvesIPv4data
      description: >-
        Use this API to load deployed shelves IPv4 data into commissioning.


        Prerequisite: Shelves are already deployed in the network and are not commissioned using scripts generated by commissioning
      operationId: LoaddeployedshelvesIPv4data
      parameters: []
      requestBody:
        description: deployed Network object.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/deployedNetwork'
              description: deployed Network object.
        required: true
      responses:
        '201':
          description: Successfully loaded shelves IPv4 data.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Failed to load shelves IPv4 data, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: true
  /commissioning/api/v1/ipaddress/:
    get:
      tags:
      - Retrieval of IPAdress Management
      summary: GetIPAddressunderagivensubnetortid
      description: Retrieve IPAddress from given subnet or tid.
      operationId: GetIPAddressunderagivensubnetortid
      parameters:
      - name: tid
        in: query
        description: tid or Target Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: subnet
        in: query
        description: Subnet
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully Retrieved IPAddress.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPAddress'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/IPAddress'
        '500':
          description: Retrieval of IPAddress failed. error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/services/:
    get:
      tags:
      - Service Management
      summary: Getprovisionedservicesstate
      description: Retrieve provisioned services state.
      operationId: Getprovisionedservicesstate
      parameters: []
      responses:
        '200':
          description: Successfully retrieved provisioned services state.
          headers: {}
          content: {}
        '500':
          description: Retrieval of provisioned services state failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Service Management
      summary: Triggerserviceprovisioning
      description: Perform manual provisioning of all services like SNMP, NTP etc. which is normally done after successful discovery of network element. If performed for a specific service this operation will queue a request per discovered node. The processing of requests for all nodes will take time to complete. Subsequent Post requests for a service will be rejected until the queue has been completely processed
      operationId: Triggerserviceprovisioning
      parameters:
      - name: sessionid
        in: query
        description: Session id of the network element.
        style: form
        explode: true
        schema:
          type: string
      - name: nodename
        in: query
        description: Node name in a planned network.
        style: form
        explode: true
        schema:
          type: string
      - name: deviceType
        in: query
        description: The provisioning of the service to be trigger against provided type of network elements e.g. 6500, Waveserver, Waveserver Ai
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: Service to be provisioned, if not provided by default all applicable services will be provisioned. Bulk operation may be slow.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Successfully provisioned services.
          headers: {}
          content: {}
        '202':
          description: Request has been accepted for provisioning.
          headers: {}
          content: {}
        '500':
          description: Failed to provision services, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/uap-6500-1/:
    get:
      tags:
      - User Access Privileges Management
      summary: DetermineUserAccessLevel1Privilege
      description: Validate User Access Level 1 Privilege
      operationId: DetermineUserAccessLevel1Privilege
      parameters: []
      responses:
        '200':
          description: User has 6500 Level 1 Access privileges.
          headers: {}
          content: {}
        '500':
          description: User does not have any access privileges.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/uap-6500-2/:
    get:
      tags:
      - User Access Privileges Management
      summary: DetermineUserAccessLevel2Privilege
      description: Validate User Access Level 2 Privilege
      operationId: DetermineUserAccessLevel2Privilege
      parameters: []
      responses:
        '200':
          description: User has 6500 Level 2 Access privileges.
          headers: {}
          content: {}
        '500':
          description: User does not have Level 2 Access privileges.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/uap-6500-3/:
    get:
      tags:
      - User Access Privileges Management
      summary: DetermineUserAccessLevel3Privilege
      description: Validate User Access Level 3 Privilege
      operationId: DetermineUserAccessLevel3Privilege
      parameters: []
      responses:
        '200':
          description: User has 6500 Level 3 Access privileges.
          headers: {}
          content: {}
        '500':
          description: User does not have Level 3 Access privileges.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/uap-6500-4/:
    get:
      tags:
      - User Access Privileges Management
      summary: DetermineUserAccessLevel4Privilege
      description: Validate User Access Level 4 Privilege
      operationId: DetermineUserAccessLevel4Privilege
      parameters: []
      responses:
        '200':
          description: User has 6500 Level 4 Access privileges.
          headers: {}
          content: {}
        '500':
          description: User does not have Level 4 Access privileges.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/uap-6500-5/:
    get:
      tags:
      - User Access Privileges Management
      summary: DetermineUserAccessLevel5Privilege
      description: Validate User Access Level 5 Privilege
      operationId: DetermineUserAccessLevel5Privilege
      parameters: []
      responses:
        '200':
          description: User has 6500 Level 5 Access privileges.
          headers: {}
          content: {}
        '500':
          description: User does not have Level 5 Access privileges.
          headers: {}
          content: {}
      deprecated: false
  /commissioning/api/v1/deploymentData/:
    get:
      tags:
      - Deployment data
      summary: Getthedeploymentdataoftheplanningproject
      description: Use this API to retrieve the deployment data of the planning project.
      operationId: Getthedeploymentdataoftheplanningproject
      parameters:
      - name: projectname
        in: query
        description: Project Name of planned network.
        required: true
        style: form
        explode: true
        schema:
          type: object
      responses:
        '200':
          description: Successfully retrieved deployment data of the project.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deploymentdata'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Deploymentdata'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Retrieval of deployment data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Deployment data
      summary: Updatethedeploymentdataoftheplanningproject.
      description: Use this API to add/update the deployment data of the planning project.
      operationId: Updatethedeploymentdataoftheplanningproject.
      parameters:
      - name: projectname
        in: query
        description: Project Name of planned network.
        required: true
        style: form
        explode: true
        schema:
          type: object
      requestBody:
        description: Network construct userdata and attribute data to be updated.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PostDeploymentRequestData'
              - description: Network construct userdata and attribute data to be updated.
        required: true
      responses:
        '201':
          description: Request sent successfully to update the deployment of the project.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deploymentdata1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Deploymentdata1'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Updation of deployment data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /ifd/api/v1/configResource:
    get:
      tags:
      - Configuration Resource v1
      summary: getAllConfigurations
      description: Get all existing configuration values
      operationId: getAllConfigurations
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Configuration Resource v1
      summary: putConfiguration
      description: Updates and add configuration name and value
      operationId: putConfiguration
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /ifd/api/v1/configResource/{propertyName}:
    get:
      tags:
      - Configuration Resource v1
      summary: getConfiguration
      description: Gets the value for the given configName
      operationId: getConfiguration
      parameters:
      - name: propertyName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /ifd/api/configResource:
    get:
      tags:
      - configuration Resource
      summary: GetgetAllConfigurations
      description: Get all existing configuration values
      operationId: GetgetAllConfigurations
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - configuration Resource
      summary: PutputConfiguration
      description: 'This API allows updating  configuration property '
      operationId: PutputConfiguration
      parameters: []
      requestBody:
        description: ConfigResource property as JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ConfigResourceRequest'
              - description: ConfigResource property as JSON Profile wrapper object
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResourceResponse'
        '201':
          description: Configuration property has been stored
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/configResource/{propertyName}:
    get:
      tags:
      - configuration Resource
      summary: GetgetConfiguration
      description: Gets the value for the given configName
      operationId: GetgetConfiguration
      parameters:
      - name: propertyName
        in: path
        description: PropertyName used for lookup
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResourceResponse'
        '404':
          description: Config Name Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /events-to-service-correlator/api/v1/affectedServices:
    get:
      tags:
      - Alarm to Service Query
      summary: getAffectedServices
      description: Search affected services for an alarm
      operationId: getAffectedServices
      parameters:
      - name: alarmId
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Affected Services Query completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffectedServicesData'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /events-to-service-correlator/api/v1/affectedServicesCounts:
    get:
      tags:
      - Alarm to Service Query
      summary: getAffectedServicesCounts
      description: Get number of affected services for alarms
      operationId: getAffectedServicesCounts
      parameters:
      - name: alarmIds
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Affected Services Counts Query completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffectedServicesCounts'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
    post:
      tags:
      - Alarm to Service Query
      summary: postGetAffectedServicesCounts
      description: Get number of affected services for alarms
      operationId: postGetAffectedServicesCounts
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AffectedServicesCountsParams'
        required: true
      responses:
        '200':
          description: Affected Services Counts Query completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffectedServicesCounts'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /events-to-service-correlator/api/v1/correlatedAlarmsForService:
    get:
      tags:
      - Service to Alarm Query
      summary: getCorrelatedAlarms
      description: Search correlated alarms for a service
      operationId: getCorrelatedAlarms
      parameters:
      - name: serviceId
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Correlated Alarms Query completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorrelatedAlarmsData'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /events-to-service-correlator/api/v1/debug/bulkload/bulkActionsNumber:
    put:
      tags:
      - Debug
      summary: changeBulkActionsNumber
      description: Change the bulk actions number for bulkprocessor to ES
      operationId: changeBulkActionsNumber
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkActionsNumber'
        required: true
      responses:
        '200':
          description: The newly active bulk actions number
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkActionsNumber'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /events-to-service-correlator/api/v1/debug/bulkload/bulkLoadWorkers:
    put:
      tags:
      - Debug
      summary: changeBulkLoadWorkers
      description: Change the bulk load workers for bulkprocessor to ES
      operationId: changeBulkLoadWorkers
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkLoadWorkers'
        required: true
      responses:
        '200':
          description: The newly active bulk load workers
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkLoadWorkers'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /events-to-service-correlator/api/v1/debug/bulkload/flushInterval:
    put:
      tags:
      - Debug
      summary: changeFlushInterval
      description: Change the flushInterval in seconds of bulkprocessor to ES
      operationId: changeFlushInterval
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlushInterval'
        required: true
      responses:
        '200':
          description: The newly active flush interval
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlushInterval'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /events-to-service-correlator/api/v1/debug/logs:
    get:
      tags:
      - Debug
      summary: getLogLevel
      description: Retrieves the currently active log level
      operationId: getLogLevel
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: joy
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogLevel'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
    put:
      tags:
      - Debug
      summary: changeLogLevel
      description: Changes the log level
      operationId: changeLogLevel
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogLevel'
        required: true
      responses:
        '200':
          description: The newly active log level
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogLevel'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /dct/api/v1/bpi/credentials/:
    post:
      tags:
      - credentials
      summary: CreateValue
      description: Add credentials for an IP address.
      operationId: CreateValue
      parameters: []
      requestBody:
        description: The credentials to be added.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DctApiV1BpiCredentialsRequest'
              - description: The credentials to be added.
        required: true
      responses:
        '200':
          description: Credentials successfully added.
          headers: {}
          content: {}
        '400':
          description: Failed to validate the request.
          headers: {}
          content: {}
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content: {}
      deprecated: false
  /nsi/api/equipment:
    get:
      tags:
      - 000 - nsiapiequipment
      summary: getEquipment
      description: >-
        <p>LATEST VERSION: V6
         List of equipment returned in JSON format.<p>Only one of the following parameters must be specified:<ul><li>networkConstruct.id<li>equipmentExpectations.equipmentIntent.id<li>id</ul>
      operationId: getEquipment
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of equipment identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 Equipment at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentDiscovered, equipmentPlanned, srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 000 - nsiapiequipment
      summary: postEquipment
      description: >-
        <p>LATEST VERSION: V4<p>This REST API is intended to be used by equipment provisioning micro-service IFD only to create or update an equipment expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>location - management protocol used to retrieve the information and the physical location of the equipment such as its shelf, slot and subslot<li>network construct id relationship<li>a list of equipment expectation id relationship<li>the equipment expectation content - specified in the included section<ul><li>provisionedSpec - The provisioned specification (logical representation) of the equipment<li>installedSpec - The installed specification (physical representation) of the equipment<li>cardType<li>nativeName<li>category<li>validateParameters - The list of parameters (if any) to be validated against the expectation<ul><li>Valid parameters include all equipment expectation content as specified above.<li>Additionally, provisionedSpec and installedSpec can be validated against their sub-attributes. These include: <ul><li>hardwareVersion<li>serialNumber<li>manufacturer<li>type<li>partNumber<li>version<li>additionalAttributes<li>displayLabels</ul></ul></ul></ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11",
            "type": "equipment",
            "attributes": {
            },
            "relationships": {
              "equipmentExpectations": {
                "data": [
                  {
                    "type": "equipmentExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                ]
              },
              "equipmentPlanned": {
                "data": {
                  "type": "equipmentPlanned",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                }
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "equipmentExpectations",
              "attributes": {
                "provisionedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "installedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "cardType": "100GOCLD",
                "validateParameters": {
                  "include": "provisionedSpec.partNumber, installedSpec.partNumber, cardType"
                }
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            },
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11",
              "type": "equipmentPlanned",
              "attributes": {
                "provisionedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "installedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "cardType": "100GOCLD"
              },
              "relationships": {
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                 }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postEquipment
      parameters: []
      requestBody:
        description: Equipment to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentRO'
              - description: Equipment to create or update
        required: true
      responses:
        '201':
          description: Successfully created/updated the equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create or update the equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipment/{eqpId}/expectations:
    post:
      tags:
      - 000 - nsiapiequipment
      summary: postExpectation
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: postExpectation
      parameters:
      - name: eqpId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: EquipmentExpectation to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentExpectationRO'
              - description: EquipmentExpectation to create or update
        required: false
      responses:
        '200':
          description: An existing Equipment expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '201':
          description: Equipment expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Equipment does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipment/{equipmentId}:
    get:
      tags:
      - 000 - nsiapiequipment
      summary: getEquipmentById
      description: '<p>LATEST VERSION: V3<p>Equipment returned in JSON format'
      operationId: getEquipmentById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentDiscovered, equipmentPlanned, srlgs, carrierEquipment, utilization'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    put:
      tags:
      - 000 - nsiapiequipment
      summary: putEquipment
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putEquipment
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new equipment data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentRO'
              - description: The new equipment data
        required: true
      responses:
        '200':
          description: Equipment with given id has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Bad or invalid parameters were provided.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update equipment, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiequipment
      summary: deleteEquipmentById
      description: '<p>LATEST VERSION: V3'
      operationId: deleteEquipmentById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Successfully deleted the equipment.
          headers: {}
          content: {}
        '204':
          description: The specified equipment does not exist.
          headers: {}
          content: {}
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipment/{equipmentId}/equipmentExpectations:
    get:
      tags:
      - 000 - nsiapiequipment
      summary: getEquipmentExpectations
      description: '<p>LATEST VERSION: V2_0'
      operationId: getEquipmentExpectations
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationListRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment cannot be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the expectations for the equipment id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipment/{equipmentId}/equipmentExpectations/{equipmentExpectationId}:
    get:
      tags:
      - 000 - nsiapiequipment
      summary: getEquipmentExpectationById
      description: '<p>LATEST VERSION: V2_0'
      operationId: getEquipmentExpectationById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentExpectationId
        in: path
        description: Equipment expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment expectation cannot be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the equipment expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiequipment
      summary: deleteEquipmentExpectationById
      description: '<p>LATEST VERSION: V3'
      operationId: deleteEquipmentExpectationById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentExpectationId
        in: path
        description: Equipment expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted the equipment expectation successfully.
          headers: {}
          content: {}
        '204':
          description: The equipment expectation does not exists.
          headers: {}
          content: {}
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The equipment does not exists.
          headers: {}
          content: {}
        '500':
          description: Failed to delete the equipment expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipment/{equipmentId}/equipmentPlanned:
    get:
      tags:
      - 000 - nsiapiequipment
      summary: getEquipmentPlannedById
      description: '<p>LATEST VERSION: V3<p>Equipment returned in JSON format'
      operationId: getEquipmentPlannedById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment planned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentPlannedRO'
        '403':
          description: Forbidden to access specified equipment planned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment planned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested equipment planned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    put:
      tags:
      - 000 - nsiapiequipment
      summary: putEquipmentPlanned
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putEquipmentPlanned
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new equipment data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentPlannedRO'
              - description: The new equipment data
        required: true
      responses:
        '200':
          description: Equipment planned with given id has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Bad or invalid parameters were provided.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update equipment planned, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 000 - nsiapiequipment
      summary: patchPlannedEquipment
      description: >-
        <p>LATEST VERSION: V3

        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchPlannedEquipment
      parameters:
      - name: equipmentId
        in: path
        description: The id of the Equipment to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Equipment.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentPatchRO'
              - description: A patch request to the given Equipment.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentPlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipment/{equipmentId}/expectations/{equipmentExpectationId}:
    patch:
      tags:
      - 000 - nsiapiequipment
      summary: patchEquipmentExpectation
      description: >-
        <p>LATEST VERSION: V3

        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "srlg": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        }

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchEquipmentExpectation
      parameters:
      - name: equipmentId
        in: path
        description: The id of the Equipment to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentExpectationId
        in: path
        description: The id of the equipmentExpectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Equipment.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentPatchRO'
              - description: A patch request to the given Equipment.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipment/{equipmentId}/maintenanceMode:
    post:
      tags:
      - 000 - nsiapiequipment
      summary: addMaintenanceMode
      description: 'LATEST VERSION: V3'
      operationId: addMaintenanceMode
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: maintenanceMode value
        content:
          application/json:
            schema:
              type: boolean
              description: maintenanceMode value
        required: false
      responses:
        '200':
          description: The maintenanceMode for the specific equipment has been created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '422':
          description: No request body was provided
          headers: {}
          content: {}
      deprecated: false
  /nsi/api/equipment/{equipmentId}/userData/{userDataKey}:
    put:
      tags:
      - 000 - nsiapiequipment
      summary: putEquipmentUserData
      description: "<p>LATEST VERSION: V2_0<p>If present, the leading and trailing whitespaces will be trimmed from the userData's key and value.<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: putEquipmentUserData
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of userData to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: true
      responses:
        '200':
          description: Equipment userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiequipment
      summary: deleteEquipmentUserData
      description: '<p>LATEST VERSION: V2_0'
      operationId: deleteEquipmentUserData
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified equipment userData does not exist
          headers: {}
          content: {}
        '204':
          description: Deleted equipment userData successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete equipment userData.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v6/equipment:
    get:
      tags:
      - 994 - nsiapiv6equipment
      summary: getEquipmentV6
      description: List of equipment returned in JSON format.<p>Only one of the following parameters must be specified:<ul><li>networkConstruct.id<li>equipmentExpectations.equipmentIntent.id<li>id</ul>
      operationId: getEquipmentV6
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of equipment identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 Equipments at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentDiscovered, equipmentPlanned, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v5/equipment:
    get:
      tags:
      - 995 - nsiapiv5equipment
      summary: getEquipmentV5
      description: List of equipment returned in JSON format.<p>Only one of the following parameters must be specified:<ul><li>networkConstruct.id<li>equipmentExpectations.equipmentIntent.id<li>id</ul>
      operationId: getEquipmentV5
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of equipment identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted ALL to return all Equipment at once.
        style: form
        explode: true
        schema:
          type: string
          default: ALL
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentDiscovered, equipmentPlanned, srlgs'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsi/api/v4/equipment:
    get:
      tags:
      - 996 - nsiapiv4equipment
      summary: GetgetEquipment
      description: List of equipment returned in JSON format.
      operationId: GetgetEquipment
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.siteName). If provided, must also provide searchText parameter
        style: form
        explode: true
        schema:
          type: string
      - name: resourceState
        in: query
        description: '(Optional) List of resource states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: networkConstruct.name
        in: query
        description: (Optional) Network Construct name
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: siteId
        in: query
        description: (Optional) Site Identifier for equipment
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: '(Optional) Comma separated list of equipment states. The allowed values are: IS, OOS, OOS_AU, OOS_MA, OOS_AUMA'
        style: form
        explode: true
        schema:
          type: string
      - name: shelf
        in: query
        description: (Optional) Comma separated list of equipment shelves
        style: form
        explode: true
        schema:
          type: string
      - name: slot
        in: query
        description: (Optional) Comma separated list of equipment slots
        style: form
        explode: true
        schema:
          type: string
      - name: subSlot
        in: query
        description: (Optional) Comma separated list of equipment sub-slots
        style: form
        explode: true
        schema:
          type: string
      - name: subShelf
        in: query
        description: (Optional) Comma separated list of equipment sub-shelves
        style: form
        explode: true
        schema:
          type: string
      - name: availabilityState
        in: query
        description: '(Optional) List of Equipment availabilityState. The allowed values are: PLANNED, AVAILABLE, UNVALIDATED, INUSE'
        style: form
        explode: true
        schema:
          type: string
      - name: reservationState
        in: query
        description: '(Optional) List of Equipment reservationState. The allowed values are: Unknown, Not reserved, Reserved for maintenance, Reserved for facility, Reserved for reversion'
        style: form
        explode: true
        schema:
          type: string
      - name: maintenanceMode
        in: query
        description: '(Optional) List of Equipment maintenanceMode. The allowed values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: cardType
        in: query
        description: (Optional) List of Equipment cardType
        style: form
        explode: true
        schema:
          type: string
      - name: specificationMismatch
        in: query
        description: '(Optional) List of Equipment specificationMismatch. The allowed values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: category
        in: query
        description: '(Optional) List of Equipment category. The allowed values are: rack, shelf, pluggable, standalone'
        style: form
        explode: true
        schema:
          type: string
      - name: neContactState
        in: query
        description: '(Optional) List of neContactState. The allowed values are: IN, OUT'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.macAddress
        in: query
        description: (Optional) Network Construct macAddress
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: specificationMismatch, state, availabilityState, reservationState, maintenanceMode, cardType, category, ncMacAddress'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, planned, discovered, networkConstructs, equipmentPlanned, equipmentDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 996 - nsiapiv4equipment
      summary: PostpostEquipment
      description: >-
        This REST API is intended to be used by equipment provisioning micro-service IFD only to create planned equipment with an equipment expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>userData<li>equipmentPlanned id relationship <li>a list of equipment expectation id relationship<li>the equipment planned content - specified in the included section with networkConstructRelationship<ul><li>location - management protocol used to retrieve the information and the physical location of the equipment such as its shelf, slot and subslot<li>Any base equipment attributes.<li>network construct id relationship<ul><li>the equipment expectation content - specified in the included section<ul><li>provisionedSpec - The provisioned specification (logical representation) of the equipment<li>installedSpec - The installed specification (physical representation) of the equipment<li>cardType<li>nativeName<li>category<li>validateParameters - The list of parameters (if any) to be validated against the expectation<ul><li>Valid parameters include all equipment expectation content as specified above.<li>Additionally, provisionedSpec and installedSpec can be validated against their sub-attributes. These include: <ul><li>hardwareVersion<li>serialNumber<li>manufacturer<li>type<li>partNumber<li>version<li>additionalAttributes<li>displayLabels</ul></ul></ul></ul><p>The response returns equipment that is created.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11",
            "type": "equipment",
            "attributes": {
            },
            "relationships": {
              "equipmentExpectations": {
                "data": [
                  {
                    "type": "equipmentExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                ]
              },
              "equipmentPlanned": {
                "data": {
                  "type": "equipmentPlanned",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                }
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "equipmentExpectations",
              "attributes": {
                "provisionedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "installedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "cardType": "100GOCLD",
                "validateParameters": {
                  "include": "provisionedSpec.partNumber, installedSpec.partNumber, cardType"
                }
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            },
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11",
              "type": "equipmentPlanned",
              "attributes": {
                "provisionedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "installedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "cardType": "100GOCLD"
              },
              "relationships": {
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                 }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostEquipment
      parameters: []
      requestBody:
        description: Equipment to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentRO'
              - description: Equipment to create or update
        required: true
      responses:
        '201':
          description: Successfully created the equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create the equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/equipment:
    get:
      tags:
      - 997 - nsiapiv3equipment
      summary: GetgetEquipment1
      description: List of equipment returned in JSON format.<p>At least one of the following parameters must be specified:<ul><li>ncId (Deprecated)<li>networkConstruct.id<li>equipmentExpectations.equipmentIntent.id<li>id<li>siteId<li>searchText</ul>
      operationId: GetgetEquipment1
      parameters:
      - name: ncId
        in: query
        description: (Optional, Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: (Optional) Comma separated list of equipment identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: (Optional) Status for equipment
        style: form
        explode: true
        schema:
          type: string
      - name: shelf
        in: query
        description: (Optional) Shelf for equipment
        style: form
        explode: true
        schema:
          type: string
      - name: slot
        in: query
        description: (Optional) Slot for equipment
        style: form
        explode: true
        schema:
          type: string
      - name: subSlot
        in: query
        description: (Optional) Subslot for equipment
        style: form
        explode: true
        schema:
          type: string
      - name: subShelf
        in: query
        description: (Optional) Subshelf for equipment
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: siteId
        in: query
        description: (Optional) Site Identifier for equipment
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.siteName). If provided, must also provide searchText parameter
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentDiscovered, equipmentPlanned'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted ALL to return all Equipment at once.
        style: form
        explode: true
        schema:
          type: string
          default: ALL
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 997 - nsiapiv3equipment
      summary: PostpostEquipment1
      description: >-
        This REST API is intended to be used by equipment provisioning micro-service IFD only to create or update an equipment expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>location - management protocol used to retrieve the information and the physical location of the equipment such as its shelf, slot and subslot<li>network construct id relationship<li>a list of equipment expectation id relationship<li>the equipment expectation content - specified in the included section<ul><li>provisionedSpec - The provisioned specification (logical representation) of the equipment<li>installedSpec - The installed specification (physical representation) of the equipment<li>cardType<li>nativeName<li>category<li>validateParameters - The list of parameters (if any) to be validated against the expectation<ul><li>Valid parameters include all equipment expectation content as specified above.<li>Additionally, provisionedSpec and installedSpec can be validated against their sub-attributes. These include: <ul><li>hardwareVersion<li>serialNumber<li>manufacturer<li>type<li>partNumber<li>version<li>additionalAttributes<li>displayLabels</ul></ul></ul></ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11",
            "type": "equipment",
            "attributes": {
              "cardType": "100GOCLD",
              "locations": [
                {
                  "managementType": "tl1",
                  "shelf": "12",
                  "slot": "11"
                }
              ],
              "availabilityState": "PLANNED",
              "maintenanceMode": false
            },
            "relationships": {
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                }
              },
              "equipmentExpectations": {
                "data": [
                  {
                    "type": "equipmentExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "equipmentExpectations",
              "attributes": {
                "provisionedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "installedSpec": {
                  "partNumber": "NTK539UJ"
                },
                "cardType": "100GOCLD",
                "validateParameters": {
                  "include": "provisionedSpec.partNumber, installedSpec.partNumber, cardType"
                }
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostEquipment1
      parameters: []
      requestBody:
        description: Equipment to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentRO'
              - description: Equipment to create or update
        required: true
      responses:
        '201':
          description: Successfully created the equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create the equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/equipment/{eqpId}/expectations:
    post:
      tags:
      - 997 - nsiapiv3equipment
      summary: PostpostExpectation
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PostpostExpectation
      parameters:
      - name: eqpId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: EquipmentExpectation to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentExpectationRO'
              - description: EquipmentExpectation to create or update
        required: false
      responses:
        '200':
          description: An existing Equipment expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '201':
          description: Equipment expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Equipment does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/equipment/{equipmentId}:
    get:
      tags:
      - 997 - nsiapiv3equipment
      summary: GetgetEquipmentById
      description: Equipment returned in JSON format
      operationId: GetgetEquipmentById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentPlanned, equipmentDiscovered, srlgs, carrierEquipment, utilization.'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    put:
      tags:
      - 997 - nsiapiv3equipment
      summary: PutputEquipment
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutputEquipment
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new equipment data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentRO'
              - description: The new equipment data
        required: true
      responses:
        '200':
          description: Equipment with given id has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Bad or invalid parameters were provided.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update equipment, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3equipment
      summary: DeletedeleteEquipmentById
      description: Deletes a specific equipment
      operationId: DeletedeleteEquipmentById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Successfully deleted the equipment.
          headers: {}
          content: {}
        '204':
          description: The specified equipment does not exist.
          headers: {}
          content: {}
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/equipment/{equipmentId}/equipmentExpectations/{equipmentExpectationId}:
    delete:
      tags:
      - 997 - nsiapiv3equipment
      summary: DeletedeleteEquipmentExpectationById
      description: Delete a specific equipment expectation
      operationId: DeletedeleteEquipmentExpectationById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentExpectationId
        in: path
        description: Equipment expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted the equipment expectation successfully.
          headers: {}
          content: {}
        '204':
          description: The equipment expectation does not exists.
          headers: {}
          content: {}
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The equipment does not exists.
          headers: {}
          content: {}
        '500':
          description: Failed to delete the equipment expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/equipment/{equipmentId}/equipmentPlanned:
    get:
      tags:
      - 997 - nsiapiv3equipment
      summary: GetgetEquipmentPlannedById
      description: Equipment Planned returned in JSON format
      operationId: GetgetEquipmentPlannedById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentPlannedRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    put:
      tags:
      - 997 - nsiapiv3equipment
      summary: PutputEquipmentPlanned
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutputEquipmentPlanned
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new equipment data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentPlannedRO'
              - description: The new equipment data
        required: true
      responses:
        '200':
          description: Equipment planned with given id has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Bad or invalid parameters were provided.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update equipment planned, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 997 - nsiapiv3equipment
      summary: PatchpatchPlannedEquipment
      description: >-
        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchPlannedEquipment
      parameters:
      - name: equipmentId
        in: path
        description: The id of the Equipment to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Equipment.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentPatchRO'
              - description: A patch request to the given Equipment.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentPlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/equipment/{equipmentId}/expectations/{equipmentExpectationId}:
    patch:
      tags:
      - 997 - nsiapiv3equipment
      summary: PatchpatchEquipmentExpectation
      description: >-
        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "srlg": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        }

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre>

        <p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchEquipmentExpectation
      parameters:
      - name: equipmentId
        in: path
        description: The id of the Equipment to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentExpectationId
        in: path
        description: The id of the equipmentExpectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Equipment.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentPatchRO'
              - description: A patch request to the given Equipment.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/equipment/{equipmentId}/maintenanceMode:
    post:
      tags:
      - 997 - nsiapiv3equipment
      summary: PostaddMaintenanceMode
      description: Creates or updates MaintenanceMode for a specific equipment
      operationId: PostaddMaintenanceMode
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: maintenanceMode value
        content:
          application/json:
            schema:
              type: boolean
              description: maintenanceMode value
        required: false
      responses:
        '200':
          description: The maintenanceMode for the specific equipment has been created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '422':
          description: No request body was provided
          headers: {}
          content: {}
      deprecated: false
  /nsi/api/v2_0/equipment/{equipmentId}/equipmentExpectations:
    get:
      tags:
      - 998 - nsiapiv2_0equipment
      summary: GetgetEquipmentExpectations
      description: Retrieves the expectations of the equipment
      operationId: GetgetEquipmentExpectations
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationListRO'
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment cannot be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the expectations for the equipment id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/equipment/{equipmentId}/equipmentExpectations/{equipmentExpectationId}:
    get:
      tags:
      - 998 - nsiapiv2_0equipment
      summary: GetgetEquipmentExpectationById
      description: Retrieves a specific equipment expectation
      operationId: GetgetEquipmentExpectationById
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentExpectationId
        in: path
        description: Equipment expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentExpectationRO'
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment expectation cannot be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the equipment expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/equipment/{equipmentId}/userData/{userDataKey}:
    put:
      tags:
      - 998 - nsiapiv2_0equipment
      summary: PutputEquipmentUserData
      description: If present, the leading and trailing whitespaces will be trimmed from the userData's key and value.
      operationId: PutputEquipmentUserData
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of userData to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: true
      responses:
        '200':
          description: Equipment userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0equipment
      summary: DeletedeleteEquipmentUserData
      description: Delete a userData from a given equipment
      operationId: DeletedeleteEquipmentUserData
      parameters:
      - name: equipmentId
        in: path
        description: Equipment identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified equipment userData does not exist
          headers: {}
          content: {}
        '204':
          description: Deleted equipment userData successfully.
          headers: {}
          content: {}
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete equipment userData.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipmentGroups:
    get:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: getEquipmentGroup
      description: '<p>LATEST VERSION: V3<p>At least one of the following parameters must be specified:<ul><li>ncId (Deprecated)<li>networkConstruct.id<li>equipmentGroupExpectations.equipmentIntent.id<li>equipment.id<li>type</ul>'
      operationId: getEquipmentGroup
      parameters:
      - name: ncId
        in: query
        description: (Optional, Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: (Optional) Equipment group type.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/type1331'
          - description: (Optional) Equipment group type.
      - name: equipment.id
        in: query
        description: (Optional) Comma separated list of equipment identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentGroupExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: actualizations, expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 Equipment Groups at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: Retrieved EquipmentGroups successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupListRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment groups with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: postEquipmentGroup
      description: >-
        <p>LATEST VERSION: V2_0<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQG_SLOTSEQ_12_11_1",
              "type": "equipmentGroup",
              "attributes": {
                "type": "SLOTSEQUENCE"
              },
              "relationships": {
                "networkConstruct": {
                  "data": {
                    "type": "networkConstructs",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                  }
                }
              }
            }
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postEquipmentGroup
      parameters: []
      requestBody:
        description: Equipment group to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentGroupRO'
              - description: Equipment group to create or update
        required: true
      responses:
        '201':
          description: Equipment group created or updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupRO'
        '400':
          description: Invalid data to create or update equipment group.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create or update EquipmentGroup.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/equipmentGroups/{equipmentGroupId}:
    get:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: getEquipmentGroupById
      description: '<p>LATEST VERSION: V2_0'
      operationId: getEquipmentGroupById
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: actualizations, expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment group with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the equipment group with given Id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: deleteEquipmentGroupById
      description: '<p>LATEST VERSION: V2_0'
      operationId: deleteEquipmentGroupById
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group to be deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted EquipmentGroup successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to delete specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete EquipmentGroup.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/equipmentGroups/{equipmentGroupId}/equipmentGroupExpectations:
    get:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: getEquipmentGroupExpectations
      description: '<p>LATEST VERSION: V2_0'
      operationId: getEquipmentGroupExpectations
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group whose expectations are to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupExpectationListRO'
        '400':
          description: Invalid request for equipment group.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment group can't be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the expectations for the equipment group id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    post:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: postEquipmentGroupExpectation
      description: "<p>LATEST VERSION: V2_0<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n    \"data\":     {\n      \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQG_SLOTSEQ_12_11_1_Expectation1\",\n      \"type\": \"equipmentGroupExpectations\",\n      \"attributes\": {\n        \"name\": \"Expectation1\",  \n        \"additionalAttributes\": {\n          \"add\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11\",\n          \"drop\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11\",\n          \"label\": \"Main-Expected\",\n          \"aid\": \"SLOTSEQ-12-11-1\"\n        }\n      },\n      \"relationships\": {\n        \"equipment\": {\n          \"data\": [\n            {\n              \"type\": \"equipment\",\n              \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11\"\n            }\n          ]\n        },\n        \"parent\": {\n          \"data\": {\n            \"type\": \"equipmentGroup\",\n            \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQG_OTS_12_11\"\n          }\n        },\n        \"equipmentIntent\": {\n          \"data\": {\n              \"type\": \"equipmentIntents\",\n              \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8:EquipmentIntent1\"\n          }\n        }\n      }\n    }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: postEquipmentGroupExpectation
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The equipment group expectation to be created or updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentGroupExpectationRO'
              - description: The equipment group expectation to be created or updated
        required: true
      responses:
        '201':
          description: Equipment group expectation created or updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupExpectationRO'
        '400':
          description: Invalid data to create or update equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create or update equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/equipmentGroups/{equipmentGroupId}/equipmentGroupExpectations/{equipmentGroupExpectationId}:
    get:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: GetgetEquipmentExpectationById1
      description: '<p>LATEST VERSION: V2_0'
      operationId: GetgetEquipmentExpectationById1
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group under which to retrieve an expectation
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentGroupExpectationId
        in: path
        description: Id of the expectation to retrieve
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupExpectationRO'
        '400':
          description: Invalid request for equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment group expectation can't be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the equipment group expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiequipmentGroups
      summary: deleteEquipmentGroupExpectationById
      description: '<p>LATEST VERSION: V2_0'
      operationId: deleteEquipmentGroupExpectationById
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group under which to delete an expectation
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentGroupExpectationId
        in: path
        description: Id of the expectation to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted equipment group expectation successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/equipmentGroups:
    get:
      tags:
      - 997 - nsiapiv3equipmentGroups
      summary: GetgetEquipmentGroup
      description: <p>At least one of the following parameters must be specified:<ul><li>ncId (Deprecated)<li>networkConstruct.id<li>equipmentGroupExpectations.equipmentIntent.id<li>equipment.id<li>type</ul>
      operationId: GetgetEquipmentGroup
      parameters:
      - name: ncId
        in: query
        description: (Optional, Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: (Optional) Equipment group type.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/type1331'
          - description: (Optional) Equipment group type.
      - name: equipment.id
        in: query
        description: (Optional) Comma separated list of equipment identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentGroupExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: actualizations, expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 Equipment Groups at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: Retrieved EquipmentGroups successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment groups with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2_0/equipmentGroups:
    get:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: GetgetEquipmentGroup1
      description: <p>At least one of the following parameters must be specified:<ul><li>ncId (Deprecated)<li>networkConstruct.id<li>equipmentGroupExpectations.equipmentIntent.id<li>equipment.id<li>type</ul>
      operationId: GetgetEquipmentGroup1
      parameters:
      - name: ncId
        in: query
        description: (Optional, Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: (Optional) Equipment group type.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/type1331'
          - description: (Optional) Equipment group type.
      - name: equipment.id
        in: query
        description: (Optional) Comma separated list of equipment identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentGroupExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: actualizations, expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted ALL to return all Equipment at once.
        style: form
        explode: true
        schema:
          type: string
          default: ALL
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the equipment groups with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    post:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: PostpostEquipmentGroup
      description: >-
        The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQG_SLOTSEQ_12_11_1",
              "type": "equipmentGroup",
              "attributes": {
                "type": "SLOTSEQUENCE"
              },
              "relationships": {
                "networkConstruct": {
                  "data": {
                    "type": "networkConstructs",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                  }
                }
              }
            }
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostEquipmentGroup
      parameters: []
      requestBody:
        description: Equipment group to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentGroupRO'
              - description: Equipment group to create or update
        required: true
      responses:
        '201':
          description: Equipment group created or updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupRO'
        '400':
          description: Invalid data to create or update equipment group.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create or update EquipmentGroupResource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2_0/equipmentGroups/{equipmentGroupId}:
    get:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: GetgetEquipmentGroupById
      description: Retrieves a specific equipment group
      operationId: GetgetEquipmentGroupById
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: actualizations, expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment group with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the equipment group with given Id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: DeletedeleteEquipmentGroupById
      description: Delete a specific equipment group
      operationId: DeletedeleteEquipmentGroupById
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group to be deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted EquipmentGroupResource successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to delete specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete EquipmentGroupResource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2_0/equipmentGroups/{equipmentGroupId}/equipmentGroupExpectations:
    get:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: GetgetEquipmentGroupExpectations
      description: Retrieves the expectations of an equipment group
      operationId: GetgetEquipmentGroupExpectations
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group whose expectations are to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupExpectationListRO'
        '400':
          description: Invalid request for equipment group.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment group can't be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the expectations for the equipment group id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    post:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: PostpostEquipmentGroupExpectation
      description: "The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n    \"data\":     {\n      \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQG_SLOTSEQ_12_11_1_Expectation1\",\n      \"type\": \"equipmentGroupExpectations\",\n      \"attributes\": {\n        \"name\": \"Expectation1\",  \n        \"additionalAttributes\": {\n          \"add\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11\",\n          \"drop\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11\",\n          \"label\": \"Main-Expected\",\n          \"aid\": \"SLOTSEQ-12-11-1\"\n        }\n      },\n      \"relationships\": {\n        \"equipment\": {\n          \"data\": [\n            {\n              \"type\": \"equipment\",\n              \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11\"\n            }\n          ]\n        },\n        \"parent\": {\n          \"data\": {\n            \"type\": \"equipmentGroup\",\n            \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8::EQG_OTS_12_11\"\n          }\n        },\n        \"equipmentIntent\": {\n          \"data\": {\n              \"type\": \"equipmentIntents\",\n              \"id\": \"aca92325-0c37-45b4-815d-df8c2c4e7da8:EquipmentIntent1\"\n          }\n        }\n      }\n    }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: PostpostEquipmentGroupExpectation
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The equipment group expectation to be created or updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentGroupExpectationRO'
              - description: The equipment group expectation to be created or updated
        required: true
      responses:
        '201':
          description: Equipment group expectation created or updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupExpectationRO'
        '400':
          description: Invalid data to create or update equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create or update equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2_0/equipmentGroups/{equipmentGroupId}/equipmentGroupExpectations/{equipmentGroupExpectationId}:
    get:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: GetgetEquipmentExpectationById2
      description: Retrieves a specific equipment group expectation
      operationId: GetgetEquipmentExpectationById2
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group under which to retrieve an expectation
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentGroupExpectationId
        in: path
        description: Id of the expectation to retrieve
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupExpectationRO'
        '400':
          description: Invalid request for equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested equipment group expectation can't be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the equipment group expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0equipmentGroups
      summary: DeletedeleteEquipmentGroupExpectationById
      description: Delete a specific equipment group expectation
      operationId: DeletedeleteEquipmentGroupExpectationById
      parameters:
      - name: equipmentGroupId
        in: path
        description: Id of the equipment group under which to delete an expectation
        required: true
        style: simple
        schema:
          type: string
      - name: equipmentGroupExpectationId
        in: path
        description: Id of the expectation to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted equipment group expectation successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to update specified equipment group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete equipment group expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/equipmentHolders:
    get:
      tags:
      - 000 - nsiapiequipmentHolders
      summary: getEquipmentHolder
      description: '<p>LATEST VERSION: V3<p>At least one of the following parameters must be specified:<ul><li>networkConstructId (Deprecated)<li>networkConstruct.id</ul>'
      operationId: getEquipmentHolder
      parameters:
      - name: networkConstructId
        in: query
        description: (Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 Equipment Holders at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: Retrieved EquipmentHolders successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentHolderRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment holders with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/equipmentHolders/{equipmentHolderId}:
    get:
      tags:
      - 000 - nsiapiequipmentHolders
      summary: getEquipmentHolderById
      description: '<p>LATEST VERSION: V2_0'
      operationId: getEquipmentHolderById
      parameters:
      - name: equipmentHolderId
        in: path
        description: Id of the equipment holder to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentHolderRO'
        '403':
          description: Forbidden to access specified equipment holder
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment holder with given id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment holder with given id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/equipmentHolders:
    get:
      tags:
      - 997 - nsiapiv3equipmentHolders
      summary: GetgetEquipmentHolder
      description: <p>At least one of the following parameters must be specified:<ul><li>networkConstructId (Deprecated)<li>networkConstruct.id</ul>
      operationId: GetgetEquipmentHolder
      parameters:
      - name: networkConstructId
        in: query
        description: (Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 Equipment Holders at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: Retrieved EquipmentHolders successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentHolderRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment holders with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2_0/equipmentHolders:
    get:
      tags:
      - 998 - nsiapiv2_0equipmentHolders
      summary: GetgetEquipmentHolder1
      description: <p>At least one of the following parameters must be specified:<ul><li>networkConstructId (Deprecated)<li>networkConstruct.id</ul>
      operationId: GetgetEquipmentHolder1
      parameters:
      - name: networkConstructId
        in: query
        description: (Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted ALL to return all Equipment at once.
        style: form
        explode: true
        schema:
          type: string
          default: ALL
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentHolderRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment holders with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsi/api/v2_0/equipmentHolders/{equipmentHolderId}:
    get:
      tags:
      - 998 - nsiapiv2_0equipmentHolders
      summary: GetgetEquipmentHolderById
      description: Retrieves a specific equipment holder
      operationId: GetgetEquipmentHolderById
      parameters:
      - name: equipmentHolderId
        in: path
        description: Id of the equipment holder to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentHolderRO'
        '400':
          description: Invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified equipment holder
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment holder with given id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment holder with given id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/clientPort:
    post:
      tags:
      - CLIENT PORT Operations
      summary: clientPortOperation
      description: Client port operations create/disable/enable/delete
      operationId: clientPortOperation
      parameters: []
      requestBody:
        description: Client Port Operation Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ClientPortRequest'
              - description: Client Port Operation Request
        required: true
      responses:
        '200':
          description: Client Port Operation Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientPortResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Entity not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/clientPort:
    post:
      tags:
      - CLIENT PORT Operations v1
      summary: PostclientPortOperation
      description: Client port operations create/disable/enable/delete
      operationId: PostclientPortOperation
      parameters: []
      requestBody:
        description: Client Port Operation Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ClientPortRequest'
              - description: Client Port Operation Request
        required: true
      responses:
        '200':
          description: Client Port Operation Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientPortResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Entity not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /ifd/api/equipmentIntents:
    get:
      tags:
      - Equipment Intents
      summary: getAllEquipmentIntents
      description: 'The operation is used to fetch all Equipment Intents submitted to the Intent Fulfillment Designer.<p>Prerequisite: At least one Equipment Intent must exist.</p>'
      operationId: getAllEquipmentIntents
      parameters: []
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponseArray'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Equipment Intents
      summary: createEquipmentIntent
      description: 'This API validates Equipment Intent attributes, plans Equipment Intent realization for deployment.<p>Prerequisite: The entered Equipment Intent is valid.</p>'
      operationId: createEquipmentIntent
      parameters: []
      requestBody:
        description: Equipment Intent as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentIntentRequest'
              - description: Equipment Intent as a JSON Profile wrapper object
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '201':
          description: Equipment Intent is created, Equipment realized and planned
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - Equipment Intents
      summary: updateEquipmentIntent
      description: 'This API modifies customerCode, UserLabel attribute of an equipment in an existing equipment intent.<p>Prerequisite: The entered equipment intentId and eqpId is valid.</p>'
      operationId: updateEquipmentIntent
      parameters: []
      requestBody:
        description: Equipment Intent edit request as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentIntentEditRequest'
              - description: Equipment Intent edit request as a JSON Profile wrapper object
        required: true
      responses:
        '204':
          description: Update successful
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/equipmentIntents/postUpgrade:
    post:
      tags:
      - Equipment Intents
      summary: upgradeEquipmentIntents
      description: 'This API upgrades existing FRES so that they have expectations with turnupTime and turnDownTime<p>Prerequisite: NA.</p>'
      operationId: upgradeEquipmentIntents
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '201':
          description: Upgrade command has been accepted
          headers: {}
          content: {}
        '400':
          description: Upgrade command has failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/equipmentIntents/postUpgrade/projectName:
    post:
      tags:
      - Equipment Intents
      summary: upgradeEquipmentIntentsProjectName
      description: "This API update Equipment's projectName attribute in NSI based on project ID in Equipment Intent "
      operationId: upgradeEquipmentIntentsProjectName
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/equipmentIntents/projectName/{projectName}:
    delete:
      tags:
      - Equipment Intents
      summary: deleteEquipmentIntent
      description: 'This API deletes an Equipment Intent based on project name.<p>Prerequisite: The project name to intent id mapping must exist for given project name</p>'
      operationId: deleteEquipmentIntent
      parameters:
      - name: projectName
        in: path
        description: The project name used for intent lookup
        required: true
        style: simple
        schema:
          type: string
      - name: ignoreEquipmentProvisioning
        in: query
        description: (Optional) Bypassing equipment provisioning state validation if set to true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: Equipment Intent deleted
          headers: {}
          content: {}
        '404':
          description: Equipment Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Equipment Intent state conflicted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/equipmentIntents/{id}:
    get:
      tags:
      - Equipment Intents
      summary: getEquipmentIntent
      description: 'Fetches a uniquely identified Equipment Intent.<p>Prerequisite: An Equipment Intent must exist with the given ID.</p>'
      operationId: getEquipmentIntent
      parameters:
      - name: id
        in: path
        description: The intent ID used for intent lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '404':
          description: Intent is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Equipment Intents
      summary: DeletedeleteEquipmentIntent
      description: 'This API deletes an Equipment Intent based on ID.<p>Prerequisite: An Equipment Intent must exist with the given ID.</p>'
      operationId: DeletedeleteEquipmentIntent
      parameters:
      - name: id
        in: path
        description: The intent ID used for intent lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: ignoreEquipmentProvisioning
        in: query
        description: (Optional) Bypassing equipment provisioning state validation if set to true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: Equipment Intent deleted
          headers: {}
          content: {}
        '404':
          description: Equipment Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Equipment Intent state conflicted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/equipmentIntents:
    get:
      tags:
      - Equipment Intents v1
      summary: GetgetAllEquipmentIntents
      description: 'The operation is used to fetch all Equipment Intents submitted to the Intent Fulfillment Designer.<p>Prerequisite: At least one Equipment Intent must exist.</p>'
      operationId: GetgetAllEquipmentIntents
      parameters: []
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponseArray'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    post:
      tags:
      - Equipment Intents v1
      summary: PostcreateEquipmentIntent
      description: 'This API validates Equipment Intent attributes, plans Equipment Intent realization for deployment.<p>Prerequisite: The entered Equipment Intent is valid.</p>'
      operationId: PostcreateEquipmentIntent
      parameters: []
      requestBody:
        description: Equipment Intent as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentIntentRequest'
              - description: Equipment Intent as a JSON Profile wrapper object
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '201':
          description: Equipment Intent is created, Equipment realized and planned
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v1/equipmentIntents/projectName/{projectName}:
    delete:
      tags:
      - Equipment Intents v1
      summary: DeletedeleteEquipmentIntent1
      description: 'This API deletes an Equipment Intent based on Project Name.<p>Prerequisite: The project name to intent id mapping must exist for given project name.</p>'
      operationId: DeletedeleteEquipmentIntent1
      parameters:
      - name: projectName
        in: path
        description: The project name used for intent lookup
        required: true
        style: simple
        schema:
          type: string
      - name: ignoreEquipmentProvisioning
        in: query
        description: (Optional) Bypassing equipment provisioning state validation if set to true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: Equipment Intent deleted
          headers: {}
          content: {}
        '404':
          description: Equipment Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Equipment Intent state conflicted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/equipmentIntents/{id}:
    get:
      tags:
      - Equipment Intents v1
      summary: GetgetEquipmentIntent
      description: 'Fetches a uniquely identified Equipment Intent.<p>Prerequisite: An Equipment Intent must exist with the given ID.</p>'
      operationId: GetgetEquipmentIntent
      parameters:
      - name: id
        in: path
        description: The intent ID used for intent lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '404':
          description: Intent is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    delete:
      tags:
      - Equipment Intents v1
      summary: DeletedeleteEquipmentIntent2
      description: 'This API deletes an Equipment Intent based on ID.<p>Prerequisite: An Equipment Intent must exist with the given ID.</p>'
      operationId: DeletedeleteEquipmentIntent2
      parameters:
      - name: id
        in: path
        description: The intent ID used for intent lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: ignoreEquipmentProvisioning
        in: query
        description: (Optional) Bypassing equipment provisioning state validation if set to true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: Equipment Intent deleted
          headers: {}
          content: {}
        '404':
          description: Equipment Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Equipment Intent state conflicted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v2/equipmentIntents:
    get:
      tags:
      - Equipment Intents v2
      summary: GetgetAllEquipmentIntents1
      description: 'The operation is used to fetch all Equipment Intents submitted to the Intent Fulfillment Designer.<p>Prerequisite: At least one Equipment Intent must exist.</p>'
      operationId: GetgetAllEquipmentIntents1
      parameters: []
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponseArray'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    post:
      tags:
      - Equipment Intents v2
      summary: PostcreateEquipmentIntent1
      description: 'This API validates Equipment Intent attributes, plans Equipment Intent realization for deployment.<p>Prerequisite: The entered Equipment Intent is valid.</p>'
      operationId: PostcreateEquipmentIntent1
      parameters: []
      requestBody:
        description: Equipment Intent as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentIntentRequest'
              - description: Equipment Intent as a JSON Profile wrapper object
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '201':
          description: Equipment Intent is created, Equipment realized and planned
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    put:
      tags:
      - Equipment Intents v2
      summary: PutupdateEquipmentIntent
      description: 'This API modifies customerCode, userLabel attribute of an equipment in an existing equipment intent.<p>Prerequisite: The entered equipment intentId and eqpId is valid.</p>'
      operationId: PutupdateEquipmentIntent
      parameters: []
      requestBody:
        description: Equipment Intent edit request as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentIntentEditRequest'
              - description: Equipment Intent edit request as a JSON Profile wrapper object
        required: true
      responses:
        '204':
          description: Update successful
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v2/equipmentIntents/{id}:
    get:
      tags:
      - Equipment Intents v2
      summary: GetgetEquipmentIntent1
      description: 'Fetches a uniquely identified Equipment Intent.<p>Prerequisite: An Equipment Intent must exist with the given ID.</p>'
      operationId: GetgetEquipmentIntent1
      parameters:
      - name: id
        in: path
        description: The intent ID used for intent lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '404':
          description: Intent is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    delete:
      tags:
      - Equipment Intents v2
      summary: DeletedeleteEquipmentIntent3
      description: 'This API deletes an Equipment Intent based on ID.<p>Prerequisite: An Equipment Intent must exist with the given ID.</p>'
      operationId: DeletedeleteEquipmentIntent3
      parameters:
      - name: id
        in: path
        description: The intent ID used for intent lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: ignoreEquipmentProvisioning
        in: query
        description: (Optional) Bypassing equipment provisioning state validation if set to true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: Equipment Intent deleted
          headers: {}
          content: {}
        '404':
          description: Equipment Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Equipment Intent state conflicted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/equipmentIntents:
    get:
      tags:
      - Equipment Intents v3
      summary: GetgetAllEquipmentIntents2
      description: 'The operation is used to fetch all Equipment Intents submitted to the Intent Fulfillment Designer.<p>Prerequisite: At least one Equipment Intent must exist.</p>'
      operationId: GetgetAllEquipmentIntents2
      parameters: []
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponseArray'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Equipment Intents v3
      summary: PostcreateEquipmentIntent2
      description: 'This API validates Equipment Intent attributes, plans Equipment Intent realization for deployment.<p>Prerequisite: The entered Equipment Intent is valid.</p>'
      operationId: PostcreateEquipmentIntent2
      parameters: []
      requestBody:
        description: Equipment Intent as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentIntentRequest'
              - description: Equipment Intent as a JSON Profile wrapper object
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '201':
          description: Equipment Intent is created, Equipment realized and planned
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/equipmentIntents/postUpgrade:
    post:
      tags:
      - Equipment Intents v3
      summary: PostupgradeEquipmentIntents
      description: 'This API validates Equipment Intent attributes, plans Equipment Intent realization for deployment.<p>Prerequisite: The entered Equipment Intent is valid.</p>'
      operationId: PostupgradeEquipmentIntents
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '201':
          description: Equipment Intent is created, Equipment realized and planned
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/equipmentIntents/postUpgrade/projectName:
    post:
      tags:
      - Equipment Intents v3
      summary: PostupgradeEquipmentIntentsProjectName
      description: "This API update Equipment's projectName attribute in NSI based on project ID in Equipment Intent "
      operationId: PostupgradeEquipmentIntentsProjectName
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/equipmentIntents/{id}:
    get:
      tags:
      - Equipment Intents v3
      summary: GetgetEquipmentIntent2
      description: 'Fetches a uniquely identified Equipment Intent.<p>Prerequisite: An Equipment Intent must exist with the given ID.</p>'
      operationId: GetgetEquipmentIntent2
      parameters:
      - name: id
        in: path
        description: The intent ID used for intent lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentIntentResponse'
        '404':
          description: Intent is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/equipmentState/{equipmentId}:
    put:
      tags:
      - Equipment State
      summary: putEquipmentState
      description: Updates equipment state for a service intent
      operationId: putEquipmentState
      parameters:
      - name: equipmentId
        in: path
        description: The equipment id for which state is to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Equipment state request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentStateRequest'
              - description: Equipment state request
        required: false
      responses:
        '204':
          description: Equipment State updated
          headers: {}
          content: {}
        '404':
          description: Equipment not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/equipmentState/{equipmentId}:
    put:
      tags:
      - Equipment State v1
      summary: PutputEquipmentState
      description: Updates equipment state for a service intent
      operationId: PutputEquipmentState
      parameters:
      - name: equipmentId
        in: path
        description: The equipment id for which state is to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Equipment state request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentStateRequest'
              - description: Equipment state request
        required: false
      responses:
        '204':
          description: Equipment State updated
          headers: {}
          content: {}
        '404':
          description: Equipment not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/regenPorts:
    get:
      tags:
      - REGEN PORTS
      summary: getRegenPorts
      description: Get Regen Port by Location of Port or Network Construct Name
      operationId: getRegenPorts
      parameters:
      - name: location
        in: query
        description: 'The location of the resource. (The location of port is of the form: name-shelf-slot-port)'
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: The name of the Resource
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenPortsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Regen Ports Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - REGEN PORTS
      summary: configRegenPorts
      description: "\nNote: when querying by identifiers, the supported syntax of the api is:\n     ?identifierKey=key1,key2,...&identifierValue=value1,value2,...<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"data\": { \n     \"type\": \"regenConfigRequest\",\n     \"regen\": true,\n     \"attributes\": {\n       \"endpoints\": [{ \n         \"networkElement\": {\n           \"name\": <<name>>\n          },\n         \"shelf\": <<shelf>>,\n         \"slot\": <<slot>>,\n         \"port\": <<port>>,\n         \"role\":\"a\"\n        },\n        {\n         \"networkElement\": {\n           \"name\": <<name>>\n          },\n        \"shelf\": <<shelf>>,\n         \"slot\": <<slot>>,\n         \"port\": <<port>>,\n         \"role\":\"z\"\n        } ]\n      }   }}</code></pre>"
      operationId: configRegenPorts
      parameters: []
      requestBody:
        description: Regen Port Configuration Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RegenPortsRequest'
              - description: Regen Port Configuration Request
        required: true
      responses:
        '200':
          description: Regen Port Configured
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenPortsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Entity not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/regenPorts:
    get:
      tags:
      - REGEN PORTS v1
      summary: GetgetRegenPorts
      description: Get Regen Port by Location of Port or Network Construct Name
      operationId: GetgetRegenPorts
      parameters:
      - name: location
        in: query
        description: 'The location of the resource. (The location of port is of the form: name-shelf-slot-port)'
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: The name of the resource
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenPortsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Regen Ports Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - REGEN PORTS v1
      summary: PutconfigRegenPorts
      description: "\nNote: when querying by identifiers, the supported syntax of the api is:\n     ?identifierKey=key1,key2,...&identifierValue=value1,value2,...<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"data\": { \n     \"type\": \"regenConfigRequest\",\n     \"regen\": true,\n     \"attributes\": {\n       \"endpoints\": [{ \n         \"networkElement\": {\n           \"name\": <<name>>\n          },\n         \"shelf\": <<shelf>>,\n         \"slot\": <<slot>>,\n         \"port\": <<port>>,\n         \"role\":\"a\"\n        },\n        {\n         \"networkElement\": {\n           \"name\": <<name>>\n          },\n        \"shelf\": <<shelf>>,\n         \"slot\": <<slot>>,\n         \"port\": <<port>>,\n         \"role\":\"z\"\n        } ]\n      }   }}</code></pre>"
      operationId: PutconfigRegenPorts
      parameters: []
      requestBody:
        description: Regen Port Configuration Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RegenPortsRequest'
              - description: Regen Port Configuration Request
        required: true
      responses:
        '200':
          description: Regen Port Configured
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenPortsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Entity not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/updatedExpectations/{intentId}:
    get:
      tags:
      - Updated Expectations Resource
      summary: getUpdatedExpectations
      description: Gets updated expectations for a given intent id
      operationId: getUpdatedExpectations
      parameters:
      - name: intentId
        in: path
        description: The intent ID used for updated expectations lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatedExpectationsResponse'
      deprecated: false
  /ifd/api/v1/updatedExpectations/{intentId}:
    get:
      tags:
      - Updated Expectations Resource v1
      summary: GetgetUpdatedExpectations
      description: Gets updated expectations for a given intent id
      operationId: GetgetUpdatedExpectations
      parameters:
      - name: intentId
        in: path
        description: The intent ID used for updated expectations lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatedExpectationsResponse'
      deprecated: false
  /ifd/api/controllerParametersSetting:
    get:
      tags:
      - controller Parameters Setting
      summary: getGlobalConstraints
      description: Get controller Parameters Setting
      operationId: getGlobalConstraints
      parameters:
      - name: customerName
        in: query
        description: customer name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalConstraintsRequest'
        '404':
          description: controller Parameters Setting Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - controller Parameters Setting
      summary: configGlobalConstraints
      description: Configures controller Parameters Setting
      operationId: configGlobalConstraints
      parameters: []
      requestBody:
        description: controller Parameters Setting Configuration Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GlobalConstraintsRequest'
              - description: controller Parameters Setting Configuration Request
        required: true
      responses:
        '200':
          description: controller Parameters Setting Configured
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalConstraintsRequest'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - controller Parameters Setting
      summary: deleteGlobalConstraints
      description: 'This API deletes controller Parameters Setting based on customer name<p>Prerequisite: controller Parameters Setting exist with the given customer name.</p>'
      operationId: deleteGlobalConstraints
      parameters:
      - name: customerName
        in: query
        description: customer name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: controller Parameters Setting deleted
          headers: {}
          content: {}
        '404':
          description: controller Parameters Setting not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error controller Parameters Setting
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/controllerParametersSetting:
    get:
      tags:
      - controller Parameters Setting v1
      summary: GetgetGlobalConstraints
      description: Get controller Parameters Setting
      operationId: GetgetGlobalConstraints
      parameters:
      - name: customerName
        in: query
        description: customer name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalConstraintsRequest'
        '404':
          description: controller Parameters Setting Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - controller Parameters Setting v1
      summary: PutconfigGlobalConstraints
      description: controller Parameters Setting
      operationId: PutconfigGlobalConstraints
      parameters: []
      requestBody:
        description: controller Parameters Setting Configuration Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GlobalConstraintsRequest'
              - description: controller Parameters Setting Configuration Request
        required: true
      responses:
        '200':
          description: controller Parameters Setting Configured
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalConstraintsRequestBO'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - controller Parameters Setting v1
      summary: DeletedeleteGlobalConstraints
      description: 'This API deletes controller Parameters Setting based on customer name<p>Prerequisite: controller Parameters Setting must exist with the given customer name.</p>'
      operationId: DeletedeleteGlobalConstraints
      parameters:
      - name: customerName
        in: query
        description: customer name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: controller Parameters Setting deleted
          headers: {}
          content: {}
        '404':
          description: controller Parameters Setting not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error controller Parameters Setting
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/equipmentStaticSpecs:
    get:
      tags:
      - 000 - nsiapiequipmentStaticSpecs
      summary: getEquipmentStaticSpecs
      description: >
        <p>At least one of the following parameters must be specified:<ul><li>networkConstruct.id<li>equipment.id</ul>
      operationId: getEquipmentStaticSpecs
      parameters:
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: equipment.id
        in: query
        description: Equipment identifier
        style: form
        explode: true
        schema:
          type: string
      - name: attributes.cctPackage.cctState
        in: query
        description: '(Optional) Cct State. The allowed values are : IN_PROGRESS, DELETED, COMPLETE, FAILED'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentStaticSpecPlanned, equipmentStaticSpecDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of EquipmentStaticSpecs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentStaticSpecListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the EquipmentStaticSpecs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/equipmentStaticSpecs/{equipmentStaticSpecId}:
    get:
      tags:
      - 000 - nsiapiequipmentStaticSpecs
      summary: getEquipmentStaticSpec
      description: Retrieves a specific equipmentStaticSpec
      operationId: getEquipmentStaticSpec
      parameters:
      - name: equipmentStaticSpecId
        in: path
        description: Identifier of the EquipmentStaticSpec to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentStaticSpecPlanned, equipmentStaticSpecDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipmentStaticSpec.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentStaticSpecRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipmentStaticSpec does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested equipmentStaticSpec.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/equipmentStaticSpecs:
    get:
      tags:
      - 996 - nsiapiv1equipmentStaticSpecs
      summary: GetgetEquipmentStaticSpecs
      description: >
        <p>At least one of the following parameters must be specified:<ul><li>networkConstruct.id<li>equipment.id</ul>
      operationId: GetgetEquipmentStaticSpecs
      parameters:
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: equipment.id
        in: query
        description: Equipment identifier
        style: form
        explode: true
        schema:
          type: string
      - name: attributes.cctPackage.cctState
        in: query
        description: '(Optional) Cct State. The allowed values are : IN_PROGRESS, DELETED, COMPLETE, FAILED'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentStaticSpecPlanned, equipmentStaticSpecDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of EquipmentStaticSpecs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentStaticSpecListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the EquipmentStaticSpecs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/equipmentStaticSpecs/{equipmentStaticSpecId}:
    get:
      tags:
      - 996 - nsiapiv1equipmentStaticSpecs
      summary: getEquipmentStaticSpecById
      description: Equipment Static Spec returned in JSON format
      operationId: getEquipmentStaticSpecById
      parameters:
      - name: equipmentStaticSpecId
        in: path
        description: Equipment static spec identifier
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentStaticSpecPlanned, equipmentStaticSpecDiscovered.'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the equipment static spec.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentStaticSpecRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified equipment static spec
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the equipment static spec
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested equipment static spec.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /geored/site/status:
    get:
      tags:
      - site-status
      summary: Getthecurrentstatusofthegeo-redundantsite
      description: Get the current status of the geo-redundant site
      operationId: Getthecurrentstatusofthegeo-redundantsite
      parameters: []
      responses:
        '200':
          description: JSON description of current site's bootstrap status, georedundancy status, and site ID
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - site-status
      summary: Changetheactivitystateofthegeo-redundantsitetoACTIVE,orchangetheIPaddress.
      description: Perform a failover by changing the state of the site from STANDBY to ACTIVE; or, change the configured IP address of the site. The body of the request should include either the site state OR the site address. Typically these fields will not be changed together.
      operationId: Changetheactivitystateofthegeo-redundantsitetoACTIVE,orchangetheIPaddress.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/body_params'
        required: true
      responses:
        '200':
          description: The site's state has been changed.
          headers: {}
          content: {}
        '400':
          description: Your request was not understood.
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
  /geored/site/remotes:
    get:
      tags:
      - site-remotes
      summary: Getthecurrentremotesiteconfiguration.
      description: Get the current remote site configuration.
      operationId: Getthecurrentremotesiteconfiguration.
      parameters: []
      responses:
        '200':
          description: Returns the list of currently configured remotes.
          headers: {}
          content: {}
        '400':
          description: Your request was misconfigured or invalid.
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - site-remotes
      summary: Addanewremotesite.Thecurrentversionofthisapponlysupports1configuredremote.
      description: Add a new remote site. The current version of this app only supports 1 configured remote.
      operationId: Addanewremotesite.Thecurrentversionofthisapponlysupports1configuredremote.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/remote_site'
        required: true
      responses:
        '201':
          description: The new remote has been created.
          headers: {}
          content: {}
        '400':
          description: Your request was misconfigured or invalid.
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - site-remotes
      summary: Removeanexistingremotesite.
      description: Remove an existing remote site.
      operationId: Removeanexistingremotesite.
      parameters:
      - name: site_id
        in: query
        description: The ID of the configured remote site to remove.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The remote was deleted.
          headers: {}
          content: {}
        '400':
          description: Your request was misconfigured or invalid.
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
  /geored/api/v1/site/remotes/removed:
    get:
      tags:
      - site-remotes
      summary: Getthelast-removedremotesite.
      description: Get the last-removed remote site.
      operationId: Getthelast-removedremotesite.
      parameters: []
      responses:
        '200':
          description: Returns the last-removed remote site.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/site'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/site'
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
  /geored/api/v1/site/remotes/removed/{id}:
    delete:
      tags:
      - site-remotes
      summary: Removealast-removedsitefromthedatastore
      description: Remove a last-removed site from the data store
      operationId: Removealast-removedsitefromthedatastore
      parameters:
      - name: id
        in: path
        description: The site ID of the last-removed remote site to remove.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: The last-removed remote was deleted.
          headers: {}
          content: {}
        '404':
          description: The last-removed remote with the provided site id was not found.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
  /geored/api/v1/site/remotes/recovery/{id}:
    post:
      tags:
      - site-remotes
      summary: Recoverapreviouslyactivesiteasanewstandby.
      description: Recover a previously active site as a new standby.
      operationId: Recoverapreviouslyactivesiteasanewstandby.
      parameters:
      - name: id
        in: path
        description: The ID of the last-removed remote site to recover.
        required: true
        style: simple
        schema:
          type: string
      - name: type
        in: query
        description: The type of recovery to perform. 'hard' purges all data from the recovered site and re-syncs all data; 'soft' retains and reconciles the data on the recovered site.
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/type1361'
          - description: The type of recovery to perform. 'hard' purges all data from the recovered site and re-syncs all data; 'soft' retains and reconciles the data on the recovered site.
      responses:
        '202':
          description: The request for remote recovery has been accepted.
          headers: {}
          content: {}
        '400':
          description: The request was misconfigured or invalid.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '404':
          description: The requested site was not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
    delete:
      tags:
      - site-remotes
      summary: Deleteapreviouslyexecutedsiterecoverytask.
      description: Delete a previously executed site recovery task.
      operationId: Deleteapreviouslyexecutedsiterecoverytask.
      parameters:
      - name: id
        in: path
        description: The site ID of the site that was recovered.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: The site recovery status has been deleted.
          headers: {}
          content: {}
        '404':
          description: A recovery task for the specified site ID was not found.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
    get:
      tags:
      - site-remotes
      summary: Gettherecoverystatus
      description: Get the recovery status
      operationId: Gettherecoverystatus
      parameters:
      - name: id
        in: path
        description: The site ID of the site being recovered.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Returns the current status of the in-progress recovery job.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/siteTask'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/siteTask'
        '404':
          description: The recovery job request id was not found.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
  /geored/api/v1/sites:
    get:
      tags:
      - site-summary
      summary: Getthecurrentstatusofallsitesinthegeo-redundantsystem
      description: Get the current status of all sites in the geo-redundant system
      operationId: Getthecurrentstatusofallsitesinthegeo-redundantsystem
      parameters: []
      responses:
        '200':
          description: JSON description of the site bootstrap status, georedundancy status, and site ID for all sites
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sites'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/sites'
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
  /geored/cluster/status:
    get:
      tags:
      - cluster-status
      summary: Getthecurrentstatusofageo-redundantapplicationcluster.
      description: Get the current status of a geo-redundant application cluster.
      operationId: Getthecurrentstatusofageo-redundantapplicationcluster.
      parameters:
      - name: cluster_name
        in: query
        description: The name of a georedundant aware application, such as `galera` or `datomic`
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Handshake data for cluster.
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - cluster-status
      summary: Changethestatusofageo-redundantapplicationcluster.
      description: Primarily used by applications. It is DANGEROUS for users to post to this endpoint!
      operationId: Changethestatusofageo-redundantapplicationcluster.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/body_params1'
        required: true
      responses:
        '200':
          description: The site's state has been changed.
          headers: {}
          content: {}
        '400':
          description: Your request was misconfigured or invalid.
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
  /geored/cluster/remote-status:
    get:
      tags:
      - cluster-remote-status
      summary: Getthecurrentstatusofageo-redundantapplicationclusteronaremotesite.
      description: Get the current status of a geo-redundant application cluster on a remote site.
      operationId: Getthecurrentstatusofageo-redundantapplicationclusteronaremotesite.
      parameters:
      - name: cluster_name
        in: query
        description: The name of a georedundant aware application, such as `galera` or `datomic`
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: The name of the remote site where the query should be sent.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the handshake data for cluster on the named site.
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
      deprecated: false
  /geored/site/resync:
    post:
      tags:
      - resync
      summary: Requestaresyncofapplicationdata,typicallyperformedafteraprolongedinter-siteoutage.
      description: Request a resync of application data, typically performed after a prolonged inter-site outage.
      operationId: Requestaresyncofapplicationdata,typicallyperformedafteraprolongedinter-siteoutage.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resyncRequest'
        required: true
      responses:
        '202':
          description: The resync request has been accepted
          headers: {}
          content: {}
        '400':
          description: Request body failed validation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '401':
          description: Authorization failed
          headers: {}
          content: {}
        '405':
          description: Method not allowed (POST only)
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: Internal server error; request received and validated but could not be processed
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
  /tron/api/v1/resync:
    post:
      tags:
      - resync
      summary: resync_create
      description: resync
      operationId: resync_create
      parameters: []
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /geored/api/v1/site/activate:
    post:
      tags:
      - activation
      summary: Requesttomakethelocalstandbysiteactive.Thisrequestwillsevertheconnectiontothecurrentactive,anddestroythepairingbetweensites.Theactivesitewillbecomeapreviousactivesitethatmayberecoveredintoastandby
      description: Request to make the local standby site active. This request will sever the connection to the current active, and destroy the pairing between sites. The active site will become a previous active site that may be recovered into a standby
      operationId: Requesttomakethelocalstandbysiteactive.Thisrequestwillsevertheconnectiontothecurrentactive,anddestroythepairingbetweensites.Theactivesitewillbecomeapreviousactivesitethatmayberecoveredintoastandby
      parameters: []
      responses:
        '202':
          description: The request to activate the local standby site has been accepted
          headers: {}
          content: {}
        '403':
          description: Activation can only be done on the standby site
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
    get:
      tags:
      - activation
      summary: Gettheactivationstatus
      description: Get the activation status
      operationId: Gettheactivationstatus
      parameters: []
      responses:
        '200':
          description: Returns the current status of the site activation task
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/siteTask'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/siteTask'
        '404':
          description: The activation task status was not found.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
    delete:
      tags:
      - activation
      summary: Deleteapreviouslyexecutedsiteactivationtask.
      description: Delete a previously executed site activation task.
      operationId: Deleteapreviouslyexecutedsiteactivationtask.
      parameters: []
      responses:
        '204':
          description: The site activation status has been deleted.
          headers: {}
          content: {}
        '404':
          description: An activation task for the local site was not found.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
  /geored/api/v1/site/geo-clean:
    post:
      tags:
      - geo-clean
      summary: De-provisionsanyexistingIPSectunnelconfigurationpresentforthelocalsite'scluster.
      description: De-provisions any existing IPSec tunnel configuration present for the local site's cluster.
      operationId: De-provisionsanyexistingIPSectunnelconfigurationpresentforthelocalsite'scluster.
      parameters: []
      responses:
        '204':
          description: The IPSec tunnel configuration was successfully removed
          headers: {}
          content: {}
        '500':
          description: There was an error processing the request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/requestError'
                - description: Errors that occurred
      deprecated: false
  /gcs/api/v1/config:
    get:
      tags:
      - config
      summary: GetValue
      description: Returns the configuration value specified by URL parameters.
      operationId: GetValue
      parameters:
      - name: application
        in: query
        description: >-
          The application or service to whom this configuration value belongs.

          Can be wildcarded.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: instance
        in: query
        description: >-
          The instance identifier of the application. If not provided, the

          instance will default to the instance agnostic identifier ("-").

          Can be wildcarded.
        style: form
        explode: true
        schema:
          type: string
      - name: partition
        in: query
        description: >-
          The partition to under which the configuration is found.

          Can be wildcarded.
        style: form
        explode: true
        schema:
          type: string
      - name: group
        in: query
        description: >-
          Groupings of configurations within a configuration partition. Used to further sort and identify configurations.

          Can be wildcarded.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: name
        in: query
        description: >-
          The name of the configuration.

          Can be wildcarded.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: tags
        in: query
        description: Only include results that have the listed tags.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: callbacks
        in: query
        description: Include configurations that have callbacks but have not been created. Defaults to false.
        style: form
        explode: true
        schema:
          type: string
      - name: nofailover
        in: query
        description: Used to stop the gcs from returning an instance agnostic configuration if available.  Defaults to false.
        style: form
        explode: true
        schema:
          type: string
      - name: password
        in: query
        description: >-
          The optional password for accessing this configuration

          If the password does not match the configurations password, it will return \******.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Returns the specified configuration(s).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '404':
          description: Could not find the specified configuration.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
    post:
      tags:
      - config
      summary: PostCreateValue
      description: Create the configuration specified.
      operationId: PostCreateValue
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: The configurations to be created.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CreateRequest'
              description: The configurations to be created.
        required: true
      responses:
        '200':
          description: Configuration successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Failed to validate the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
    put:
      tags:
      - config
      summary: OverwriteValue
      description: Create or overwrite the configuration specified.
      operationId: OverwriteValue
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: The configurations to be created.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CreateRequest'
              description: The configurations to be created.
        required: true
      responses:
        '200':
          description: Configuration successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Failed to validate the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
    patch:
      tags:
      - config
      summary: UpdateValue
      description: Update the configuration specified.
      operationId: UpdateValue
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: The configurations to be updated.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateRequest'
              description: The configurations to be updated.
        required: true
      responses:
        '200':
          description: Configuration successfully updated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Failed to validate the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
    delete:
      tags:
      - config
      summary: DeleteValue
      description: >-
        Delete the configuration specified.
         Note: set 'hard' flag to 'true' in request body to completely delete the configuration.
      operationId: DeleteValue
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The configuration has been deleted.
          headers: {}
          content: {}
        '400':
          description: Failed to validate the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
  /gcs/api/v2/config:
    get:
      tags:
      - config_v2
      summary: GetValue1
      description: Returns the configuration value specified by URL parameters.
      operationId: GetValue1
      parameters:
      - name: application
        in: query
        description: >-
          The application or service to whom this configuration value belongs.

          Can be wildcarded.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: instance
        in: query
        description: >-
          The instance identifier of the application. If not provided, the

          instance will default to the instance agnostic identifier ("-").

          Can be wildcarded.
        style: form
        explode: true
        schema:
          type: string
      - name: partition
        in: query
        description: >-
          The partition to under which the configuration is found.

          Can be wildcarded.
        style: form
        explode: true
        schema:
          type: string
      - name: group
        in: query
        description: >-
          Groupings of configurations within a configuration partition. Used to further sort and identify configurations.

          Can be wildcarded.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: name
        in: query
        description: >-
          The name of the configuration.

          Can be wildcarded.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: tags
        in: query
        description: Only include results that have the listed tags.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: callbacks
        in: query
        description: Include configurations that have callbacks but have not been created. Defaults to false.
        style: form
        explode: true
        schema:
          type: string
      - name: nofailover
        in: query
        description: Used to stop the gcs from returning an instance agnostic configuration if available.  Defaults to false.
        style: form
        explode: true
        schema:
          type: string
      - name: password
        in: query
        description: >-
          The optional password for accessing this configuration

          If the password does not match the configurations password, it will return \******.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Returns the specified configuration(s).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
  /nsi/api/groups:
    get:
      tags:
      - 000 - nsiapigroups
      summary: getGroups
      description: '<p>LATEST VERSION: V3<p>It supports the following parameters:<ul><li>offset<li>limit<li>freId</ul>'
      operationId: getGroups
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 groups at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: freId
        in: query
        description: The FRE id to return its Groups
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed value is: groupPlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the group with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 000 - nsiapigroups
      summary: postGroup
      description: >-
        <p>LATEST VERSION: V3<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
              "id": "cf921459-d88c-4bc0-bfaf-6c8115d8ef40",
              "type": "group",
              "attributes": {
                "name": "group",
                "identifiers": "[]",
                "userData": "{}"
              }
            }
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postGroup
      parameters: []
      requestBody:
        description: Request to create/update a group
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupRO'
              - description: Request to create/update a group
        required: true
      responses:
        '201':
          description: group created or updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Invalid data to create or update equipment group.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '500':
          description: Failed to create or update the group.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/groups/{groupId}:
    put:
      tags:
      - 000 - nsiapigroups
      summary: putGroup
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putGroup
      parameters:
      - name: groupId
        in: path
        description: Group identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new Group data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupRO'
              - description: The new Group data
        required: true
      responses:
        '200':
          description: Group with given id has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Bad or invalid parameters were provided.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update group, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/groups/{groupId}/groupPlanned:
    put:
      tags:
      - 000 - nsiapigroups
      summary: putGroupPlanned
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putGroupPlanned
      parameters:
      - name: groupId
        in: path
        description: Group identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new group data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupPlannedRO'
              - description: The new group data
        required: true
      responses:
        '200':
          description: Group planned with given id has been updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupPlannedRO'
        '400':
          description: Bad request. Bad or invalid parameters were provided.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update group planned, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - 000 - nsiapigroups
      summary: patchPlannedGroup
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current group planned resource.<p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "name" : "name of your choice"
                    },
                     "relationships" : {
                        "parentGroup": {
                           "data": [
                             {
                                "type": "group",
                                "id": "p1"
                             }
                          ]
                     }
                }
              }
            ]
        }

        </code></pre><p>Example delete request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "name",
                     "relationships" : {
                        "parentGroup": {
                           "data": [
                             {
                                "type": "group",
                                "id": "p1"
                             }
                          ]
                     }
                }
              }
            ]
        }

        </code></pre><p>Example add request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "add",
                    "attributes" : {
                       "name" : "name of your choice"
                    },
                     "relationships" : {
                        "parentGroup": {
                           "data": [
                             {
                                "type": "group",
                                "id": "p1"
                             }
                          ]
                     }
                }
              }
            ]
        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchPlannedGroup
      parameters:
      - name: groupId
        in: path
        description: The id of the Group to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Group.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupPatchRO'
              - description: A patch request to the given Group.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupPlannedRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/groups/{id}:
    get:
      tags:
      - 000 - nsiapigroups
      summary: getGroupById
      description: '<p>LATEST VERSION: V3'
      operationId: getGroupById
      parameters:
      - name: id
        in: path
        description: Id of the group to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed value is: groupPlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved group successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the specified group(error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapigroups
      summary: removeGroupById
      description: '<p>LATEST VERSION: V3'
      operationId: removeGroupById
      parameters:
      - name: id
        in: path
        description: Id of group
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted the group successfully
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete the specified group (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/groups/{id}/identifiers/{identifierKey}:
    put:
      tags:
      - 000 - nsiapigroups
      summary: updateIdentifier
      description: "<p>LATEST VERSION: V3<p>If present, the leading and trailing whitespaces will be trimmed from the userData's key and value.<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: updateIdentifier
      parameters:
      - name: id
        in: path
        description: ID of group under which to create or update the Identifier
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Identifier that needs to be updated
        content:
          application/json:
            schema:
              type: object
              description: Identifier that needs to be updated
        required: true
      responses:
        '200':
          description: group userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapigroups
      summary: deleteGroupIdentifiers
      description: '<p>LATEST VERSION: V3'
      operationId: deleteGroupIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the group whose identifier is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted group identifier successfully.
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group or identifier does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete group identifier (error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/groups/{id}/userData/{userDataKey}:
    put:
      tags:
      - 000 - nsiapigroups
      summary: PutputEquipmentUserData1
      description: "<p>LATEST VERSION: V3<p>If present, the leading and trailing whitespaces will be trimmed from the userData's key and value.<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: PutputEquipmentUserData1
      parameters:
      - name: id
        in: path
        description: Identifier of group under which to create or update the UserData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of userData to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: true
      responses:
        '200':
          description: group userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified equipment userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapigroups
      summary: deleteGroupUserData
      description: '<p>LATEST VERSION: V3'
      operationId: deleteGroupUserData
      parameters:
      - name: id
        in: path
        description: Identifier of the group whose UserData is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted group userData successfully.
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group or userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete group userData (error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/groups:
    get:
      tags:
      - 999 - nsiapiv3groups
      summary: GetgetGroups
      description: Retrieve groups
      operationId: GetgetGroups
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default value is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: freId
        in: query
        description: The FRE id to return its Groups
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed value is: groupPlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved groups successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListRO'
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve groups(error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 999 - nsiapiv3groups
      summary: PostpostGroup
      description: >-
        <p>LATEST VERSION: V3<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
              "id": "cf921459-d88c-4bc0-bfaf-6c8115d8ef40",
              "type": "group",
              "attributes": {
                "identifiers": "[],"
                "userData": "{}"
              }
            }
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostGroup
      parameters: []
      requestBody:
        description: Request to create a group
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupRO'
              - description: Request to create a group
        required: false
      responses:
        '201':
          description: Group has been created successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/groups/{groupId}:
    put:
      tags:
      - 999 - nsiapiv3groups
      summary: PutputGroup
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutputGroup
      parameters:
      - name: groupId
        in: path
        description: Group identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new Group data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupRO'
              - description: The new Group data
        required: true
      responses:
        '200':
          description: Group with given id has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update group, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/groups/{groupId}/groupPlanned:
    put:
      tags:
      - 999 - nsiapiv3groups
      summary: PutputGroupPlanned
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutputGroupPlanned
      parameters:
      - name: groupId
        in: path
        description: Group identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new group data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupPlannedRO'
              - description: The new group data
        required: true
      responses:
        '200':
          description: Group planned with given id has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Bad or invalid parameters were provided.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update group planned, internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - 999 - nsiapiv3groups
      summary: PatchpatchPlannedGroup
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current group planned resource.<p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "name" : "name of your choice"
                    },
                     "relationships" : {
                        "parentGroup": {
                           "data": [
                             {
                                "type": "group",
                                "id": "p1"
                             }
                          ]
                     }
                }
              }
            ]
        }

        </code></pre><p>Example delete request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "name",
                     "relationships" : {
                        "parentGroup": {
                           "data": [
                             {
                                "type": "group",
                                "id": "p1"
                             }
                          ]
                     }
                }
              }
            ]
        }

        </code></pre><p>Example add request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "add",
                    "attributes" : {
                       "name" : "name of your choice"
                    },
                     "relationships" : {
                        "parentGroup": {
                           "data": [
                             {
                                "type": "group",
                                "id": "p1"
                             }
                          ]
                     }
                }
              }
            ]
        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchPlannedGroup
      parameters:
      - name: groupId
        in: path
        description: The id of the Group to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Group.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GroupPatchRO'
              - description: A patch request to the given Group.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupPlannedRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/groups/{id}:
    get:
      tags:
      - 999 - nsiapiv3groups
      summary: GetgetGroupById
      description: Retrieve group with specified id
      operationId: GetgetGroupById
      parameters:
      - name: id
        in: path
        description: Id of group
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed value is: groupPlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved group successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the specified group(error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 999 - nsiapiv3groups
      summary: DeleteremoveGroupById
      description: Delete a group with given id
      operationId: DeleteremoveGroupById
      parameters:
      - name: id
        in: path
        description: Id of group
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted the group successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete the specified group (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/groups/{id}/identifiers/{identifierKey}:
    put:
      tags:
      - 999 - nsiapiv3groups
      summary: PutupdateIdentifier
      description: Creates or updates an identifier to a given group
      operationId: PutupdateIdentifier
      parameters:
      - name: id
        in: path
        description: ID of group under which to create or update the Identifier
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: identifier
        content:
          application/json:
            schema:
              type: object
              description: identifier
        required: false
      responses:
        '200':
          description: Group userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 999 - nsiapiv3groups
      summary: DeletedeleteGroupIdentifiers
      description: Delete an identifier from a given group
      operationId: DeletedeleteGroupIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the group whose identifier is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted the Group.
          headers: {}
          content: {}
        '204':
          description: Deleted group identifier successfully.
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group or identifier does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete group identifier (error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/groups/{id}/userData/{userDataKey}:
    put:
      tags:
      - 999 - nsiapiv3groups
      summary: updateUserData
      description: Creates or updates UserData to a given group
      operationId: updateUserData
      parameters:
      - name: id
        in: path
        description: Identifier of group under which to create or update the UserData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: false
      responses:
        '200':
          description: Group userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 999 - nsiapiv3groups
      summary: DeletedeleteGroupUserData
      description: Delete an userData from a given group
      operationId: DeletedeleteGroupUserData
      parameters:
      - name: id
        in: path
        description: Identifier of the group whose UserData is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted the Group.
          headers: {}
          content: {}
        '204':
          description: Deleted group userData successfully.
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified group or userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete group userData (error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /inventory-history/v1/query/{serviceId}:
    get:
      tags:
      - inventory-historyv1query
      summary: getEntriesForServiceId
      description: >-
        <h1>Filtering</h1>


        <p>Available filters are provided in the response, they can be provided in the request as GET parameters.<br>

        Multiple filters can be comma separated or passed in individually eg ?filter[key][]=value1&filter[key][]=value2& ...</p>
      operationId: getEntriesForServiceId
      parameters:
      - name: serviceId
        in: path
        description: Identifier of the service to be retrieved.
        required: true
        style: simple
        schema:
          type: string
      - name: from
        in: query
        description: 'From date specified in RFC3339 format.<p>**Example**: _2021-01-19_'
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: to
        in: query
        description: 'To date specified in RFC3339 format.<p>**Example**: _2021-04-19_'
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: filter_category
        in: query
        description: '(Optional) Category filter values as a comma separated list. Filter values are provided in the response.<p>**Example**: foo, bar'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter_eventName
        in: query
        description: '(Optional) Event filter values as a comma separated list. Filter values are provided in the response.<p>**Example**: foo, bar'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter_userName
        in: query
        description: '(Optional) User filter values as a comma separated list. Filter values are provided in the response.<p>**Example**: foo, bar'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: page
        in: query
        description: '(Optional) Offset for the next page of results.<p>**Example**: _10_'
        style: form
        explode: true
        schema:
          type: string
      - name: resultsPerPage
        in: query
        description: '(Optional) Limit the number of services present in a page.<p>**Example**: _100_'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Successfully retrieved the list of events.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ServiceEventsQueryResponseRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEventsQueryResponseRO'
        '400':
          description: Missing mandatory parameter.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: A server error occurred.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /inventory-history/v1/query/{serviceId}/timeline:
    get:
      tags:
      - inventory-historyv1query
      summary: getServiceEventCounts
      description: Retrieves weekly counts of events for a given service from today to the configured maximum retention period
      operationId: getServiceEventCounts
      parameters:
      - name: serviceId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Successfully retrieved the timeline for the service.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ServiceEventsQueryResponseRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEventsQueryResponseRO'
        '500':
          description: A server error occured.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /inventory-history/v1/query/{serviceId}/{eventId}/{week}:
    get:
      tags:
      - inventory-historyv1query
      summary: getServiceEvent
      description: Retrieves detailed information on a specific service event, the eventId and week can be obtailed from the timeline or search APIs
      operationId: getServiceEvent
      parameters:
      - name: serviceId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: eventId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: week
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Successfully retrieved the timeline for the service.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ServiceEventsQueryResponseRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEventsQueryResponseRO'
        '500':
          description: A server error occured.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/search/srlgAutoAssignableResources:
    get:
      tags:
      - SRLG
      summary: getSrlgAssignableEntities1
      description: 'List of assignable entities returned in JSON format.<ul><li>Entity Type i.e. fres,networkConstructs,equipments<li>riskType (RiskTypes can be found from : GET /nsi/api/srlgformat/srlgFormatMappings?type=riskType)</ul>'
      operationId: getSrlgAssignableEntities1
      parameters:
      - name: entityType
        in: query
        description: entityType i.e. fres,networkConstructs,equipments
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: riskType
        in: query
        description: RiskType defined as in SrlgFormat
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructId
        in: query
        description: Id of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page.
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: Successfully retrieved the requested assignable entities.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the assignable entities.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/search/srlgAutoAssignableResources:
    get:
      tags:
      - SRLG
      summary: getSrlgAssignableEntities11
      description: 'List of assignable entities returned in JSON format.<ul><li>Entity Type i.e. fres,networkConstructs,equipments<li>riskType (RiskTypes can be found from : GET /nsi/api/srlgformat/srlgFormatMappings?type=riskType)</ul>'
      operationId: getSrlgAssignableEntities11
      parameters:
      - name: entityType
        in: query
        description: entityType i.e. fres,networkConstructs,equipments
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: riskType
        in: query
        description: RiskType defined as in SrlgFormat
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructId
        in: query
        description: Id of NetworkConstruct
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page.
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: Successfully retrieved the requested assignable entities.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the assignable entities.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /ifd/api/srlg:
    get:
      tags:
      - SRLG
      summary: getSRLG1
      description: '<p>LATEST VERSION: V3<br/><h3>Description:</h3><p>This API provides functionality to get the details of srlg on resources using different parameters.</p><br/>'
      operationId: getSRLG1
      parameters:
      - name: resourceId
        in: query
        description: Id of the Resource whose details needs to be searched
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: 'Resource Type: fres, networkConstructs, equipments, tpes values.'
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: isStructured
        in: query
        description: 'Is Structured: (Y or N) Srlg Values needs to be shown in Structured Form or not'
        style: form
        explode: true
        schema:
          type: string
      - name: plannedStartTime
        in: query
        description: Fetch SRLG set on the basis of time.
        style: form
        explode: true
        schema:
          type: string
      - name: srlgType
        in: query
        description: 'Filter on types of Srlgs to limit search.Values could be: auto,manual,inherited,combined,propagated, discovered.In addition manualShare, propagatedShare or combinedShare can also be used for NetworkConstructs.'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgIntentResponseV3'
        '404':
          description: SRLG not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - SRLG
      summary: triggerAssignmentOp1
      description: >+
        <p>LATEST VERSION: V2

        <h3>Description :</h3><p>This request is intended for SRLG(s) Batch Operations.<br/>AutoAssignment ,Clear AutoAssignment ,Propagation ,WriteToNetwork ,Supported6500Version,PropagateShareSrlg ,ClearPropgatedShareSrlg ,Audit & Reconcile of Fb Profile, Clear Manual Assignment. API returns Job Id in response which can be used to track the job status.</p><br/><p><h3>Schema Description :</h3><strong>op: </strong>Operation (auto_assign,clear_auto_assign,propagate,write_to_network,propagate_share_srlg,clear_propagated_share_srlg,audit_fb_profile,clear_manual_assign)<br/><strong>resourceType: </strong> fres, networkConstructs, equipment/equipments,tpes <br/><strong>resourceTypes: </strong> fres, networkConstructs, equipment/equipments,tpes (comma separated, only for clear_manual_assign) <br/><strong>resourceId: </strong> Id of the resource<br/><strong>resourceName: </strong> Name of resource<br/><strong>riskType: </strong> Add/Drop Bank,ROADM Degree,etc<br/><strong>region: </strong> Subnetwork/region for which operation needs to be carried out<br/><strong>subNetwork: </strong> SubNetwork for which operation needs to be carried out<br/><strong>opaque: </strong> Opaque SRLG value (only used for clear_manual_assign)<br/><strong>structured: </strong> Structured SRLG value (only used for clear_manual_assign)<br/></p><br/><p>Here are some example requests:</p>


        ```json

        AUTO-ASSIGNMENT


        {
          "data": {
              "op": "auto_assign",
            "attributes": {
              "resourceType": "networkConstructs"
            }
          }
        }


        CLEAR-AUTOASSIGNMENT


        {
          "data": {
              "op": "clear_auto_assign",
            "attributes": {
              "resourceType": "networkConstructs"
            }
          }
        }


        PROPAGATION


        {
          "data": {
              "op": "propagate",
            "attributes": {
              "resourceId": "8188858458035332238",
              "resourceType": "fres"
            }
          }
        }


        WRITE TO NETWORK


        {
          "data": {
              "op": "write_to_network",
            "attributes": {
              "resourceId": "f1a543f5-a2c5-349b-85dd-e298fcf716e4",
              "resourceType": "networkConstructs"
            }
          }
        }


        PROPAGATE SHARE SRLG


        {
          "data": {
            "op": "propagate_share_srlg",
            "attributes": {
              "resourceType": "networkConstructs",
              "resourceId": "string",
             "resourceName": "string",
              "region": "string"
            }
          }
        }


        CLEAR PROPAGATED SHARE SRLG


        {
          "data": {
            "op": "clear_propagated_share_srlg",
            "attributes": {
              "resourceType": "networkConstructs",
              "resourceId": "string",
             "resourceName": "string",
              "region": "string"
            }
          }
        }


        AUDIT & RECONCILE OF FB PROFILES


        {
          "data": {
            "op": "audit_fb_profile",
            "attributes": {
              "resourceType": "networkConstructs",
              "resourceId": "string",
             "resourceName": "string",
              "region": "string"
             "reconcile": true
            }
          }
        }


        CLEAR MANUAL ASSIGNMENT


        {
          "data": {
            "op": "clear_manual_assign",
            "attributes": {
              "resourceTypes": "networkConstructs,fres,tpes,equipments",
              "region": "string",
              "opaque": "string",
              "structured": {
                 "riskType": "External Risk",
                 "Region": "Subnetwork1"
                 "riskValue": "1"
               }
            }
          }
        }

      operationId: triggerAssignmentOp1
      parameters: []
      requestBody:
        description: SRLG Assignment Job request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgManualOpRequest'
              - description: SRLG Assignment Job request
        required: true
      responses:
        '202':
          description: SRLG Job Triggered.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgJobStatusBO'
        '423':
          description: Another SRLG Job is already running.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - SRLG
      summary: putSRLG1
      description: >-
        <p>LATEST VERSION: V2

        <h3>Description:</h3><p>This API is intended for manual input of SRLG(s) on resources.<br/><h3>Description of the Schema:<br/></h3>Minimally following attributes need to be provided.</p><br/><p><strong>resourceId:</strong>  Id of the resource<br/><strong>resourceType:</strong> fres, networkConstructs, equipment/equipments, tpes <br/><strong>srlgSet:</strong> Is an object of plannedStartDate and manual srlg object. The date format is ie. “YYYY-MM-DDTHH:MM:SS.SSSZ”</p><br/><p>Here is an example request:</p>


        ```json

        {
          "data": {
            "attributes": {
              "resourceId": "2000925292613460342",
              "resourceType": "fres",
              "srlgSet": [
                {
                  "manual": {
                    "srlgStructuredValues": [
                      {
                        "subNetwork": "NewYorkRegion",
                        "riskType": "Conduit",
                        "riskValue": 80023
                      }
                    ]
                  }
                },
                {
                  "plannedStartDate": "2018-09-26T10:30:01.607413Z",
                  "manual": {
                    "srlgValues": [
                      "59520495"
                    ]
                  }
                }
              ]
            }
          }
        }
      operationId: putSRLG1
      parameters: []
      requestBody:
        description: SRLG request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgIntentRequestV2'
              - description: SRLG request
        required: true
      responses:
        '200':
          description: SRLG updated
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '404':
          description: Entity not found
          headers: {}
          content: {}
        '500':
          description: Internal system error
          headers: {}
          content: {}
      deprecated: false
  /ifd/api/srlg/associatedSrlgs:
    get:
      tags:
      - SRLG
      summary: getSrlgAssociations1
      description: >-
        <p>LATEST VERSION: V3

        <h3>Description:</h3><br/><p>Following API provides details of SRLGs associated with given resource.Filters can be used to get details.</p><br/>
      operationId: getSrlgAssociations1
      parameters:
      - name: resourceId
        in: query
        description: Id of the Resource for which associated SRLG details are to be fetched
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: Resource Type for which associated SRLG details are to be fetched (fres,networkConstructs,equipments,tpes values)
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: srlgSource
        in: query
        description: Filter on types of Srlgs to limit search on association (auto,manual,propagated,discovered,manualShare,propagatedShare,discoveredShare values). If nothing is given, search will return on all possible values.
        style: form
        explode: true
        schema:
          type: string
      - name: includeMetaData
        in: query
        description: Indicate if metadata for filters need to be included
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Associated SRLGs details returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociatedSrlgsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlg/externalSRLGs:
    get:
      tags:
      - SRLG
      summary: getExternalSrlgsfromLabel1
      description: >-
        <p>LATEST VERSION: V2

        <h3>Description:</h3><br/><p>This API can be used to query external assigned Srlgs assigned from pool.If no parameters are given.It will retrieve all records.</p><br/>
      operationId: getExternalSrlgsfromLabel1
      parameters:
      - name: userLabel
        in: query
        description: Label used for reference while assigning SRLG
        style: form
        explode: true
        schema:
          type: string
      - name: isStructured
        in: query
        description: isStructured (Y/N) Srlg Values needs to be shown in Structured Form or not
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: offset
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: limit
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: External SRLGs returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlgList'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: External SRLGs not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - SRLG
      summary: triggerExternalPoolOp1
      description: >+
        <p>LATEST VERSION: V2

        <h3>Description :</h3><p>This request is intended for External SRLG Pool Operations(Assign and Release External Srlg From Pool)</p><br/><h3>Description of the Schema:</h3><p><strong>op :</strong>Type of Operation (assign_external_srlg, release_external_srlg)<br/><strong>label :</strong> Any label used for reference<br/><strong>riskType :</strong> One of the RiskType Value given while setting SRLG Format <br/><strong>Region :</strong> Region for Srlg Value (Subnetwork)<br/><strong>id :</strong> Id for SRLG Value to release<br/></p><br/><p>Here are some example requests:</p>


        ```json

        GET AVAILABLE SRLG VALUE :-


        {
          "data": {
              "op": "assign_external_srlg",
              "type": "externalSRLGs",
            "attributes": {
              "label": "User_Label",
            "srlgFields": {
              "riskType": "External Risk",
              "Region": "Subnetwork1"
            }
            }
          }
        }


        RELEASE SRLG VALUE :-


        {
          "data": {
              "op": "release_external_srlg",
              "type": "externalSRLGs",
            "attributes": {
              "id": "srlgValue"
            }
          }
        }

      operationId: triggerExternalPoolOp1
      parameters: []
      requestBody:
        description: SRLG External Pool Operation Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ExternalSrlgPoolRequest'
              - description: SRLG External Pool Operation Request
        required: true
      responses:
        '201':
          description: SRLG Pool Assigned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlg'
        '202':
          description: SRLG Pool Release/ Reset Job Triggered
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlgPoolResetResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlg/externalSRLGs/{extSRLGId}:
    get:
      tags:
      - SRLG
      summary: getExternalSrlgFromId1
      description: >-
        <p>LATEST VERSION: V2

        <h3>Description:</h3><br/><p>This API provides functionality to query for specific External srlg value.</p><br/>
      operationId: getExternalSrlgFromId1
      parameters:
      - name: extSRLGId
        in: path
        description: External Srlg Value
        required: true
        style: simple
        schema:
          type: string
      - name: isStructured
        in: query
        description: isStructured (Y/N)  Srlg Values needs to be shown as structured or not.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: External SRLGs returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlg'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: External SRLGs not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlg/job/status:
    get:
      tags:
      - SRLG
      summary: jobOpStatus1
      description: >-
        <p>LATEST VERSION: V3

        <h3>Description:</h3><br/><p>This API provides functionality to get the Srlg Batch Operation's jobs status using different parameters.</p><br/><strong>*Provide atleast one of the following Parameters*</strong><p><ul><li>JobType<br/></li><li>JobId<br/></li><li>JobStatus<br/></li></ul><br/></p><br/>
      operationId: jobOpStatus1
      parameters:
      - name: jobId
        in: query
        description: Id of Job/Srlg Operation
        style: form
        explode: true
        schema:
          type: string
      - name: jobType
        in: query
        description: 'Type of Job/Srlg Operation.Values could be: auto_assign,clear_auto_assign,write_to_network,propagate,assign_external_srlg, release_external_srlg, propagate_share_srlg, clear_propagated_share_srlg, audit_fb_profile, clear_manual_assign.'
        style: form
        explode: true
        schema:
          type: string
      - name: jobStatus
        in: query
        description: 'Status of Job/Srlg Operation.Values could be: in_progress,completed,failed.'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgJobResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/srlg/job/{jobId}/details:
    get:
      tags:
      - SRLG
      summary: jobOpStatusDetails1
      description: >-
        <p>LATEST VERSION: V2

        <h3>Description:</h3><br/><p>This API provides details about the srlg job operation status.Job id obtained from batch operation response needs to be used for tracking srlg operation.</p><br/>
      operationId: jobOpStatusDetails1
      parameters:
      - name: jobId
        in: path
        description: Id of Job/Srlg Operation for which details needs to be searched
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgManualJobDetailsOpResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/srlg/srlgMismatch:
    get:
      tags:
      - SRLG
      summary: getSrlgMismatchResources1
      description: >-
        <p>LATEST VERSION: V3

        <h3>Description:</h3><br/><p>This API helps to query about the mismatch of Srlg Values present on resources.<br/></p><br/>
      operationId: getSrlgMismatchResources1
      parameters:
      - name: ncId
        in: query
        description: NetworkConstruct id for which srlg mismatched resource to be found.No value indicates find for all NetworkConstructs
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: 'Allowed value : fres'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/resourceType71'
          - description: 'Allowed value : fres'
      - name: resourceId
        in: query
        description: resourceId if in particular
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgMismatchResponseV2'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlg/srlgMismatch/{mismatchId}/details:
    get:
      tags:
      - SRLG
      summary: getSrlgMismatchDetails1
      description: <h3>Description:</h3><br/><p>SRLG mismatch details<br/></p><br/>
      operationId: getSrlgMismatchDetails1
      parameters:
      - name: mismatchId
        in: path
        description: Srlg mismatch Id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgMismatchResponseV2'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlg/{srlgValue}/assignmentDetails:
    get:
      tags:
      - SRLG
      summary: getResourcesFromSrlgValue1
      description: >-
        <p>LATEST VERSION: V3

        <h3>Description:</h3><br/><p>This API provides search capability to search resources for Srlg Values assigned on them.Different filters can be used to get details.</p><br/>
      operationId: getResourcesFromSrlgValue1
      parameters:
      - name: srlgValue
        in: path
        description: SrlgValue for which search is to be performed
        required: true
        style: simple
        schema:
          type: string
      - name: srlgSource
        in: query
        description: Type of assignment (manual,auto,inherited,propagated,discovered,manualShare,propagatedShare). If no value provided lookup will be done for all types.
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: Resource types on which SRLG assignment to be searched (fres,tpes,networkConstructs,equipments). If no value provided lookup will be done for all types.
        style: form
        explode: true
        schema:
          type: string
      - name: includeMetaData
        in: query
        description: Indicate if metadata for filters need to be included
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignmentDetailsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/search/equipment:
    get:
      tags:
      - equipment
      summary: searchEquipment
      description: >-
        List of equipment returned in JSON format.

        Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchEquipment
      parameters:
      - name: id
        in: query
        description: (Optional) List of equipment Ids. NA results in all Equipments with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentName
        in: query
        description: (Optional) List of equipment Names.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.siteName). If provided, must also provide searchText parameter
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of resource states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: networkConstruct.name
        in: query
        description: (Optional) Network Construct name. NA results in all Equipments with no NC name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalNeName
        in: query
        description: (Optional) Network Construct name. NA results in all Equipments with no NC name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. NA results in all Equipments with no NC id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on equipment utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on equipment utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.utilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on equipment used by service utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on equipment used by service utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.utilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment used by service utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment used by service start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment used by service end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: services.utilizationServiceTotal
        in: query
        description: (Optional) Allow filtering on total of Transport and Packet services using the equipment
        style: form
        explode: true
        schema:
          type: string
      - name: services.utilizationInfrastructureTotal
        in: query
        description: (Optional) Allow filtering on total of Transport and Packet Infrastructure using the equipment
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier. NA results in all Equipments with no intent id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteId
        in: query
        description: (Optional) Site Identifier for equipment. NA results in all Equipments with no site id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: '(Optional) Comma separated list of equipment states. NA results in all Equipments with no state. NOT query is supported. The allowed state values are: IS, OOS, OOS_AU, OOS_MA, OOS_AUMA'
        style: form
        explode: true
        schema:
          type: string
      - name: displayState
        in: query
        description: '(Optional) List of equipment displayState values. NA results in all Equipments with no display state. NOT query is supported. The allowed display state values are: IS, OOS, OOS-AU, OOS-MA, OOS-AUMA'
        style: form
        explode: true
        schema:
          type: string
      - name: shelf
        in: query
        description: (Optional) Comma separated list of equipment shelves. NA results in all Equipments with no shelf. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: slot
        in: query
        description: (Optional) Comma separated list of equipment slots. NA results in all Equipments with no slot. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subSlot
        in: query
        description: (Optional) Comma separated list of equipment sub-slots. NA results in all Equipments with no subslot. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subsubSlot
        in: query
        description: (Optional) Comma separated list of equipment sub-sub-slots. NA results in all Equipments with no subsubslot. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subShelf
        in: query
        description: (Optional) Comma separated list of equipment sub-shelves. NA results in all Equipments with no subshelf. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: availabilityState
        in: query
        description: '(Optional) List of Equipment availabilityState. NA results in all Equipments with no availabilityState. NOT query is supported. The allowed availabilityState values are: PLANNED, AVAILABLE, UNVALIDATED, INUSE'
        style: form
        explode: true
        schema:
          type: string
      - name: displayAvailabilityState
        in: query
        description: '(Optional) List of equipment displayAvailabilityState values. NA results in all Equipments with no displayAvailabilityState. NOT query is supported. The allowed displayAvailabiltyState values are: Planned, Unvalidated, Available, In use'
        style: form
        explode: true
        schema:
          type: string
      - name: reservationState
        in: query
        description: '(Optional) List of Equipment reservationState. NA results in all Equipments with no reservationState. NOT query is supported. The allowed reservationState values are: Unknown, Not reserved, Reserved for maintenance, Reserved for facility, Reserved for reversion'
        style: form
        explode: true
        schema:
          type: string
      - name: maintenanceMode
        in: query
        description: '(Optional) List of Equipment maintenanceMode. NA results in all Equipments with no maintenanceMode. NOT query is supported. The allowed maintenanceMode values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: cardType
        in: query
        description: (Optional) List of Equipment cardType. NA results in all Equipments with no cardType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: provisionedSpec.partNumber
        in: query
        description: (Optional) List of Equipment provisionedSpec.partNumber. NA results in all Equipments with no provisionedSpecPartNumber. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: specificationMismatch
        in: query
        description: '(Optional) List of Equipment specificationMismatch. NA results in all Equipments with no specificationMismatch. NOT query is supported. The allowed specificationMismatch values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: category
        in: query
        description: '(Optional) List of Equipment category. NA results in all Equipments with no category. NOT query is supported. The allowed category values are: rack, shelf, pluggable, standalone'
        style: form
        explode: true
        schema:
          type: string
      - name: neContactState
        in: query
        description: '(Optional) List of neContactState. NA results in all Equipments with no neContactState. NOT query is supported. The allowed neContactState values are: IN, OUT'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.macAddress
        in: query
        description: (Optional) Network Construct macAddress. NA results in all Equipments with no ncMacAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.subnetName
        in: query
        description: (Optional) Network Construct subnetName. NA results in all Equipments with no ncSubnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: projectName
        in: query
        description: (Optional) Project name. NA results in all Equipments with no projectName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) List of srlg values separated by comma. NA results in all Equipments with no srlg. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: secondaryState
        in: query
        description: (Optional) List of secondary state.
        style: form
        explode: true
        schema:
          type: string
      - name: serial
        in: query
        description: (Optional) List of serial.
        style: form
        explode: true
        schema:
          type: string
      - name: customer
        in: query
        description: (Optional) List of customer.
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: equipmentsWithSrlg, equipmentsLookupByName'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: 'namedQueryParam1 must be provided for namedQuery: equipmentsLookupByName'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: specificationMismatch, state, availabilityState, reservationState, maintenanceMode, cardType, category, ncMacAddress, ncSubnetName, projectName, displayAvailabilityState, displayState, equipped.utilizationTotalCapacity, equipped.utilizationUsedCapacity, equipped.utilizationPercent, inUseByService.utilizationTotalCapacity, inUseByService.utilizationUsedCapacity, inUseByService.utilizationPercent, services.utilizationServiceTotal, services.utilizationInfrastructureTotal, shelf, subShelf, slot, subSlot, subsubSlot, equipmentName, secondaryState, provisionedSpec.partNumber, provisionedSpec.serialNumber, customer'
        style: form
        explode: true
        schema:
          type: string
      - name: metaLimit
        in: query
        description: (Optional)  Size of metadata returned
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, planned, discovered, networkConstructs, srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/search/equipment:
    get:
      tags:
      - equipment
      summary: searchEquipmentV1
      description: >-
        List of equipment returned in JSON format.

        Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchEquipmentV1
      parameters:
      - name: id
        in: query
        description: (Optional) List of equipment Ids. NA results in all Equipments with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentName
        in: query
        description: (Optional) List of equipment Names.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.siteName). If provided, must also provide searchText parameter
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of resource states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: networkConstruct.name
        in: query
        description: (Optional) Network Construct name. NA results in all Equipments with no NC name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalNeName
        in: query
        description: (Optional) Network Construct name. NA results in all Equipments with no NC name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. NA results in all Equipments with no NC id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on equipment utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on equipment utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.utilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equipped.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on equipment used by service utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on equipment used by service utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.utilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment used by service utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment used by service start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByService.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on equipment used by service end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: services.utilizationServiceTotal
        in: query
        description: (Optional) Allow filtering on total of Transport and Packet services using the equipment
        style: form
        explode: true
        schema:
          type: string
      - name: services.utilizationInfrastructureTotal
        in: query
        description: (Optional) Allow filtering on total of Transport and Packet Infrastructure using the equipment
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier. NA results in all Equipments with no intent id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteId
        in: query
        description: (Optional) Site Identifier for equipment. NA results in all Equipments with no site id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: '(Optional) Comma separated list of equipment states. NA results in all Equipments with no state. NOT query is supported. The allowed state values are: IS, OOS, OOS_AU, OOS_MA, OOS_AUMA'
        style: form
        explode: true
        schema:
          type: string
      - name: displayState
        in: query
        description: '(Optional) List of equipment displayState values. NA results in all Equipments with no display state. NOT query is supported. The allowed displayState values are: IS, OOS, OOS-AU, OOS-MA, OOS-AUMA'
        style: form
        explode: true
        schema:
          type: string
      - name: shelf
        in: query
        description: (Optional) Comma separated list of equipment shelves. NA results in all Equipments with no shelf. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: slot
        in: query
        description: (Optional) Comma separated list of equipment slots. NA results in all Equipments with no slot. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subSlot
        in: query
        description: (Optional) Comma separated list of equipment sub-slots. NA results in all Equipments with no subslot. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subsubSlot
        in: query
        description: (Optional) Comma separated list of equipment sub-sub-slots. NA results in all Equipments with no subsubslot. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subShelf
        in: query
        description: (Optional) Comma separated list of equipment sub-shelves. NA results in all Equipments with no subshelf. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: availabilityState
        in: query
        description: '(Optional) List of Equipment availabilityState. NA results in all Equipments with no availabilityState. NOT query is supported. The allowed availabilityState values are: PLANNED, AVAILABLE, UNVALIDATED, INUSE'
        style: form
        explode: true
        schema:
          type: string
      - name: displayAvailabilityState
        in: query
        description: '(Optional) List of equipment displayAvailabilityState values.NA results in all Equipments with no displayAvailabilityState. NOT query is supported.  The allowed displayAvailabilityState values are: Planned, Unvalidated, Available, In use'
        style: form
        explode: true
        schema:
          type: string
      - name: reservationState
        in: query
        description: '(Optional) List of Equipment reservationState. NA results in all Equipments with no reservationState. NOT query is supported. The allowed reservationState values are: Unknown, Not reserved, Reserved for maintenance, Reserved for facility, Reserved for reversion'
        style: form
        explode: true
        schema:
          type: string
      - name: maintenanceMode
        in: query
        description: '(Optional) List of Equipment maintenanceMode. NA results in all Equipments with no maintenanceMode. NOT query is supported.  The allowed maintenanceMode values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: cardType
        in: query
        description: (Optional) List of Equipment cardType. NA results in all Equipments with no cardType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: provisionedSpec.partNumber
        in: query
        description: (Optional) List of Equipment provisionedSpec.partNumber. NA results in all Equipments with no provisionedSpecPartNumber. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: specificationMismatch
        in: query
        description: '(Optional) List of Equipment specificationMismatch. NA results in all Equipments with no specificationMismatch. NOT query is supported. The allowed specificationMismatch values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: category
        in: query
        description: '(Optional) List of Equipment category. NA results in all Equipments with no category. NOT query is supported. The allowed category values are: rack, shelf, pluggable, standalone'
        style: form
        explode: true
        schema:
          type: string
      - name: neContactState
        in: query
        description: '(Optional) List of neContactState. NA results in all Equipments with no neContactState. NOT query is supported. The allowed neContactState values are: IN, OUT'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.macAddress
        in: query
        description: (Optional) Network Construct macAddress. NA results in all Equipments with no ncMacAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.subnetName
        in: query
        description: (Optional) Network Construct subnetName. NA results in all Equipments with no ncSubnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: projectName
        in: query
        description: (Optional) Project name. NA results in all Equipments with no projectName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) List of srlg values separated by comma. NA results in all Equipments with no srlg. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: secondaryState
        in: query
        description: (Optional) List of secondary state.
        style: form
        explode: true
        schema:
          type: string
      - name: serial
        in: query
        description: (Optional) List of serial.
        style: form
        explode: true
        schema:
          type: string
      - name: customer
        in: query
        description: (Optional) List of customer.
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: equipmentsWithSrlg, equipmentsLookupByName'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: 'namedQueryParam1 must be provided for namedQuery: equipmentsLookupByName, equipmentsLookupByName'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: specificationMismatch, state, availabilityState, reservationState, maintenanceMode, cardType, category, ncMacAddress, ncSubnetName, projectName, displayAvailabilityState, displayState, equipped.utilizationTotalCapacity, equipped.utilizationUsedCapacity, equipped.utilizationPercent, inUseByService.utilizationTotalCapacity, inUseByService.utilizationUsedCapacity, inUseByService.utilizationPercent, services.utilizationServiceTotal, services.utilizationInfrastructureTotal, shelf, subShelf, slot, subSlot, subsubSlot, equipmentName, secondaryState, provisionedSpec.partNumber, provisionedSpec.serialNumber, customer'
        style: form
        explode: true
        schema:
          type: string
      - name: metaLimit
        in: query
        description: (Optional) Size of metadata returned
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, planned, discovered, networkConstructs, srlgss, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested equipment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/search/equipmentGroups:
    get:
      tags:
      - equipmentGroups
      summary: searchEquipmentGroups
      description: >2-

        Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchEquipmentGroups
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of Equipment group identifiers to retrieve. NA results in all EquipmentGroups with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. NA results in all EquipmentGroups with no ncId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) Equipment group name. NA results in all EquipmentGroups with no name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: (Optional) List of Equipment group type. NA results in all EquipmentGroups with no type. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subType
        in: query
        description: (Optional) List of Equipment group sub type. NA results in all EquipmentGroups with no subType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipment.id
        in: query
        description: (Optional) Comma separated list of equipment identifiers. NA results in all EquipmentGroups with no equipmentIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentGroupExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier. NA results in all EquipmentGroups with no intentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of resource states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: type, subType'
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, networkConstructs, discovered, planned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment groups with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/search/equipmentGroups:
    get:
      tags:
      - equipmentGroups
      summary: searchEquipmentGroupsV1
      description: >2-

        Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchEquipmentGroupsV1
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of Equipment group identifiers to retrieve. NA results in all EquipmentGroups with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. NA results in all EquipmentGroups with no ncId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) Equipment group name. NA results in all EquipmentGroups with no name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: (Optional) List of Equipment group type. NA results in all EquipmentGroups with no type. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: subType
        in: query
        description: (Optional) List of Equipment group sub type. NA results in all EquipmentGroups with no subType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipment.id
        in: query
        description: (Optional) Comma separated list of equipment identifiers. NA results in all EquipmentGroups with no equipmentIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentGroupExpectations.equipmentIntent.id
        in: query
        description: (Optional) Equipment Intent Identifier. NA results in all EquipmentGroups with no intentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of resource states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: type, subType'
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, networkConstructs, discovered, planned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGroupListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query param was specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the equipment groups with given query parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/search/fres:
    get:
      tags:
      - fres
      summary: searchFres
      description: >2-

        Note: <ul>1). When querying by identifiers, the supported syntax is as follows:
             ?identifierKey=key1,key2,...&identifierValue=value1,value2,...
        For instance:
             ?identifierKey=nodalId&identifierValue=nodalIdValue</ul><ul>2). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>3). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchFres
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of FRE identifiers to retrieve. NA results in all Fres with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text, (default search Fields are name, layerRate, tpeLocations if searchFields is not specified.)
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search with, combined with searchText. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of fre planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: layerRate
        in: query
        description: 'FRE layer rates in comma separated list. NA results in all Fres with no layerRate. NOT query is supported. The allowed layerRate values are: ETHERNET, OTU1, OTU2, OTU2e, OTU3, OTU4, OTUCn, OTSi, OMS, OS, PHY, OTS, FICON, FC, ODU, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU4, ODUCn, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, ENCAPSULATION, MPLS, MPLS_PROTECTION, MEDIA, LAG, RS, E1, E3, E1_2M, EC1, DSR_2M, LINE_OC3_STS3_AND_MS_STM1, SECTION_OC3_STS3_AND_RS_STM1, DSR_OC3_STM1, DSR_OC12_STM4, DSR_OC48_STM16, DSR_OC192_STM64, CES_IWF, T1, DSR_1_5M, STS1, STS3C, STS12C, STS24C, STS48C, STS192C, DS0, DS1, DS3, VT15, VT2, NOT_APPLICABLE, ODUFLEX, OTUg, ODUg, BGP, FLEXE_GROUP, IP, CBR'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Comma separated Network Construct identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id.operator
        in: query
        description: (Optional) The logical operator to use when searching Network Construct identifiers
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/networkConstruct.id.operator1'
          - description: (Optional) The logical operator to use when searching Network Construct identifiers
      - name: tpe.id
        in: query
        description: (Optional) Comma separated TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: tpe.id.operator
        in: query
        description: (Optional) The logical operator to use when searching tpeIds
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/tpe.id.operator1'
          - description: (Optional) The logical operator to use when searching tpeIds
      - name: physicalNeName
        in: query
        description: (Optional) Network Construct name. NA results in all Fres with no NC name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalNeName.operator
        in: query
        description: (Optional) The logical operator to use when searching Network Construct name
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/physicalNeName.operator1'
          - description: (Optional) The logical operator to use when searching Network Construct name
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifer object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) List of concrete FRE identifiers. NA results in all Fres with no concreteFREIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: bookingData.lockout
        in: query
        description: '(Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed. NA results in all Fres with no bwLockout. NOT query is supported.The allowed bwLockout values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: group
        in: query
        description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/group1'
          - description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
      - name: freType
        in: query
        description: 'FRE types in comma separated list. NA results in all Fres with no freType. NOT query is supported. The allowed freType values are: explicitRoute, explicitRouteGroup, snc, sncGroup, explicitRouteInstance, NA'
        style: form
        explode: true
        schema:
          type: string
      - name: userLabel
        in: query
        description: User label. NA results in all Fres with no userLabel. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: managementName
        in: query
        description: Management Name. NA results in all Fres with no mgmt name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id. NA results in all Fres with no serviceIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id. NA results in all Fres with no equipmentIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.intent.id
        in: query
        description: (Optional) The intent id. NA results in all Fres with no intentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.intent.type
        in: query
        description: (Optional) The intent type. NA results in all Fres with no intentType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. NA results in all Fres with no signalContentType. NOT query is supported. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) Find roadmlines by srlg values separated by comma. NA results in all Fres with no srlg. NOT query is supported. A roadmline is a FRE between two SAM cards.
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: deploymentState
        in: query
        description: (Optional) deploymentState parameter used to filter results. NA results in all Fres with no deploymentState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: active
        in: query
        description: '(Optional) The active state of the resource. NA results in all Fres with no active. NOT query is supported. The allowed active values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: directionality
        in: query
        description: '(Optional) Indicates if unidirectional or bidirectional FREs should be returned. NA results in all Fres with no directionality. NOT query is supported.  The allowed directionality values are: unidirectional, bidirectional'
        style: form
        explode: true
        schema:
          type: string
      - name: networkRole
        in: query
        description: '(Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points. NA results in all Fres with no networkRole. NOT query is supported.  The allowed networkRole values are: IFRE, FREAP, FREhAP, ROADMLINE, IFRECP'
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'FRE types in comma separated list. The allowed values are: service, link, roadmline-ap, roadmline'
        style: form
        explode: true
        schema:
          type: string
      - name: serviceClass
        in: query
        description: '(Optional) Allow filtering on the FRE service class. This parameter accepts a list of comma separated values. NA results in all Fres with no serviceClass. NOT query is supported. The allowed serviceClass values are: EVC, ETransit, EAccess, VLAN, TDM, Transport Client, Photonic, Tunnel, IP, LLDP, LAG, OTU, ROADM Line, Fiber, SNC , OSRP Link, OSRP Line, SNCP, ICL, Ring, FlexeLink, FlexeGroup, L3VPN, BGP Session,Path,EVPN_VPWS'
        style: form
        explode: true
        schema:
          type: string
      - name: layerRateQualifier
        in: query
        description: (Optional) Indicates additional qualification information for a LayerRate.NA results in all Fres with no layerRateQualifier. NOT query is supported. For example, for beyond 100G rates (e.g. OTUCn, ODUCn), defines the n multiplier, or the n-M subrate value.
        style: form
        explode: true
        schema:
          type: string
      - name: serviceRate
        in: query
        description: The service rate of the ODUFLEX FRE
        style: form
        explode: true
        schema:
          type: string
      - name: supportedByFreId
        in: query
        description: (Optional) Retrieves all supported parent FREs (default is one serviceClass/layer level up) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: supportedByQualifier
        in: query
        description: (Optional) Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/supportedByQualifier1'
          - description: (Optional) Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
      - name: supportingFreId
        in: query
        description: (Optional) Retrieves all supporting child FREs (one serviceClass/layer level down) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: customerName
        in: query
        description: (Optional) Search for an exact match on customerName. NA results in all Fres with no customerName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sncgUserlabel
        in: query
        description: '(Optional) For Control Plane SNCs only: Retrieves all SNCs provided the parent SNCG userLabel. NA results in all Fres with no sncgUserLabel. NOT query is supported.'
        style: form
        explode: true
        schema:
          type: string
      - name: tunnelType
        in: query
        description: '(Optional) Allow filtering on FRE Tunnel class service. NA results in all Fres with no tunnelType. This parameter accepts a list of comma separated values. The allowed tunnelType values are: dynamic, static'
        style: form
        explode: true
        schema:
          type: string
      - name: ringType
        in: query
        description: '(Optional) Allow filtering on type of G8032 ring. NA results in all Fres with no ringType. NOT query is supported. This parameter accepts a list of comma separated values. The allowed ringType values are: majorRing, subRing'
        style: form
        explode: true
        schema:
          type: string
      - name: ringCompleteness
        in: query
        description: '(Optional) Allow filtering on type of G8032 ring completeness. NA results in all Fres with no ringCompleteness. NOT query is supported. This parameter accepts a list of comma separated values. The allowed ringCompleteness values are: partial, complete'
        style: form
        explode: true
        schema:
          type: string
      - name: adminState
        in: query
        description: '(Optional) Allow filtering on FRE adminState. NA results in all Fres with no adminState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed adminState values are: enabled, disabled, not applicable, In Service, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: operationState
        in: query
        description: '(Optional) Allow filtering on FRE operationState. NA results in all Fres with no operationState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed operationState values are: fully operating, not operating, degraded operation, Not Applicable, Undetermined, In Service, Degraded, Out of Service External, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.status
        in: query
        description: '(Optional) Allow filtering on the LQS status. NA results in all Fres with no lqsStatus. NOT query is supported. The allowed statues values are: good, high, low, upgrade'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.margin.valid
        in: query
        description: '(Optional) The LQS margin validity state. NA results in all Fres with no lqsMarginValid. NOT query is supported. The allowed lqsMarginValid values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.reconciled
        in: query
        description: '(Optional) The LQS fiber reconciled state. NA results in all Fres with no lqsFiberReconciled. NOT query is supported. The allowed lqsFiberReconciled values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.method
        in: query
        description: '(Optional) Allow filtering on the LQS fiber method. NA results in all Fres with no lqsFiberMethod. NOT query is supported. The allowed lqsFiberMethod values are: totalPower, osc, ramanTelemetry, rls'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.deltaAvgToPlannedLoss
        in: query
        description: (Optional) The LQS fiber delta average to planned loss. NA results in all Fres with no lqsFiberDeltaAvgToPlannedLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.avgLoss
        in: query
        description: (Optional) The LQS fiber average loss. NA results in all Fres with no lqsFiberAvgLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.lastCalculationTime
        in: query
        description: (Optional) The LQS fiber last loss calculation time. NA results in all Fres with no lqsFiberLastCalculationTime. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.avgLossStatus
        in: query
        description: '(Optional) Allow filtering on the LQS Average Loss Status. NA results in all Fres with no lqsFiberAvgLossStatus. NOT query is supported. The allowed lqsFiberAvgLossStatus values: low, good, high'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.plannedLoss
        in: query
        description: (Optional) The LQS fiber planned loss. NA results in all Fres with no lqsFiberPlannedLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.plannedLossMargin
        in: query
        description: (Optional) The LQS fiber planned loss margin. NA results in all Fres with no lqsFiberPlannedLossMargin. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.currentLoss
        in: query
        description: (Optional) The LQS fiber planned current loss. NA results in all Fres with no lqsFiberCurrentLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.currentLossTime
        in: query
        description: (Optional) The LQS fiber current loss time. NA results in all Fres with no lqsFiberCurrentLossTime. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.currentLossMethod
        in: query
        description: '(Optional) Allow filtering on the LQS fiber current loss method. NA results in all Fres with no lqsFiberCurrentLossMethod. NOT query is supported. The allowed lqsFiberAvgLossStatus values: totalPower, osc, ramanTelemetry, rls'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.margin.viableAtEol
        in: query
        description: (Optional) A list of LQS margin viable at EOL states. NA results in all Fres with no lqsMarginViableEOL. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.snrStatus
        in: query
        description: (Optional) A list of LQS PPG snr states. NA results in all Fres with no lqsPpgSnrStatus. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.categorySnrReference
        in: query
        description: (Optional) A list of LQS PPG category snr reference values. NA results in all Fres with no lqsPpgCategorySnrReference. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.deltaSnrReference
        in: query
        description: (Optional) A list of LQS PPG delta snr reference values. NA results in all Fres with no lqsPpgDeltaSnrReference. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.startDeltaSnrReference
        in: query
        description: (Optional) Allow filtering on FRE lqsData ppg startDeltaSnrReference
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.endDeltaSnrReference
        in: query
        description: (Optional) Allow filtering on FRE lqsData ppg endDeltaSnrReference
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.totalExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth totalExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.availableExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth availableExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.unavailableExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth unavailableExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.availablePercentage
        in: query
        description: ((Optional) Allow filtering on FRE restorationHealth availablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.unavailablePercentage
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth unavailablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.homeAvailable
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth homeAvailable
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.startAvailablePercentage
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth startAvailablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.endAvailablePercentage
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth endAvailablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: coroutedFreId
        in: query
        description: (Optional) Retrieves all correlated FREs that are co-routed and co-terminated with the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on FRE tags. This parameter accepts a list of comma separated strings. NA results in all Fres with no tags. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayAdminState
        in: query
        description: (Optional) Allow filtering on FRE adminState display string. NA results in all Fres with no displayAdminState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayOperationState
        in: query
        description: (Optional) Allow filtering on FRE operationState display string. NA results in all Fres with no displayOperationState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayTopologySource
        in: query
        description: (Optional) Allow filtering on FRE topologySource display string. NA results in all Fres with no displayTopologySource. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.totalCapacity
        in: query
        description: (Optional) Allow filtering on FRE utilizationData totalCapacity. NA results in all Fres with no utilizationTotalCapacity. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.usedCapacity
        in: query
        description: (Optional) Allow filtering on FRE utilizationData usedCapacity. NA results in all Fres with no utilizationUsedCapacity. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.utilizationPercent
        in: query
        description: (Optional) Allow filtering on FRE utilizationData utilizationPercent. NA results in all Fres with no utilizationPercent. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on FRE utilizationData startUtilizationPercent
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on FRE utilizationData endUtilizationPercent
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.capacityUnits
        in: query
        description: (Optional) Allow filtering on FRE utilizationData capacityUnits. NA results in all Fres with no utilizationCapacityUnits. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: resiliency, tdmServices, topologicalLinks, roadmLineSpan, reusableSNCG, tunnelReplacement, layer1OtuLinks, photonicSncpWorkLegs, relatedFresFull, relatedFresLight, ringsWithoutConstraints, groupedSNCDTLSET, relatedRoadmlineSeedsForIntent, fresWithSrlg, l1LinkFresForHomeRoute, l1NcpTransportServices, resiliencyFre,staticRouteL3VPN, l1NcpLinkFres, virtualRingsOnL2Motr<br><br>tunnelReplacement cannot be used in combination with other named queries<br><br>virtualRingsOnL2Motr can not be used alone, networkConstruct.Id must be provided with this named query<br><br>photonicSncpWorkLegs can not be used alone, networkConstruct.Id must be provided with this named query<br><br>relatedFresFull can not be used alone, namedQueryParam1  must be provided with this named query.<br><br>relatedFresLight can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>relatedRoadmlineSeedsForIntent can not be used alone, namedQueryParam1 must be provided with this named query<br><br>l1LinkFresForHomeRoute can not be used alone, namedQueryParam1 must be provided with this named query<br><br>resiliencyFre can not be used alone, namedQueryParam1 must be provided with this named query<br><br>groupedSNCDTLSET cannot be used in combination with other named queries and can not be used alone, namedQueryParam1  must be provided with this named query.<br><br>staticRouteL3VPN can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>l1NcpLinkFres can not be used alone, namedQueryParam1 must be provided with this named query.'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: Mandatory when namedQuery relatedFresFull/relatedFresLight/relatedRoadmlineSeedsForIntent/l1LinkFresForHomeRoute/resiliencyFre/l1NcpLinkFres is used.
        style: form
        explode: true
        schema:
          type: string
      - name: relatedServices
        in: query
        description: '(Optional) when namedQuery relatedFresFull. NA results in all Fres with no relatedServices. NOT query is supported. The allowed relatedServices values are: Sncp, Link diverse, Bundle diverse, Absolute diverse'
        style: form
        explode: true
        schema:
          type: string
      - name: domainTypes
        in: query
        description: (Optional) Allow filtering on FRE domainTypes. NA results in all Fres with no domainTypes. NOT query is supported. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          type: string
      - name: resilienceLevel
        in: query
        description: '(Optional) Allow filtering on FRE domainTypes. NA results in all Fres with no resilienceLevel. NOT query is supported. This parameter accepts a list of comma separated values. The allowed resilienceLevel values are: unprotected, partial, protected'
        style: form
        explode: true
        schema:
          type: string
      - name: partitionFreIds
        in: query
        description: (Optional) Retrieves all parent FREs that have the specified FRE as a partition relation. NA results in all Fres with no partitionFreIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: decomposedFreIds
        in: query
        description: (Optional) Retrieves all parent FREs that have the specified FRE as a decomposed relation. NA results in all Fres with no decomposedFreIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: facilityBypass
        in: query
        description: "(Optional) Allow filtering of FRE's with facilityBypass tunnels. NA results in all Fres with no facilityBypass. The allowed facilityBypass value is: exclude"
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: (Optional) The child FRE identifier to return its parents. NA results in all Fres with no childFreId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: gneSubnetName
        in: query
        description: (Optional) GNE Subnet name of the FRE. NA results in all Fres with no gneSubnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: routingConstraints.inclusionConstraints.id
        in: query
        description: (Optional) Retrieves all FREs that have an inclusion constraint relationship to the specified identifier. NA results in all Fres with no routingInclusionConstraintsId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayDeploymentState
        in: query
        description: (Optional) Allow filtering on FRE deploymentState display string. NA results in all Fres with no displayDeploymentState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: ncTags
        in: query
        description: (Optional) List of comma-separated network construct tags that is an endpoint for an FRE. NA results in all Fres with no ncTags. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayRecoveryCharacteristicsOnHome
        in: query
        description: (Optional) Allow filtering on FRE resiliency controller recovery characteristics onHome display string. NA results in all Fres with no displayRecoveryCharacteristicsOnHome. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: remoteOSRPNodeName
        in: query
        description: (Optional) Allow filtering of DTLSet fres on the basis of destination osrp node name. NA results in all Fres with no remoteOSRPNodeName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: headOSRPNodeName
        in: query
        description: (Optional) Allow filtering of DTLSet fres on the basis of head osrp node name. NA results in all Fres with no headOSRPNodeName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: isUsedByService
        in: query
        description: (Optional) Allow filtering of DTLSet fres on the basis of whether they are used by snc/sncg or not. NA results in all Fres with no isUsedByService. NOT query is supported. The allowed isUsedByService values are true/false
        style: form
        explode: true
        schema:
          type: string
      - name: isDTLSetUsedAsRoutingConstraint
        in: query
        description: (Optional) Allow filtering of DTLSet FREs on the basis of whether they are referenced by an snc/sncg or not. NA results in all Fres with no value set. NOT query is supported. The allowed values are true/false
        style: form
        explode: true
        schema:
          type: string
      - name: isOtdrCapable
        in: query
        description: (Optional) List all fres that have OTDR capable links. NA results in all Fres with no isOtdrCapable. NOT query is supported. Allowed value is true
        style: form
        explode: true
        schema:
          type: string
      - name: sourceTraceType
        in: query
        description: (Optional) Allow filtering of source trace type. NA results in all Fres with no source trace type. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceTraceTimestamp
        in: query
        description: (Optional) Allow filtering of source trace time stamp. NA results in all Fres with no source trace time stamp. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationTraceType
        in: query
        description: (Optional) Allow filtering of destination trace type. NA results in all Fres with no destination trace type. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationTraceTimestamp
        in: query
        description: (Optional) Allow filtering of destination trace time stamp. NA results in all Fres with no destination trace time stamp. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceOtdrcfgaId
        in: query
        description: (Optional) Allow filtering of source OTDR cfg aid. NA results in all Fres with no source OTDR cfg aid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceNcId
        in: query
        description: (Optional) Allow filtering of source NC ID. NA results in all Fres with no ssource NC ID. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationOtdrcfgaId
        in: query
        description: (Optional) Allow filtering of destination OTDR cfg aid. NA results in all Fres with no destination OTDR cfg aid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationNcId
        in: query
        description: (Optional) Allow filtering of destination NC id. NA results in all Fres with no destination NC id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: isSubmarineLink
        in: query
        description: (Optional) List all fres that have isSubmarineLink. NA results in all Fres with no isSubmarineLink. NOT query is supported. Allowed value is true
        style: form
        explode: true
        schema:
          type: string
      - name: ovpnIds
        in: query
        description: List of comma separated ovpnIds (0-255). NA results in all Fres with no ovpnIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: partitioningFreIds
        in: query
        description: (Optional) Retrieves all child FREs that have the specified FRE as a partitioning relation. NA results in all Fres with no partitioningFreIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: internalStructure
        in: query
        description: '(Optional) Allow filtering on the FRE Internal Structure. This parameter accepts a list of comma separated values. NA results in all Fres with no internalStructure. NOT query is supported. The allowed internalStructure values are: SIMPLE,SIMPLE_SWITCHED,PROTECTED_ONE_END, MULTI_SIMPLE, MULTIPLE,PROTECTED_BOTH_ENDSMULTIPOINT, HUB_AND_SPOKE,EXPLICIT,INTERCONNECT_ONE_END,UNKNOWN,FULL_MESH,PARTIAL_MESH'
        style: form
        explode: true
        schema:
          type: string
      - name: exportRouteTargets
        in: query
        description: (Optional) Allow filtering support on Export Route Targets
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: importRouteTargets
        in: query
        description: (Optional) Allow filtering support on Import Route Targets
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filterType
        in: query
        description: >-
          (Optional) FilterType used in case search fres based on export Route Target or Import Route Target.

          if FilterType = Both, then search fres based on importRouteTarget OR exportRouteTarget.

          else, fres search based on importRouteTarget AND exportRouteTarget
        style: form
        explode: true
        schema:
          type: string
      - name: nativeName
        in: query
        description: (Optional) Allow filtering support on Native Name. NA results in all Fres with no nativeName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) Allow filtering support on Display Name. NA results in all Fres with no displayName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: peerSNCIdentifier
        in: query
        description: (Optional) Allow filtering support on Peer SNC Identifier. NA results in all Fres with no peerSNCIdentifier. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: interfaceName/interfaceIP
        in: query
        description: (Optional) Filter support on Interface Name or Interface IP.
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.averageUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput averageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.startAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput startAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.endAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput endAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.maxUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput maxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.startMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput startMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.endMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput endMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.ninetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput ninetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.startNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput startNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.endNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput endNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.averageUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput averageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.startAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput startAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.endAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput endAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.maxUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput maxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.startMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput startMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.endMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput endMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.ninetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput ninetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.startNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput startNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.endNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput endNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: completeness
        in: query
        description: '(Optional) Allow filtering on type of FlexE and G8032 completeness. NA results in all Fres with no Completeness. NOT query is supported. This parameter accepts a list of comma separated values. The allowed Completeness values are: partial, complete'
        style: form
        explode: true
        schema:
          type: string
      - name: misconfigured
        in: query
        description: '(Optional) Allow filtering on type of FlexE misconfigurations. This parameter accepts a list of comma separated values. The allowed misconfigured values are: true or false'
        style: form
        explode: true
        schema:
          type: string
      - name: destinationPrefix
        in: query
        description: (Optional) Allow filtering support on destinationPrefix.
        style: form
        explode: true
        schema:
          type: string
      - name: selectedRoute
        in: query
        description: (Optional) Allow filtering support on Selected Route.
        style: form
        explode: true
        schema:
          type: string
      - name: vrfName
        in: query
        description: (Optional) Allow filtering support on Vrf Name.
        style: form
        explode: true
        schema:
          type: string
      - name: nextHopIp
        in: query
        description: (Optional) Allow filtering support on NextHop Ip.
        style: form
        explode: true
        schema:
          type: string
      - name: vrfId
        in: query
        description: (Optional) Allow filtering support on Vrf Id.
        style: form
        explode: true
        schema:
          type: string
      - name: statsCollectionOperational
        in: query
        description: '(Optional) Allow filtering on value of IPDATA statsCollectionOperational. NA results in all Fres with no statsCollectionOperational. NOT query is supported. This parameter accepts a list of comma separated values. The allowed statsCollectionOperational values are: partial, on, off'
        style: form
        explode: true
        schema:
          type: string
      - name: dmmState
        in: query
        description: '(Optional) Allow filtering on value of IPDATA dmmState. NA results in all Fres with no dmmState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed dmmState values are: enabled, disabled, partial'
        style: form
        explode: true
        schema:
          type: string
      - name: slmState
        in: query
        description: '(Optional) Allow filtering on value of IPDATA slmState. NA results in all Fres with no slmState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed slmState values are: enabled, disabled, partial'
        style: form
        explode: true
        schema:
          type: string
      - name: signalingType
        in: query
        description: (Optional) Allow filtering support on Signaling Type. NA results in all Fres with no signalingType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceEndPoint
        in: query
        description: (Optional) Allow filtering support on source End Point. NA results in all Fres with no sourceEndPoint. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destEndPoint
        in: query
        description: (Optional) Allow filtering support on destination End Point. NA results in all Fres with no destEndPoint. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: bindingAllocatedSid
        in: query
        description: (Optional) Allow filtering support on SR TE Binding Allocated Sid. NA results in all Fres with no bindingAllocatedSid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: cfmAdminState
        in: query
        description: (Optional) Allow filtering support on CfmAdminState
        style: form
        explode: true
        schema:
          type: string
      - name: color
        in: query
        description: (Optional) Allow filtering support on Color
        style: form
        explode: true
        schema:
          type: string
      - name: displayServerRefreshState
        in: query
        description: (Optional) Allow filtering support on the displayData server refresh state
        style: form
        explode: true
        schema:
          type: string
      - name: serviceRefresh.state
        in: query
        description: (Optional) Allow filtering support on the server refresh state
        style: form
        explode: true
        schema:
          type: string
      - name: serviceRefresh.status
        in: query
        description: (Optional) Allow filtering support on the server refresh status
        style: form
        explode: true
        schema:
          type: string
      - name: transportPolicy
        in: query
        description: (Optional) Allow filtering support on transportPolicy Type. NA results in all Fres with no transportPolicy. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: catalog
        in: query
        description: (Optional) Allow filtering support on catalog. NA results in all Fres with no catalog. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: srColor
        in: query
        description: (Optional) Allow filtering support on color NA results in all Fres with no color. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: fallback
        in: query
        description: (Optional) Allow filtering support on fallback. NA results in all Fres with no fallback. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: ringStatus
        in: query
        description: '(Optional) Allow filtering on Status of G8032 ring. This parameter accepts a list of comma separated values: OK, Local signal failure, Local force switch, Remote signal failure, Remote force switch,Provisioning mismatch, Not receiving PDUs, No RPL owner detected, Unknown'
        style: form
        explode: true
        schema:
          type: string
      - name: ringState
        in: query
        description: '(Optional) Allow filtering on State of G8032 ring. This parameter accepts a list of comma separated values: Initializing, OK, Admin disabled, Operational disabled, Protecting, Recovering, Manual switch, Force switch, Unknown'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: metaDataFields
        in: query
        description: 'MetaData to be included. The allowed values are: layerRate, layerRateQualifier, signalContentType, serviceClass, sncgUserlabel, adminState, operationState, lqsData.status, lqsData.margin.valid, lqsData.fiber.reconciled, lqsData.fiber.method, lqsData.margin.viableAtEol, displayAdminState, displayOperationState, displayTopologySource, customerName, domainTypes, resilienceLevel, directionality, displayDeploymentState, ringType, ringCompleteness, displayRecoveryCharacteristicsOnHome, lqsData.ppg.snrStatus, internalStructure, lqsData.ppg.categorySnrReference, lqsData.ppg.deltaSnrReference, totalCapacity, usedCapacity, utilizationPercent, capacityUnits, restorationHealth.totalExplicitRoutes, restorationHealth.availableExplicitRoutes, restorationHealth.unavailableExplicitRoutes, restorationHealth.availablePercentage, restorationHealth.unavailablePercentage, restorationHealth.homeAvailable, remoteOSRPNodeName, headOSRPNodeName, isDTLSetUsedAsRoutingConstraint, importRouteTargets, exportRouteTargets, relatedServices, signalingType, sourceEndPoint, destEndPoint, transportPolicy, catalog, srColor, fallback, dailyThroughput.averageUtilization, dailyThroughput.maxUtilization, dailyThroughput.ninetyFifthUtilization, weeklyThroughput.averageUtilization, weeklyThroughput.maxUtilization, weeklyThroughput.ninetyFifthUtilization, remoteOSRPNodeName, headOSRPNodeName, isDTLSetUsedAsRoutingConstraint, importRouteTargets, exportRouteTargets,destinationPrefix,selectedRoute,vrfName,vrfId,nextHopIp, relatedServices, isOtdrCapable,sourceTraceType,sourceTraceTimestamp, destinationTraceType, destinationTraceTimestamp, sourceOtdrcfgaId, sourceNcId, destinationOtdrcfgaId, destinationNcId, displayServerRefreshState, nativeName, isSubmarineLink'
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, networkConstructs, planned, freDiscovered, frePlanned, srlgs, supportedByFreResiliencyClientTpes, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - fres
      summary: searchPostFresV2
      description: >2-

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKey=key1,key2,...&identifierValue=value1,value2,...
        For instance:
             ?identifierKey=nodalId&identifierValue=nodalIdValue<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "layerRate": "OTSi",
          "directionality": "unidirectional",
          "networkRole": "FREAP",
          "type": "service",
          "limit": "50"
        }</code></pre>
      operationId: searchPostFresV2
      parameters: []
      requestBody:
        description: FRE search parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreSearchParamsRO'
              - description: FRE search parameters
        required: false
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/search/fres/{freId}:
    get:
      tags:
      - fres
      summary: getFreById
      description: Retrieves a specific FRE
      operationId: getFreById
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, controllers, utilization'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/search/fres:
    get:
      tags:
      - fres
      summary: searchFresV1
      description: >2-

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKey=key1,key2,...&identifierValue=value1,value2,...
        For instance:
             ?identifierKey=nodalId&identifierValue=nodalIdValue
      operationId: searchFresV1
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of FRE identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text, (default search Fields are name, layerRate, tpeLocations if searchFields is not specified.)
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search with, combined with searchText. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: resourceState
        in: query
        description: '(Optional) List of fre planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: layerRate
        in: query
        description: 'FRE layer rates in comma separated list The allowed values are: ETHERNET, OTU1, OTU2, OTU2e, OTU3, OTU4, OTUCn, OTSi, OMS, OS, PHY, OTS, FICON, FC, ODU, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU4, ODUCn, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, ENCAPSULATION, MPLS, MPLS_PROTECTION, MEDIA, LAG, RS, E1, E3, E1_2M, EC1, DSR_2M, LINE_OC3_STS3_AND_MS_STM1, SECTION_OC3_STS3_AND_RS_STM1, DSR_OC3_STM1, DSR_OC12_STM4, DSR_OC48_STM16, DSR_OC192_STM64, CES_IWF, T1, DSR_1_5M, STS1, STS3C, STS12C, STS24C, STS48C, DS0, DS1, DS3, VT15, VT2, NOT_APPLICABLE, ODUFLEX, OTUg, ODUg, BGP'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Comma-Separated Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.idQualifier
        in: query
        description: (Optional) The logical operator to use when searching Network Construct identifiers
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/networkConstruct.idQualifier1'
          - description: (Optional) The logical operator to use when searching Network Construct identifiers
      - name: tpeId
        in: query
        description: (Optional) Comma separated TPE identifiers for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: tpeIdQualifier
        in: query
        description: (Optional) The logical operator to use when searching tpeIds
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/tpeIdQualifier1'
          - description: (Optional) The logical operator to use when searching tpeIds
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) List of concrete FRE identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: bookingData.lockout
        in: query
        description: (Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/bookingData.lockout1'
          - description: (Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed
      - name: group
        in: query
        description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/group1'
          - description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
      - name: freType
        in: query
        description: 'FRE types in comma separated list The allowed values are: explicitRoute, explicitRouteGroup, snc, sncGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: userLabel
        in: query
        description: User label
        style: form
        explode: true
        schema:
          type: string
      - name: managementName
        in: query
        description: Management Name
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) Find roadmlines by srlg values separated by comma. A roadmline is a FRE between two SAM cards.
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: deploymentState
        in: query
        description: (Optional) deploymentState parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: active
        in: query
        description: (Optional) The active state of the resource
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/active1'
          - description: (Optional) The active state of the resource
      - name: directionality
        in: query
        description: (Optional) Indicates if unidirectional or bidirectional FREs should be returned
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/directionality51'
          - description: (Optional) Indicates if unidirectional or bidirectional FREs should be returned
      - name: networkRole
        in: query
        description: (Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/networkRole31'
          - description: (Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
      - name: type
        in: query
        description: 'FRE types in comma separated list. The allowed values are: service, link, roadmline-ap, roadmline'
        style: form
        explode: true
        schema:
          type: string
      - name: serviceClass
        in: query
        description: '(Optional) Allow filtering on the FRE service class. This parameter accepts a list of comma separated values. The allowed values are: EVC, ETransit, EAccess, VLAN, TDM, Transport Client, Photonic, Tunnel, IP, LLDP, LAG, OTU, ROADM Line, Fiber, SNC , OSRP Link, OSRP Line, SNCP, ICL, BGP Session'
        style: form
        explode: true
        schema:
          type: string
      - name: layerRateQualifier
        in: query
        description: (Optional) Indicates additional qualification information for a LayerRate. For example, for beyond 100G rates (e.g. OTUCn, ODUCn), defines the n multiplier, or the n-M subrate value.
        style: form
        explode: true
        schema:
          type: string
      - name: supportedByFreId
        in: query
        description: (Optional) Retrieves all supported parent FREs (default is one serviceClass/layer level up) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: supportedByQualifier
        in: query
        description: (Optional) Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/supportedByQualifier1'
          - description: (Optional) Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
      - name: supportingFreId
        in: query
        description: (Optional) Retrieves all supporting child FREs (one serviceClass/layer level down) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: customerName
        in: query
        description: (Optional) Search for an exact match on customerName
        style: form
        explode: true
        schema:
          type: string
      - name: sncgUserlabel
        in: query
        description: '(Optional) For Control Plane SNCs only: Retrieves all SNCs provided the parent SNCG userLabel'
        style: form
        explode: true
        schema:
          type: string
      - name: tunnelType
        in: query
        description: '(Optional) Allow filtering on FRE Tunnel class service. This parameter accepts a list of comma separated values: dynamic, static'
        style: form
        explode: true
        schema:
          type: string
      - name: adminState
        in: query
        description: '(Optional) Allow filtering on FRE adminState. This parameter accepts a list of comma separated values: enabled, disabled, not applicable, In Service, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: operationState
        in: query
        description: '(Optional) Allow filtering on FRE operationState. This parameter accepts a list of comma separated values: fully operating, not operating, degraded operation, Not Applicable, Undetermined, In Service, Degraded, Out of Service External, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.status
        in: query
        description: (Optional) Allow filtering on the LQS status. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.status1'
          - description: (Optional) Allow filtering on the LQS status. This parameter accepts a list of comma separated values
      - name: lqsData.margin.valid
        in: query
        description: (Optional) The LQS margin validity state
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.margin.valid1'
          - description: (Optional) The LQS margin validity state
      - name: lqsData.fiber.reconciled
        in: query
        description: (Optional) The LQS fiber reconciled state
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.fiber.reconciled1'
          - description: (Optional) The LQS fiber reconciled state
      - name: lqsData.fiber.method
        in: query
        description: (Optional) Allow filtering on the LQS fiber method. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.fiber.method1'
          - description: (Optional) Allow filtering on the LQS fiber method. This parameter accepts a list of comma separated values
      - name: lqsData.margin.viableAtEol
        in: query
        description: (Optional) A list of LQS margin viable at EOL states
        style: form
        explode: true
        schema:
          type: string
      - name: coroutedFreId
        in: query
        description: (Optional) Retrieves all correlated FREs that are co-routed and co-terminated with the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on FRE tags. This parameter accepts a list of comma separated strings
        style: form
        explode: true
        schema:
          type: string
      - name: displayAdminState
        in: query
        description: (Optional) Allow filtering on FRE adminState display string
        style: form
        explode: true
        schema:
          type: string
      - name: displayOperationState
        in: query
        description: (Optional) Allow filtering on FRE operationState display string
        style: form
        explode: true
        schema:
          type: string
      - name: displayTopologySource
        in: query
        description: (Optional) Allow filtering on FRE topologySource display string
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: resiliency, tdmServices, topologicalLinks, roadmLineSpan, reusableSNCG'
        style: form
        explode: true
        schema:
          type: string
      - name: domainTypes
        in: query
        description: (Optional) Allow filtering on FRE domainTypes. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          type: string
      - name: resilienceLevel
        in: query
        description: '(Optional) Allow filtering on FRE domainTypes. This parameter accepts a list of comma separated values: unprotected, partial, protected'
        style: form
        explode: true
        schema:
          type: string
      - name: partitionFreIds
        in: query
        description: (Optional) Retrieves all parent FREs that have the specified FRE as a partition relation
        style: form
        explode: true
        schema:
          type: string
      - name: decomposedFreIds
        in: query
        description: (Optional) Retrieves all parent FREs that have the specified FRE as a decomposed relation
        style: form
        explode: true
        schema:
          type: string
      - name: facilityBypass
        in: query
        description: (Optional) Allow filtering of FRE's with facilityBypass tunnels.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/facilityBypass1'
          - description: (Optional) Allow filtering of FRE's with facilityBypass tunnels.
      - name: childFreId
        in: query
        description: (Optional) The child FRE identifier to return its parents
        style: form
        explode: true
        schema:
          type: string
      - name: gneSubnetName
        in: query
        description: (Optional) GNE Subnet name of the FRE
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: metaDataFields
        in: query
        description: 'MetaData to be included. The allowed values are: layerRate, layerRateQualifier, signalContentType, serviceClass, sncgUserlabel, adminState, operationState, lqsData.status, lqsData.margin.valid, lqsData.fiber.reconciled, lqsData.fiber.method, lqsData.margin.viableAtEol, displayAdminState, displayOperationState, displayTopologySource, customerName, domainTypes, resilienceLevel, directionality'
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, networkConstructs, planned, freDiscovered, frePlanned, srlgs, supportedByFreResiliencyClientTpes'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsi/api/v1/search/fres/{freId}:
    get:
      tags:
      - fres
      summary: getFreByIdV1
      description: Retrieves a specific FRE
      operationId: getFreByIdV1
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, controllers'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsi/api/v2/search/fres:
    get:
      tags:
      - fres
      summary: searchFresV2
      description: >2-

        Note: <ul>1). When querying by identifiers, the supported syntax is as follows:
             ?identifierKey=key1,key2,...&identifierValue=value1,value2,...
        For instance:
             ?identifierKey=nodalId&identifierValue=nodalIdValue</ul><ul>2). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>3). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchFresV2
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of FRE identifiers to retrieve. NA results in all Fres with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text, (default search Fields are name, layerRate, tpeLocations if searchFields is not specified.)
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search with, combined with searchText. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of fre planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: layerRate
        in: query
        description: 'FRE layer rates in comma separated. NA results in all Fres with no layerRate. NOT query is supported. list. The allowed layerRate values are: ETHERNET, OTU1, OTU2, OTU2e, OTU3, OTU4, OTUCn, OTSi, OMS, OS, PHY, OTS, FICON, FC, ODU, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU4, ODUCn, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, ENCAPSULATION, MPLS, MPLS_PROTECTION, MEDIA, LAG, RS, E1, E3, E1_2M, EC1, DSR_2M, LINE_OC3_STS3_AND_MS_STM1, SECTION_OC3_STS3_AND_RS_STM1, DSR_OC3_STM1, DSR_OC12_STM4, DSR_OC48_STM16, DSR_OC192_STM64, CES_IWF, T1, DSR_1_5M, STS1, STS3C, STS12C, STS24C, STS48C, STS192C, DS0, DS1, DS3, VT15, VT2, NOT_APPLICABLE, ODUFLEX, OTUg, ODUg, BGP, FLEXE_GROUP, CBR'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id.operator
        in: query
        description: (Optional) The logical operator to use when searching Network Construct identifier
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/networkConstruct.id.operator2'
          - description: (Optional) The logical operator to use when searching Network Construct identifier
      - name: tpe.id
        in: query
        description: (Optional) Comma separated TPE identifiers for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: tpe.id.operator
        in: query
        description: (Optional) The logical operator to use when searching tpeIds
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/tpe.id.operator1'
          - description: (Optional) The logical operator to use when searching tpeIds
      - name: physicalNeName
        in: query
        description: (Optional) Network Construct name
        style: form
        explode: true
        schema:
          type: string
      - name: physicalNeName.operator
        in: query
        description: (Optional) The logical operator to use when searching Network Construct name
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/physicalNeName.operator1'
          - description: (Optional) The logical operator to use when searching Network Construct name
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) List of concrete FRE identifiers. NA results in all Fres with no concreteFREIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: bookingData.lockout
        in: query
        description: '(Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed. NA results in all Fres with no bwLockout. NOT query is supported. The allowed bwLockout values: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: group
        in: query
        description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/group1'
          - description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
      - name: freType
        in: query
        description: 'FRE types in comma separated list. NA results in all Fres with no freType. NOT query is supported. The allowed freType values are: explicitRoute, cascadedExplicitRoute, explicitRouteGroup, snc, sncGroup, explicitRouteInstance'
        style: form
        explode: true
        schema:
          type: string
      - name: userLabel
        in: query
        description: User label. NA results in all Fres with no userLabel. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: managementName
        in: query
        description: Management Name. NA results in all Fres with no mgmt name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id. NA results in all Fres with no serviceIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id. NA results in all Fres with no equipmentIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.intent.id
        in: query
        description: (Optional) The intent id. NA results in all Fres with no intentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.intent.type
        in: query
        description: (Optional) The intent type. NA results in all Fres with no intentType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. NA results in all Fres with no signalContentType. NOT query is supported. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) Find roadmlines by srlg values separated by comma. NA results in all Fres with no srlg. NOT query is supported. A roadmline is a FRE between two SAM cards.
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: deploymentState
        in: query
        description: (Optional) deploymentState parameter used to filter results. NA results in all Fres with no deploymentState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: active
        in: query
        description: '(Optional) The active state of the resource. NA results in all Fres with no active. NOT query is supported. The allowed active values: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: directionality
        in: query
        description: '(Optional) Indicates if unidirectional or bidirectional FREs should be returned. NA results in all Fres with no directionality. NOT query is supported. The allowed directionality values: unidirectional, bidirectional'
        style: form
        explode: true
        schema:
          type: string
      - name: networkRole
        in: query
        description: '(Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points. NA results in all Fres with no networkRole. NOT query is supported. The allowed  values: IFRE, FREAP, FREhAP, ROADMLINE, IFRECP'
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'FRE types in comma separated list. The allowed values are: service, link, roadmline-ap, roadmline'
        style: form
        explode: true
        schema:
          type: string
      - name: serviceClass
        in: query
        description: '(Optional) Allow filtering on the FRE service class. This parameter accepts a list of comma separated values. NA results in all Fres with no serviceClass. NOT query is supported. The allowed serviceClass values are: EVC, ETransit, EAccess, VLAN, TDM, Transport Client, Photonic, Tunnel, IP, LLDP, LAG, OTU, ROADM Line, Fiber, SNC , OSRP Link, OSRP Line, SNCP, ICL, Ring, FlexeLink, FlexeGroup, EVPN_VPWS'
        style: form
        explode: true
        schema:
          type: string
      - name: layerRateQualifier
        in: query
        description: (Optional) Indicates additional qualification information for a LayerRate. NA results in all Fres with no layerRateQualifier. NOT query is supported. For example, for beyond 100G rates (e.g. OTUCn, ODUCn), defines the n multiplier, or the n-M subrate value.
        style: form
        explode: true
        schema:
          type: string
      - name: serviceRate
        in: query
        description: The service rate of the ODUFLEX FRE
        style: form
        explode: true
        schema:
          type: string
      - name: supportedByFreId
        in: query
        description: (Optional) Retrieves all supported parent FREs (default is one serviceClass/layer level up) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: supportedByQualifier
        in: query
        description: (Optional) Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/supportedByQualifier1'
          - description: (Optional) Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
      - name: supportingFreId
        in: query
        description: (Optional) Retrieves all supporting child FREs (one serviceClass/layer level down) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: customerName
        in: query
        description: (Optional) Search for an exact match on customerName. NA results in all Fres with no customerName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sncgUserlabel
        in: query
        description: '(Optional) For Control Plane SNCs only: Retrieves all SNCs provided the parent SNCG userLabel. NA results in all Fres with no sncgUserLabel. NOT query is supported.'
        style: form
        explode: true
        schema:
          type: string
      - name: tunnelType
        in: query
        description: '(Optional) Allow filtering on FRE Tunnel class service. NA results in all Fres with no tunnelType. This parameter accepts a list of comma separated values. The allowed tunnelType values are: dynamic, static'
        style: form
        explode: true
        schema:
          type: string
      - name: ringType
        in: query
        description: '(Optional) Allow filtering on type of G8032 ring.  NA results in all Fres with no ringType. NOT query is supported. This parameter accepts a list of comma separated values. The allowed ringType values are: majorRing, subRing'
        style: form
        explode: true
        schema:
          type: string
      - name: ringCompleteness
        in: query
        description: '(Optional) Allow filtering on type of G8032 ring completeness. NA results in all Fres with no ringCompleteness. NOT query is supported. This parameter accepts a list of comma separated values. The allowed ringCompleteness values are: partial, complete'
        style: form
        explode: true
        schema:
          type: string
      - name: adminState
        in: query
        description: '(Optional) Allow filtering on FRE adminState.  NA results in all Fres with no adminState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed adminState values are: enabled, disabled, not applicable, In Service, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: operationState
        in: query
        description: '(Optional) Allow filtering on FRE operationState.  NA results in all Fres with no operationState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed operationState values are: fully operating, not operating, degraded operation, Not Applicable, Undetermined, In Service, Degraded, Out of Service External, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.status
        in: query
        description: '(Optional) Allow filtering on the LQS status. NA results in all Fres with no lqsStatus. NOT query is supported. The allowed lqsStatus values: good, high, low, upgrade'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.margin.valid
        in: query
        description: '(Optional) The LQS margin validity state.  NA results in all Fres with no lqsMarginValid. NOT query is supported. The allowed lqsMarginValid values: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.reconciled
        in: query
        description: '(Optional) The LQS fiber reconciled state. NA results in all Fres with no lqsFiberReconciled. NOT query is supported.The allowed lqsFiberReconciled values: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.method
        in: query
        description: '(Optional) Allow filtering on the LQS fiber method. NA results in all Fres with no lqsFiberMethod. NOT query is supported. The allowed lqsFiberMethod values: totalPower, osc, ramanTelemetry, rls'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.deltaAvgToPlannedLoss
        in: query
        description: (Optional) The LQS fiber delta average to planned loss. NA results in all Fres with no lqsFiberDeltaAvgToPlannedLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.avgLoss
        in: query
        description: (Optional) The LQS fiber average loss. NA results in all Fres with no lqsFiberAvgLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.avgLossStatus
        in: query
        description: '(Optional) Allow filtering on the LQS Average Loss Status. NA results in all Fres with no lqsFiberAvgLossStatus. NOT query is supported. The allowed lqsFiberAvgLossStatus values: low, good, high'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.lastCalculationTime
        in: query
        description: (Optional) The LQS fiber last loss calculation time. NA results in all Fres with no lqsFiberLastCalculationTime. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.plannedLoss
        in: query
        description: (Optional) The LQS fiber planned loss. NA results in all Fres with no lqsFiberPlannedLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.plannedLossMargin
        in: query
        description: (Optional) The LQS fiber planned loss margin. NA results in all Fres with no lqsFiberPlannedLossMargin. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.currentLoss
        in: query
        description: (Optional) The LQS fiber planned current loss. NA results in all Fres with no lqsFiberCurrentLoss. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.currentLossTime
        in: query
        description: (Optional) The LQS fiber current loss time. NA results in all Fres with no lqsFiberCurrentLossTime. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.fiber.currentLossMethod
        in: query
        description: '(Optional) Allow filtering on the LQS fiber current loss method. NA results in all Fres with no lqsFiberCurrentLossMethod. NOT query is supported. The allowed lqsFiberAvgLossStatus values: totalPower, osc, ramanTelemetry, rls'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.margin.viableAtEol
        in: query
        description: (Optional) A list of LQS margin viable at EOL states. NA results in all Fres with no lqsMarginViableEOL. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.snrStatus
        in: query
        description: (Optional) A list of LQS PPG snr states. NA results in all Fres with no lqsPpgSnrStatus. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.categorySnrReference
        in: query
        description: (Optional) A list of LQS PPG category snr reference values. NA results in all Fres with no lqsPpgCategorySnrReference. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.deltaSnrReference
        in: query
        description: (Optional) A list of LQS PPG delta snr reference values. NA results in all Fres with no lqsPpgDeltaSnrReference. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.startDeltaSnrReference
        in: query
        description: (Optional) Allow filtering on FRE lqsData ppg startDeltaSnrReference
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.ppg.endDeltaSnrReference
        in: query
        description: (Optional) Allow filtering on FRE lqsData ppg endDeltaSnrReference
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.totalExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth totalExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.availableExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth availableExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.unavailableExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth unavailableExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.availablePercentage
        in: query
        description: ((Optional) Allow filtering on FRE restorationHealth availablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.unavailablePercentage
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth unavailablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.homeAvailable
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth homeAvailable
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.startAvailablePercentage
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth startAvailablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.endAvailablePercentage
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth endAvailablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: coroutedFreId
        in: query
        description: (Optional) Retrieves all correlated FREs that are co-routed and co-terminated with the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on FRE tags. This parameter accepts a list of comma separated strings. NA results in all Fres with no tags. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayAdminState
        in: query
        description: (Optional) Allow filtering on FRE adminState display string. NA results in all Fres with no displayAdminState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayOperationState
        in: query
        description: (Optional) Allow filtering on FRE operationState display string. NA results in all Fres with no displayOperationState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayTopologySource
        in: query
        description: (Optional) Allow filtering on FRE topologySource display string. NA results in all Fres with no displayTopologySource. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.totalCapacity
        in: query
        description: (Optional) Allow filtering on FRE utilizationData totalCapacity. NA results in all Fres with no utilizationTotalCapacity. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.usedCapacity
        in: query
        description: (Optional) Allow filtering on FRE utilizationData usedCapacity. NA results in all Fres with no utilizationUsedCapacity. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.utilizationPercent
        in: query
        description: (Optional) Allow filtering on FRE utilizationData utilizationPercent. NA results in all Fres with no utilizationPercent. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on FRE utilizationData startUtilizationPercent
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on FRE utilizationData endUtilizationPercent
        style: form
        explode: true
        schema:
          type: string
      - name: utilizationData.capacityUnits
        in: query
        description: (Optional) Allow filtering on FRE utilizationData capacityUnits. NA results in all Fres with no utilizationCapacityUnits. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: resiliency, tdmServices, topologicalLinks, roadmLineSpan, reusableSNCG, tunnelReplacement, layer1OtuLinks, photonicSncpWorkLegs, relatedFresFull, relatedFresLight, ringsWithoutConstraints, groupedSNCDTLSET, relatedRoadmlineSeedsForIntent, fresWithSrlg, l1LinkFresForHomeRoute, l1NcpTransportServices, resiliencyFre, fresLookupByName,staticRouteL3VPN, l1NcpLinkFres,eviId,rtList<br><br>tunnelReplacement cannot be used in combination with other named queries<br><br>photonicSncpWorkLegs can not be used alone, networkConstruct.Id must be provided with this named query<br><br>relatedFresFull can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>relatedFresLight can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>relatedRoadmlineSeedsForIntent can not be used alone, namedQueryParam1 must be provided with this named query<br><br>l1LinkFresForHomeRoute can not be used alone, namedQueryParam1 must be provided with this named query<br><br>resiliencyFre can not be used alone, namedQueryParam1 must be provided with this named query<br><br>groupedSNCDTLSET cannot be used in combination with other named queries and can not be used alone, namedQueryParam1  must be provided with this named query.<br><br>fresLookupByName can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>staticRouteL3VPN can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>l1NcpLinkFres can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>eviId can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>cfmAdminState can not be used alone, namedQueryParam1 must be provided with this named query.<br><br>rtList can not be used alone, namedQueryParam1 must be provided with this named query.'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: Mandatory when namedQuery relatedFresFull/relatedFresLight/relatedRoadmlineSeedsForIntent/l1LinkFresForHomeRoute/resiliencyFre/l1NcpLinkFres is used.
        style: form
        explode: true
        schema:
          type: string
      - name: relatedServices
        in: query
        description: '(Optional) when namedQuery relatedFresFull is used. NA results in all Fres with no relatedServices. NOT query is supported. The allowed relatedServices values are: Sncp, Link diverse, Bundle diverse, Absolute diverse'
        style: form
        explode: true
        schema:
          type: string
      - name: domainTypes
        in: query
        description: (Optional) Allow filtering on FRE domainTypes. NA results in all Fres with no domainTypes. NOT query is supported. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          type: string
      - name: resilienceLevel
        in: query
        description: '(Optional) Allow filtering on FRE domainTypes. NA results in all Fres with no resilienceLevel. NOT query is supported. This parameter accepts a list of comma separated values. The allowed resilienceLevel values: unprotected, partial, protected'
        style: form
        explode: true
        schema:
          type: string
      - name: partitionFreIds
        in: query
        description: (Optional) Retrieves all parent FREs that have the specified FRE as a partition relation. NA results in all Fres with no partitionFreIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: decomposedFreIds
        in: query
        description: (Optional) Retrieves all parent FREs that have the specified FRE as a decomposed relation. NA results in all Fres with no decomposedFreIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: facilityBypass
        in: query
        description: "(Optional) Allow filtering of FRE's with facilityBypass tunnels. NA results in all Fres with no facilityBypass. The allowed facilityBypass value: exclude"
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: (Optional) The child FRE identifier to return its parents. NA results in all Fres with no childFreId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: gneSubnetName
        in: query
        description: (Optional) GNE Subnet name of the FRES. NA results in all Fres with no gneSubnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: routingConstraints.inclusionConstraints.id
        in: query
        description: (Optional) Retrieves all FREs that have an inclusion constraint relationship to the specified identifier. NA results in all Fres with no routingInclusionConstraintsId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayDeploymentState
        in: query
        description: (Optional) Allow filtering on FRE deploymentState display string. NA results in all Fres with no displayDeploymentState. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: ncTags
        in: query
        description: (Optional) List of comma-separated network construct tags that is an endpoint for an FRE. NA results in all Fres with no ncTags. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayRecoveryCharacteristicsOnHome
        in: query
        description: (Optional) Allow filtering on FRE resiliency controller recovery characteristics onHome display string. NA results in all Fres with no displayRecoveryCharacteristicsOnHome. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: remoteOSRPNodeName
        in: query
        description: (Optional) Allow filtering of DTLSet fres on the basis of destination osrp node name. NA results in all Fres with no remoteOSRPNodeName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: headOSRPNodeName
        in: query
        description: (Optional) Allow filtering of DTLSet fres on the basis of head osrp node name. NA results in all Fres with no headOSRPNodeName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: isUsedByService
        in: query
        description: (Optional) Allow filtering of DTLSet fres on the basis of whether they are used by snc/sncg or not. NA results in all Fres with no isUsedByService. NOT query is supported. The allowed isUsedByService values are true/false
        style: form
        explode: true
        schema:
          type: string
      - name: isDTLSetUsedAsRoutingConstraint
        in: query
        description: (Optional) Allow filtering of DTLSet FREs on the basis of whether they are referenced by an snc/sncg or not. NA results in all Fres with no value set. NOT query is supported. The allowed values are true/false
        style: form
        explode: true
        schema:
          type: string
      - name: isOtdrCapable
        in: query
        description: (Optional) List all fres that have OTDR capable links. NA results in all Fres with no isOtdrCapable. NOT query is supported. The allowed isOtdrCapable value is true
        style: form
        explode: true
        schema:
          type: string
      - name: sourceTraceType
        in: query
        description: (Optional) Allow filtering of source trace type. NA results in all Fres with no source trace type. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceTraceTimestamp
        in: query
        description: (Optional) Allow filtering of source trace timestamp. NA results in all Fres with no source trace time stamp. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationTraceType
        in: query
        description: (Optional) Allow filtering of destination trace type. NA results in all Fres with no destination trace type. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationTraceTimestamp
        in: query
        description: (Optional) Allow filtering of destination trace time stamp. NA results in all Fres with no destination trace time stamp. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceOtdrcfgaId
        in: query
        description: (Optional) Allow filtering of source OTDR cfg aid. NA results in all Fres with no source OTDR cfg aid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceNcId
        in: query
        description: (Optional) Allow filtering of source NC ID. NA results in all Fres with no ssource NC ID. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationOtdrcfgaId
        in: query
        description: (Optional) Allow filtering of destination OTDR cfg aid. NA results in all Fres with no destination OTDR cfg aid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destinationNcId
        in: query
        description: (Optional) Allow filtering of destination NC id. NA results in all Fres with no destination NC id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: isSubmarineLink
        in: query
        description: (Optional) List all fres that have isSubmarineLink. NA results in all Fres with no isSubmarineLink. NOT query is supported. The allowed isSubmarineLink value is true
        style: form
        explode: true
        schema:
          type: string
      - name: ovpnIds
        in: query
        description: (Optional) List of comma separated ovpnIds (0-255). NA results in all Fres with no ovpnIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: partitioningFreIds
        in: query
        description: (Optional) Retrieves all child FREs that have the specified FRE as a partitioning relation. NA results in all Fres with no partitioningFreIds. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: internalStructure
        in: query
        description: '(Optional) Allow filtering on the FRE Internal Structure. This parameter accepts a list of comma separated values. NA results in all Fres with no internalStructure. NOT query is supported. The allowed internalStructure values are: SIMPLE,SIMPLE_SWITCHED,PROTECTED_ONE_END, MULTI_SIMPLE, MULTIPLE,PROTECTED_BOTH_ENDSMULTIPOINT, HUB_AND_SPOKE,EXPLICIT,INTERCONNECT_ONE_END,UNKNOWN,FULL_MESH,PARTIAL_MESH'
        style: form
        explode: true
        schema:
          type: string
      - name: exportRouteTargets
        in: query
        description: (Optional) Allow filtering support on Export Route Targets
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: importRouteTargets
        in: query
        description: (Optional) Allow filtering support on Import Route Targets
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filterType
        in: query
        description: >-
          (Optional) FilterType used in case search fres based on export Route Target or Import Route Target.

          if FilterType = Both, then search fres based on importRouteTarget OR exportRouteTarget.

          else, fres search based on importRouteTarget AND exportRouteTarget
        style: form
        explode: true
        schema:
          type: string
      - name: nativeName
        in: query
        description: (Optional) Allow filtering support on Native Name. NA results in all Fres with no nativeName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) Allow filtering support on Display Name. NA results in all Fres with no displayName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: peerSNCIdentifier
        in: query
        description: (Optional) Allow filtering support on Peer SNC Identifier. NA results in all Fres with no peerSNCIdentifier. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: interfaceName/interfaceIP
        in: query
        description: (Optional) Filter support on Interface Name or Interface IP.
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.averageUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput averageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.startAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput startAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.endAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput endAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.maxUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput maxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.startMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput startMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.endMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput endMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.ninetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput ninetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.startNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput startNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: dailyThroughput.endNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE daily throughput endNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.averageUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput averageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.startAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput startAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.endAverageUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput endAverageUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.maxUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput maxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.startMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput startMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.endMaxUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput endMaxUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.ninetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput ninetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.startNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput startNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: weeklyThroughput.endNinetyFifthUtilization
        in: query
        description: (Optional) Allow filtering on FRE weekly throughput endNinetyFifthUtilization
        style: form
        explode: true
        schema:
          type: string
      - name: completeness
        in: query
        description: '(Optional) Allow filtering on type of FlexE and G8032 completeness. NA results in all Fres with no Completeness. NOT query is supported. This parameter accepts a list of comma separated values. The allowed Completeness values are: partial, complete'
        style: form
        explode: true
        schema:
          type: string
      - name: misconfigured
        in: query
        description: '(Optional) Allow filtering on type of FlexE misconfigurations. This parameter accepts a list of comma separated values. The allowed misconfigured values are: true or false'
        style: form
        explode: true
        schema:
          type: string
      - name: destinationPrefix
        in: query
        description: (Optional) Allow filtering support on destinationPrefix.
        style: form
        explode: true
        schema:
          type: string
      - name: selectedRoute
        in: query
        description: (Optional) Allow filtering support on Selected Route.
        style: form
        explode: true
        schema:
          type: string
      - name: vrfName
        in: query
        description: (Optional) Allow filtering support on Vrf Name.
        style: form
        explode: true
        schema:
          type: string
      - name: nextHopIp
        in: query
        description: (Optional) Allow filtering support on NextHop Ip.
        style: form
        explode: true
        schema:
          type: string
      - name: vrfId
        in: query
        description: (Optional) Allow filtering support on VRF Id.
        style: form
        explode: true
        schema:
          type: string
      - name: statsCollectionOperational
        in: query
        description: '(Optional) Allow filtering on value of IPDATA statsCollectionOperational. NA results in all Fres with no statsCollectionOperational. NOT query is supported. This parameter accepts a list of comma separated values. The allowed statsCollectionOperational values are: partial, on, off'
        style: form
        explode: true
        schema:
          type: string
      - name: dmmState
        in: query
        description: '(Optional) Allow filtering on value of IPDATA dmmState. NA results in all Fres with no dmmState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed dmmState values are: enabled, disabled, partial'
        style: form
        explode: true
        schema:
          type: string
      - name: slmState
        in: query
        description: '(Optional) Allow filtering on value of IPDATA slmState. NA results in all Fres with no slmState. NOT query is supported. This parameter accepts a list of comma separated values. The allowed slmState values are: enabled, disabled, partial'
        style: form
        explode: true
        schema:
          type: string
      - name: signalingType
        in: query
        description: (Optional) Allow filtering support on signaling Type. NA results in all Fres with no signalingType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sourceEndPoint
        in: query
        description: (Optional) Allow filtering support on source End Point. NA results in all Fres with no sourceEndPoint. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: destEndPoint
        in: query
        description: (Optional) Allow filtering support on destination End Point. NA results in all Fres with no destEndPoint. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: bindingAllocatedSid
        in: query
        description: (Optional) Allow filtering support on SR TE Binding Allocated Sid. NA results in all Fres with no bindingAllocatedSid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: cfmAdminState
        in: query
        description: (Optional) Allow filtering support on CfmAdminState
        style: form
        explode: true
        schema:
          type: string
      - name: color
        in: query
        description: (Optional) Allow filtering support on color
        style: form
        explode: true
        schema:
          type: string
      - name: displayServerRefreshState
        in: query
        description: (Optional) Allow filtering support on the displayData server refresh state
        style: form
        explode: true
        schema:
          type: string
      - name: serviceRefresh.state
        in: query
        description: (Optional) Allow filtering support on the server refresh state
        style: form
        explode: true
        schema:
          type: string
      - name: serviceRefresh.status
        in: query
        description: (Optional) Allow filtering support on the server refresh status
        style: form
        explode: true
        schema:
          type: string
      - name: transportPolicy
        in: query
        description: (Optional) Allow filtering support on transportPolicy Type. NA results in all Fres with no transportPolicy. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: catalog
        in: query
        description: (Optional) Allow filtering support on catalog. NA results in all Fres with no catalog. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: srColor
        in: query
        description: (Optional) Allow filtering support on vrf Sr color NA results in all Fres with no color. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: fallback
        in: query
        description: (Optional) Allow filtering support on fallback. NA results in all Fres with no fallback. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: ringStatus
        in: query
        description: '(Optional) Allow filtering on Status of G8032 ring. This parameter accepts a list of comma separated values: OK, Local signal failure, Local force switch, Remote signal failure, Remote force switch, Provisioning mismatch, Not receiving PDUs, No RPL owner detected, Unknown'
        style: form
        explode: true
        schema:
          type: string
      - name: ringState
        in: query
        description: '(Optional) Allow filtering on State of G8032 ring. This parameter accepts a list of comma separated values: Initializing, OK, Admin disabled, Operational disabled, Protecting, Recovering, Manual switch, Force switch, Unknown'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: metaDataFields
        in: query
        description: 'MetaData to be included. The allowed values are: layerRate, layerRateQualifier, signalContentType, serviceClass, sncgUserlabel, adminState, operationState, lqsData.status, lqsData.margin.valid, lqsData.fiber.reconciled, lqsData.fiber.method, lqsData.margin.viableAtEol, displayAdminState, displayOperationState, displayTopologySource, customerName, domainTypes, resilienceLevel, directionality, displayDeploymentState, ringType, ringCompleteness, displayRecoveryCharacteristicsOnHome, lqsData.ppg.snrStatus, internalStructure, lqsData.ppg.categorySnrReference, lqsData.ppg.deltaSnrReference, totalCapacity, usedCapacity, utilizationPercent, capacityUnits, restorationHealth.totalExplicitRoutes, restorationHealth.availableExplicitRoutes, restorationHealth.unavailableExplicitRoutes, restorationHealth.availablePercentage, restorationHealth.unavailablePercentage, restorationHealth.homeAvailable, remoteOSRPNodeName, headOSRPNodeName, isDTLSetUsedAsRoutingConstraint, importRouteTargets, exportRouteTargets, relatedServices, signalingType, sourceEndPoint, destEndPoint, bindingAllocatedSid, transportPolicy, catalog, srColor, fallback, cfmAdminState, color, dailyThroughput.averageUtilization, dailyThroughput.maxUtilization, dailyThroughput.ninetyFifthUtilization, weeklyThroughput.averageUtilization, weeklyThroughput.maxUtilization, weeklyThroughput.ninetyFifthUtilization, remoteOSRPNodeName, headOSRPNodeName, isDTLSetUsedAsRoutingConstraint, importRouteTargets, exportRouteTargets, destinationPrefix, selectedRoute, vrfName, vrfId, nextHopIp, relatedServices, isOtdrCapable, sourceTraceType, sourceTraceTimestamp, destinationTraceType, destinationTraceTimestamp, sourceOtdrcfgaId, sourceNcId, destinationOtdrcfgaId, destinationNcId, displayServerRefreshState, nativeName, isSubmarineLink'
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, networkConstructs, planned, freDiscovered, frePlanned, supportedByFreResiliencyClientTpes, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - fres
      summary: searchPostFresV21
      description: >2-

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKey=key1,key2,...&identifierValue=value1,value2,...
        For instance:
             ?identifierKey=nodalId&identifierValue=nodalIdValue<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "layerRate": "OTSi",
          "directionality": "unidirectional",
          "networkRole": "FREAP",
          "type": "service",
          "limit": "50"
        }</code></pre>
      operationId: searchPostFresV21
      parameters: []
      requestBody:
        description: FRE search parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreSearchParamsRO'
              - description: FRE search parameters
        required: false
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2/search/fres/{freId}:
    get:
      tags:
      - fres
      summary: getFreByIdV2
      description: Retrieves a specific FRE
      operationId: getFreByIdV2
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, controllers, srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/search/groups:
    get:
      tags:
      - groups
      summary: searchGroups
      description: >2-

        Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchGroups
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of Group identifiers to retrieve. NA results in all Groups with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search with, combined with searchText. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: name
        in: query
        description: (Optional) Comma separated list of group names to retrieve. NA results in all Groups with no name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: groupType
        in: query
        description: (Optional) Comma separated list of groupTypes to retrieve. NA results in all Groups with no groupType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: parentGroup
        in: query
        description: (Optional) Comma separated list of parentGroups to retrieve. NA results in all Groups with no parentGroup. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed value is: groupPlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested Groups.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested Groups.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/search/groups:
    get:
      tags:
      - groups
      summary: GetgetGroups1
      description: >2-

        Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
             etc</ul>
          *NOT, OR, AND keywords are case-insensitive
          *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: GetgetGroups1
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of Group identifiers to retrieve. NA results in all Groups with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search with, combined with searchText. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: name
        in: query
        description: (Optional) Comma separated list of group names to retrieve. NA results in all Groups with no name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: groupType
        in: query
        description: (Optional) Comma separated list of groupTypes to retrieve. NA results in all Groups with no groupType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: parentGroup
        in: query
        description: (Optional) Comma separated list of parentGroups to retrieve. NA results in all Groups with no parentGroup. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed value is: groupPlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of Groups.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the Groups with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/search/networkConstructs:
    get:
      tags:
      - networkConstructs
      summary: searchNcs
      description: "Discovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: <ul>1). When querying using identifiers, the supported syntax is as follows: \n   ?identifierKey=key1,key2,...&identifierValue=value1,value2,... \nFor instance, \n   ?identifierKey=subnetName&identifierValue=PV0438A---PV0428D---SUBNET</ul><ul>2). When querying by NOT, the supported syntax is as follows:<ul>\n     1. NOT(\"A\")\n     2. NOT(\"A\" OR \"B\")\n     3. NOT(\"A\" AND \"B\")\n     etc</ul>\n  *NOT, OR, AND keywords are case-insensitive\n  *Brackets with NOT are optional, for ex: NOT \"A\" is valid</ul><ul>3). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>"
      operationId: searchNcs
      parameters:
      - name: id
        in: query
        description: (Optional) List of networkConstruct Ids. NA results in all NetworkConstructs with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of networkConstruct planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: sessionId
        in: query
        description: (Optional) List of Management Session Ids. NA results in all NetworkConstructs with no sessionId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id. NA results in all NetworkConstructs with no eqpIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id. NA results in all NetworkConstructs with no serviceIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id. NA results in all NetworkConstructs with no physicalLocationId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of device name values. NA results in all NetworkConstructs with no name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values. NA results in all NetworkConstructs with no displayName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: The identifier key list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: The identifier value list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct. NA results in all NetworkConstructs with no concrete. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct. NA results in all NetworkConstructs with no ipAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: '(Optional) List of Network Construct types. NA results in all NetworkConstructs with no type. NOT query is supported. The allowed networkConstructType values are: networkElement, shelf, osrpNode'
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes. NA results in all NetworkConstructs with no resourceType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. NA results in all NetworkConstructs with no associationState. NOT query is supported. The allowed associationState values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: syncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no syncState. NOT query is supported. The allowed syncState values are: notSynchronized, synchronizing, synchronized, failed, aborted, deleting, deleteFailed'
        style: form
        explode: true
        schema:
          type: string
      - name: softwareVersion
        in: query
        description: (Optional) List of networkConstruct software versions. NA results in all NetworkConstructs with no softwareVersion. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: nativeSoftwareVersion
        in: query
        description: (Optional) List of networkConstruct native software versions. NA results in all NetworkConstructs with no nativeSoftwareVersion. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displaySyncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no displaySyncState. NOT query is supported. The allowed displaySyncState values are: planned, notSynchronized, synchronizing, synchronized, failed, pending, deleting'
        style: form
        explode: true
        schema:
          type: string
      - name: displayInventorySyncFailureReason
        in: query
        description: (Optional) List of networkConstruct inventory sync failure reasons. NA results in all NetworkConstructs with no displayInventorySyncFailureReason. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayResourceState
        in: query
        description: '(Optional) List of networkConstruct resourceStates. NA results in all NetworkConstructs with no displayResourceState. NOT query is supported. The allowed displayResourceState values are: root, planned, discovered, unknown'
        style: form
        explode: true
        schema:
          type: string
      - name: displayAssociationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. NA results in all NetworkConstructs with no displayAssociationState. NOT query is supported. The allowed displayAssociationState values are: Connected, Not connected'
        style: form
        explode: true
        schema:
          type: string
      - name: subnetName
        in: query
        description: (Optional) The subnet name list. NA results in all NetworkConstructs with no subnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: macAddress
        in: query
        description: (Optional) macAddress parameter used to filter results. NA results in all NetworkConstructs with no macAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups. NA results in all NetworkConstructs with no typeGroup. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: slteType
        in: query
        description: '(Optional)  slteType parameter used to filter results. NA results in all NetworkConstructs with no slteType. NOT query is supported. The allowed slteType value: SLTE'
        style: form
        explode: true
        schema:
          type: string
      - name: ssteType
        in: query
        description: '(Optional)  ssteType parameter used to filter spectrum sharing terminal network element. NA results in all NetworkConstructs with no ssteType. NOT query is supported. The allowed ssteType value: SSTE'
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) List of resourcePartitionInfo
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on NC tags. NA results in all NetworkConstructs with no tags. NOT query is supported. This parameter accepts a list of comma separated strings
        style: form
        explode: true
        schema:
          type: string
      - name: rrConfigured
        in: query
        description: '(Optional) List of networkConstruct based on BGP RRConfiguration. NA results in all NetworkConstructs with no rrConfigured. NOT query is supported. The allowed rrConfigured values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: OADMCapabilityNodes, OADMCapabilityNodesV2, networkConstructsWithSrlg, networkConstructsWithShareSrlg, l1ControlPlaneNodes, lookupNetworkConstructsByName, networkConstructsWithNativeMPLS'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: 'namedQueryParam1 must be provided for namedQuery: lookupNetworkConstructsByName'
        style: form
        explode: true
        schema:
          type: string
      - name: geoDistanceQuery
        in: query
        description: '(Optional) Filters on distance from a specified location; the Geo distance query is formatted as follows: <distance>:<latitude>:<longitude>'
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifier
        in: query
        description: '(Optional) Association state qualifier. NA results in all NetworkConstructs with no associationStateQualifier. NOT query is supported. The allowed associationStateQualifier values are: MANUAL, SYSTEM, NETWORK'
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) List of srlg values separated by comma. NA results in all NetworkConstructs with no srlg. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteId
        in: query
        description: (Optional) Site ID for the networkConstruct. NA results in all NetworkConstructs with no siteId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteName
        in: query
        description: (Optional) SiteName for the networkConstruct. NA results in all NetworkConstructs with no siteName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: prefixSid
        in: query
        description: (Optional) PrefixSid. NA results in all NetworkConstructs with no prefixSid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: loopbackAddresses
        in: query
        description: (Optional) List of LoopbackAddresses. NA results in all NetworkConstructs with no loopbackAddresses. NOT query is supported.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, syncState, networkConstructType, resourceState, softwareVersion, nativeSoftwareVersion, displaySyncState, displayResourceState, displayAssociationState, tags, subnetName, associationStateQualifier, resourcePartitionInfo, equippedSlot.utilizationTotalCapacity, equippedSlot.utilizationUsedCapacity, equippedSlot.utilizationPercent, equippedPluggable.utilizationTotalCapacity, equippedPluggable.utilizationUsedCapacity, equippedPluggable.utilizationPercent, inUseByServiceSlot.utilizationTotalCapacity, inUseByServiceSlot.utilizationUsedCapacity, inUseByServiceSlot.utilizationPercent, inUseByServicePluggable.utilizationTotalCapacity, inUseByServicePluggable.utilizationUsedCapacity, inUseByServicePluggable.utilizationPercent, networkConstructName'
        style: form
        explode: true
        schema:
          type: string
      - name: metaLimit
        in: query
        description: (Optional) Size of metadata returned
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned, srlgs, utilization, timing'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/search/networkConstructs:
    get:
      tags:
      - networkConstructs
      summary: searchNcsV1
      description: "Discovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: <ul>1). When querying using identifiers, the supported syntax is as follows: \n   ?identifierKey=key1,key2,...&identifierValue=value1,value2,... \nFor instance, \n   ?identifierKey=subnetName&identifierValue=PV0438A---PV0428D---SUBNET</ul><ul>2). When querying by NOT, the supported syntax is as follows:<ul>\n     1. NOT(\"A\")\n     2. NOT(\"A\" OR \"B\")\n     3. NOT(\"A\" AND \"B\")\n     etc</ul>\n  *NOT, OR, AND keywords are case-insensitive\n  *Brackets with NOT are optional, for ex: NOT \"A\" is valid</ul><ul>3). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>"
      operationId: searchNcsV1
      parameters:
      - name: id
        in: query
        description: (Optional) List of networkConstruct Ids. NA results in all NetworkConstructs with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of networkConstruct planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: sessionId
        in: query
        description: (Optional) List of Management Session Ids. NA results in all NetworkConstructs with no sessionId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id. NA results in all NetworkConstructs with no eqpIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id. NA results in all NetworkConstructs with no serviceIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id. NA results in all NetworkConstructs with no physicalLocationId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of device name values. NA results in all NetworkConstructs with no name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values. NA results in all NetworkConstructs with no displayName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: The identifier key list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: The identifier value list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct. NA results in all NetworkConstructs with no concrete. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct. NA results in all NetworkConstructs with no ipAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: '(Optional) List of Network Construct types. NA results in all NetworkConstructs with no type. NOT query is supported. The allowed networkConstructType values are: networkElement, shelf, osrpNode, manual, branchingUnit, submarineRepeater, foreignNode'
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes. NA results in all NetworkConstructs with no resourceType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. NA results in all NetworkConstructs with no associationState. NOT query is supported. The allowed associationState values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: syncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no syncState. NOT query is supported. The allowed syncState values are: notSynchronized, synchronizing, synchronized, failed, timeout, aborted, deleting, deleteFailed'
        style: form
        explode: true
        schema:
          type: string
      - name: softwareVersion
        in: query
        description: (Optional) List of networkConstruct software versions. NA results in all NetworkConstructs with no softwareVersion. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displaySyncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no displaySyncState. NOT query is supported. The allowed displaySyncState values are: planned, notSynchronized, synchronizing, synchronized, failed, pending, deleting, timeout'
        style: form
        explode: true
        schema:
          type: string
      - name: displayInventorySyncFailureReason
        in: query
        description: (Optional) List of networkConstruct inventory sync failure reasons. NA results in all NetworkConstructs with no displayInventorySyncFailureReason. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayResourceState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no displayResourceState. NOT query is supported. The allowed displayResourceState values are: root, planned, discovered, unknown'
        style: form
        explode: true
        schema:
          type: string
      - name: displayAssociationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. NA results in all NetworkConstructs with no displayAssociationState. NOT query is supported. The allowed displayAssociationState values are: Connected, Not connected'
        style: form
        explode: true
        schema:
          type: string
      - name: subnetName
        in: query
        description: (Optional) The subnet name list. NA results in all NetworkConstructs with no subnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: macAddress
        in: query
        description: (Optional) macAddress parameter used to filter results. NA results in all NetworkConstructs with no macAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups NA results in all NetworkConstructs with no typeGroup. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: slteType
        in: query
        description: '(Optional)  slteType parameter used to filter results. NA results in all NetworkConstructs with no slteType. NOT query is supported. The allowed slteType value: SLTE'
        style: form
        explode: true
        schema:
          type: string
      - name: ssteType
        in: query
        description: '(Optional)  ssteType parameter used to filter spectrum sharing terminal network element. NA results in all NetworkConstructs with no ssteType. NOT query is supported. The allowed ssteType value: SSTE'
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) List of resourcePartitionInfo
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on NC tags. NA results in all NetworkConstructs with no tags. NOT query is supported. This parameter accepts a list of comma separated strings
        style: form
        explode: true
        schema:
          type: string
      - name: rrConfigured
        in: query
        description: '(Optional) List of networkConstruct based on BGP RRConfiguration. NA results in all NetworkConstructs with no rrConfigured. NOT query is supported. The allowed rrConfigured values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: OADMCapabilityNodes, OADMCapabilityNodesV2, networkConstructsWithSrlg, networkConstructsWithShareSrlg, l1ControlPlaneNodes, lookupNetworkConstructsByName, networkConstructsWithNativeMPLS'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: 'namedQueryParam1 must be provided for namedQuery: lookupNetworkConstructsByName'
        style: form
        explode: true
        schema:
          type: string
      - name: geoDistanceQuery
        in: query
        description: '(Optional) Filters on distance from a specified location; the Geo distance query is formatted as follows: <distance>:<latitude>:<longitude>'
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifier
        in: query
        description: '(Optional) Association state qualifier. NA results in all NetworkConstructs with no associationStateQualifier. NOT query is supported. The allowed associationStateQualifier values are: MANUAL, SYSTEM, NETWORK'
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) List of srlg values separated by comma. NA results in all NetworkConstructs with no srlg. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteId
        in: query
        description: (Optional) Site ID for the networkConstruct. NA results in all NetworkConstructs with no siteId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteName
        in: query
        description: (Optional) SiteName for the networkConstruct. NA results in all NetworkConstructs with no siteName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: prefixSid
        in: query
        description: (Optional) PrefixSid. NA results in all NetworkConstructs with no prefixSid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, syncState, networkConstructType, resourceState, softwareVersion, displaySyncState, displayResourceState, displayAssociationState, tags, subnetName, associationStateQualifier, resourcePartitionInfo, equippedSlot.utilizationTotalCapacity, equippedSlot.utilizationUsedCapacity, equippedSlot.utilizationPercent, equippedPluggable.utilizationTotalCapacity, equippedPluggable.utilizationUsedCapacity, equippedPluggable.utilizationPercent, inUseByServiceSlot.utilizationTotalCapacity, inUseByServiceSlot.utilizationUsedCapacity, inUseByServiceSlot.utilizationPercent, inUseByServicePluggable.utilizationTotalCapacity, inUseByServicePluggable.utilizationUsedCapacity, inUseByServicePluggable.utilizationPercent, networkConstructName'
        style: form
        explode: true
        schema:
          type: string
      - name: metaLimit
        in: query
        description: (Optional) Size of metadata returned
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned, srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2/search/networkConstructs:
    get:
      tags:
      - networkConstructs
      summary: searchNcsV2
      description: "Discovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: <ul>1). When querying using identifiers, the supported syntax is as follows: \n   ?identifierKey=key1,key2,...&identifierValue=value1,value2,... \nFor instance, \n   ?identifierKey=subnetName&identifierValue=PV0438A---PV0428D---SUBNET</ul><ul>2). When querying by NOT, the supported syntax is as follows:<ul>\n     1. NOT(\"A\")\n     2. NOT(\"A\" OR \"B\")\n     3. NOT(\"A\" AND \"B\")\n     etc</ul>\n  *NOT, OR, AND keywords are case-insensitive\n  *Brackets with NOT are optional, for ex: NOT \"A\" is valid</ul><ul>3). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>"
      operationId: searchNcsV2
      parameters:
      - name: id
        in: query
        description: (Optional) List of networkConstruct Ids. NA results in all NetworkConstructs with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of networkConstruct planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: sessionId
        in: query
        description: (Optional) List of Management Session Ids. NA results in all NetworkConstructs with no sessionId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id. NA results in all NetworkConstructs with no eqpIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id. NA results in all NetworkConstructs with no serviceIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id. NA results in all NetworkConstructs with no physicalLocationId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of device name values. NA results in all NetworkConstructs with no name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values. NA results in all NetworkConstructs with no displayName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: The identifier key list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: The identifier value list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct. NA results in all NetworkConstructs with no concrete. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct. NA results in all NetworkConstructs with no ipAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: '(Optional) List of Network Construct types. NA results in all NetworkConstructs with no type. NOT query is supported. The allowed networkConstructType values are: networkElement, shelf, osrpNode, manual, branchingUnit, submarineRepeater, foreignNode'
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes. NA results in all NetworkConstructs with no resourceType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. NA results in all NetworkConstructs with no associationState. NOT query is supported. The allowed associationState values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: syncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no syncState. NOT query is supported. The allowed syncState values are: notSynchronized, synchronizing, synchronized, failed, timeout, aborted, deleting, deleteFailed'
        style: form
        explode: true
        schema:
          type: string
      - name: softwareVersion
        in: query
        description: (Optional) List of networkConstruct software versions. NA results in all NetworkConstructs with no softwareVersion. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: nativeSoftwareVersion
        in: query
        description: (Optional) List of networkConstruct native software versions. NA results in all NetworkConstructs with no nativeSoftwareVersion. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displaySyncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no displaySyncState. NOT query is supported. The allowed displaySyncState values are: planned, notSynchronized, synchronizing, synchronized, failed, pending, deleting, timeout'
        style: form
        explode: true
        schema:
          type: string
      - name: displayInventorySyncFailureReason
        in: query
        description: (Optional) List of networkConstruct inventory sync failure reasons. NA results in all NetworkConstructs with no displayInventorySyncFailureReason. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: displayResourceState
        in: query
        description: '(Optional) List of networkConstruct syncStates. NA results in all NetworkConstructs with no displayResourceState. NOT query is supported. The allowed displayResourceState values are: root, planned, discovered, unknown'
        style: form
        explode: true
        schema:
          type: string
      - name: displayAssociationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. NA results in all NetworkConstructs with no displayAssociationState. NOT query is supported. The allowed displayAssociationState values are: Connected, Not connected'
        style: form
        explode: true
        schema:
          type: string
      - name: subnetName
        in: query
        description: (Optional) The subnet name list. NA results in all NetworkConstructs with no subnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: macAddress
        in: query
        description: (Optional) macAddress parameter used to filter results. NA results in all NetworkConstructs with no macAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups. NA results in all NetworkConstructs with no typeGroup. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: slteType
        in: query
        description: '(Optional)  slteType parameter used to filter results. NA results in all NetworkConstructs with no slteType. NOT query is supported. The allowed slteType value: SLTE'
        style: form
        explode: true
        schema:
          type: string
      - name: ssteType
        in: query
        description: '(Optional)  ssteType parameter used to filter spectrum sharing terminal network element. NA results in all NetworkConstructs with no ssteType. NOT query is supported. The allowed ssteType value: SSTE'
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedSlot.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct slot end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: equippedPluggable.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct pluggable end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServiceSlot.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service slot end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationTotalCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization total capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationUsedCapacity
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization used capacity
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.utilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.startUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable start utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: inUseByServicePluggable.endUtilizationPercent
        in: query
        description: (Optional) Allow filtering on networkConstruct used by service pluggable end utilization percent
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) List of resourcePartitionInfo
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on NC tags. NA results in all NetworkConstructs with no tags. NOT query is supported. This parameter accepts a list of comma separated strings
        style: form
        explode: true
        schema:
          type: string
      - name: rrConfigured
        in: query
        description: '(Optional) List of networkConstruct based on BGP RRConfiguration. NA results in all NetworkConstructs with no rrConfigured. NOT query is supported. The allowed rrConfigured values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: OADMCapabilityNodes, OADMCapabilityNodesV2, networkConstructsWithSrlg, networkConstructsWithShareSrlg, l1ControlPlaneNodes, lookupNetworkConstructsByName, networkConstructsWithNativeMPLS'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: 'namedQueryParam1 must be provided for namedQuery: lookupNetworkConstructsByName'
        style: form
        explode: true
        schema:
          type: string
      - name: geoDistanceQuery
        in: query
        description: '(Optional) Filters on distance from a specified location; the Geo distance query is formatted as follows: <distance>:<latitude>:<longitude>'
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifier
        in: query
        description: '(Optional) Association state qualifier. NA results in all NetworkConstructs with no associationStateQualifier. NOT query is supported. The allowed associationStateQualifier values are: MANUAL, SYSTEM, NETWORK'
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) List of srlg values separated by comma. NA results in all NetworkConstructs with no srlg. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteId
        in: query
        description: (Optional) Site ID for the networkConstruct. NA results in all NetworkConstructs with no siteId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: siteName
        in: query
        description: (Optional) SiteName for the networkConstruct. NA results in all NetworkConstructs with no siteName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: prefixSid
        in: query
        description: (Optional) PrefixSid. NA results in all NetworkConstructs with no prefixSid. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: loopbackAddresses
        in: query
        description: (Optional) List of LoopbackAddresses. NA results in all NetworkConstructs with no loopbackAddresses. NOT query is supported.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, syncState, networkConstructType, resourceState, softwareVersion, displaySyncState, displayResourceState, displayAssociationState, tags, subnetName, associationStateQualifier, resourcePartitionInfo, equippedSlot.utilizationTotalCapacity, equippedSlot.utilizationUsedCapacity, equippedSlot.utilizationPercent, equippedPluggable.utilizationTotalCapacity, equippedPluggable.utilizationUsedCapacity, equippedPluggable.utilizationPercent, inUseByServiceSlot.utilizationTotalCapacity, inUseByServiceSlot.utilizationUsedCapacity, inUseByServiceSlot.utilizationPercent, inUseByServicePluggable.utilizationTotalCapacity, inUseByServicePluggable.utilizationUsedCapacity, inUseByServicePluggable.utilizationPercent, networkConstructName'
        style: form
        explode: true
        schema:
          type: string
      - name: metaLimit
        in: query
        description: (Optional) Size of metadata returned
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned, srlgs, utilization, timing'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/search/tpes:
    get:
      tags:
      - tpes
      summary: searchTpes
      description: >-
        The following search paths are not supported for the searchFields query parameter:<ul><li>data.attributes.tpeSpec<li>data.attributes.tpeGroupSpecs<li>data.attributes.locations.loc_oid<li>data.attributes.capacityReservations.*<li>data.attributes.syncScopes.*<li>data.relationships.networkConstructAssociation.data.id</ul><p>Specifying a path for the searchFields parameter of an attribute in the following objects will search the parent object for the value specified in searchText: adjacencyPackage, powerPackage, photonicSpectrumPackage, and signalIndex.<p>To specify an expectation path for the searchFields parameter use the prefix "data.relationships.tpeExpectations.data.*"<ul></ul>Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
                etc</ul>
         *NOT, OR, AND keywords are case-insensitive
         *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchTpes
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of TPE identifiers to retrieve. NA results in all Tpes with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name) Fields not supported under this filter are `data.attributes.layerTerminations.layerProtocol.*`
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of networkConstruct planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: ptpEthernetNoClients, portsEthernetAvailableAll, portsL2AvailableAll, portsL2ApplicableEPLUni, portsL2ApplicableEVPLUni, portsL2ApplicableEnni, portsL2ApplicableEPLUniWithMcLag, portsL2ApplicableEVPLUniWithMcLag, portsL2ApplicableEnniWithMcLag, portsTunnelsL2ApplicableAll, ipInterfacesL2ApplicableIpLink, portsTunnelsL2ApplicableAllWithFtpIpData, portsTDMCEApplicableAll, channelTxPorts, channelRxPorts, linePorts, tpesWithSrlg, matedTpes, tpesLookupByName, l1OsrpLinkHomeRouteTpes <br><br>l1OsrpLinkHomeRouteTpes must be provided with , namedQueryParam1(Transport Client ID)<br><br>matedTpes cannot be used in combination with other named queries and can not be used alone, namedQueryParam1(tpeId),namedQueryParam2(Allowed values can be CHANNEL/OTN_ACCESS) and namedQueryParam3(Allowed values can be Working/Protect) must be provided with this named query.esiId must be provided with , namedQueryParam1(name to be searched upon)'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: First param to be used by defined namedQuery.
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam2
        in: query
        description: Second param to be used by defined namedQuery.
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam3
        in: query
        description: Third param to be used by defined namedQuery.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. NA results in all Tpes with no ncId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalNeName
        in: query
        description: (Optional) Network Construct name. NA results in all Tpes with no NC name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: (Optional) The comma separated identifier value set
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete tpe. NA results in all Tpes with no concreteId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: bookingData.lockout
        in: query
        description: '(Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed. NA results in all Tpes with no bwLockout. NOT query is supported. The allowed bwLockout values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: layerRate
        in: query
        description: (optional) The layerRate. When combined with the adjacencyType queryParam, only looks for thespecified list of adjacencyTypes within the specified layerRate.
        style: form
        explode: true
        schema:
          type: string
      - name: adjacencyType
        in: query
        description: (optional) The adjacencyType. When combined with the layerRate queryParam, only looks for thespecified list of adjacencyTypes within the specified layerRate.
        style: form
        explode: true
        schema:
          type: string
      - name: active
        in: query
        description: '(Optional) The active state of the resource. NA results in all Tpes with no active. NOT query is supported. The allowed active values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: content
        in: query
        description: (Optional) The TPE content level
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content1'
          - description: (Optional) The TPE content level
      - name: location
        in: query
        description: (Optional) TPE location delimited by dashes
        style: form
        explode: true
        schema:
          type: string
      - name: locationFormat
        in: query
        description: (Optional) Format for the given location; when not given, assume location is [[shelf-]slot-]port
        style: form
        explode: true
        schema:
          type: string
      - name: structureType
        in: query
        description: (Optional) Comma separated list of TPE structure types. NA results in all Tpes with no structureType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentId
        in: query
        description: (Optional) Equipment identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id. NA results in all Tpes with no eqpIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id. NA results in all Tpes with no serviceIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.intent.id
        in: query
        description: (Optional) The intent id. NA results in all Tpes with no intentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.intent.type
        in: query
        description: (Optional) The intent type. NA results in all Tpes with no intentType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) List of srlg values separated by comma. NA results in all Tpes with no srlg. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional)IP Address. NA results in all Tpes with no ipAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: esiId
        in: query
        description: (Optional) Esi Id. Present in Ethernet Segment data in EVPN VPWS service.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: gneSubnetName
        in: query
        description: (Optional) GNE Subnet name of the TPE. NA results in all Tpes with no gneSubnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: stackDirection, layerRate, state, cardType, structureType, structureSubType, resourceState'
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, tpePlanned, tpeDiscovered, concrete, networkConstructs, srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: subslot
        in: query
        description: (Optional) Subslot ([shelf]-[slot]-[subslot]-[port]) value . Use with tdmLayerRatewithpacketiwfList namedQuery
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/search/tpes:
    get:
      tags:
      - tpes
      summary: searchTpesV1
      description: >-
        The following search paths are not supported for the searchFields query parameter:<ul><li>data.attributes.tpeSpec<li>data.attributes.tpeGroupSpecs<li>data.attributes.locations.loc_oid<li>data.attributes.capacityReservations.*<li>data.attributes.syncScopes.*<li>data.relationships.networkConstructAssociation.data.id</ul><p>Specifying a path for the searchFields parameter of an attribute in the following objects will search the parent object for the value specified in searchText: adjacencyPackage, powerPackage, photonicSpectrumPackage, and signalIndex.<p>To specify an expectation path for the searchFields parameter use the prefix "data.relationships.tpeExpectations.data.*"<ul></ul>Note: <ul>1). When querying by NOT, the supported syntax is as follows:<ul>
             1. NOT("A")
             2. NOT("A" OR "B")
             3. NOT("A" AND "B")
                etc</ul>
         *NOT, OR, AND keywords are case-insensitive
         *Brackets with NOT are optional, for ex: NOT "A" is valid</ul><ul>2). NOT_AVAILABLE/NULL parameter is supported with NA in parameter value.</ul>
      operationId: searchTpesV1
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of TPE identifiers to retrieve. NA results in all Tpes with no id. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name) Fields not supported under this filter are `data.attributes.layerTerminations.layerProtocol.*`
        style: form
        explode: true
        schema:
          type: string
      - name: searchType
        in: query
        description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/searchType1'
          - description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
      - name: resourceState
        in: query
        description: '(Optional) List of networkConstruct planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: ptpEthernetNoClients, portsEthernetAvailableAll, portsL2AvailableAll, portsL2ApplicableEPLUni, portsL2ApplicableEVPLUni, portsL2ApplicableEnni, portsL2ApplicableEPLUniWithMcLag, portsL2ApplicableEVPLUniWithMcLag, portsL2EthAndFlexeportsL2ApplicableEnniWithMcLag, portsTunnelsL2ApplicableAll, ipInterfacesL2ApplicableIpLink,  portsTunnelsL2ApplicableAllWithFtpIpData, portsTDMCEApplicableAll, channelTxPorts, channelRxPorts, linePorts, matedTpes, tpesWithSrlg, tpesWithShareSrlg, tpesLookupByName, l1OsrpLinkHomeRouteTpes<br><br>tpesLookupByName must be provided with , namedQueryParam1(name to be searched upon)l1OsrpLinkHomeRouteTpes must be provided with , namedQueryParam1(Transport Client ID)<br><br>matedTpes cannot be used in combination with other named queries and can not be used alone, namedQueryParam1(tpeId),namedQueryParam2(Values are CHANNEL/OTN_ACCESS) and namedQueryParam3(Values are Working/Protect) must be provided with this named query.<br><br>evpnId must be provided with , namedQueryParam1(name to be searched upon)<br><br>esiId must be provided with , namedQueryParam1(name to be searched upon)'
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam1
        in: query
        description: First param to be used by defined namedQuery.
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam2
        in: query
        description: Second param to be used by defined namedQuery.
        style: form
        explode: true
        schema:
          type: string
      - name: namedQueryParam3
        in: query
        description: Third param to be used by defined namedQuery.
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. NA results in all Tpes with no ncId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: physicalNeName
        in: query
        description: (Optional) Network Construct name. NA results in all Tpes with no NC name. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: (Optional) The comma separated identifier value set
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete tpe. NA results in all Tpes with no concreteId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: bookingData.lockout
        in: query
        description: '(Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed. NA results in all Tpes with no bwLockout. NOT query is supported. The allowed bwLockout values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: layerRate
        in: query
        description: (optional) The layerRate. When combined with the adjacencyType queryParam, only looks for thespecified list of adjacencyTypes within the specified layerRate.
        style: form
        explode: true
        schema:
          type: string
      - name: adjacencyType
        in: query
        description: (optional) The adjacencyType. When combined with the layerRate queryParam, only looks for thespecified list of adjacencyTypes within the specified layerRate.
        style: form
        explode: true
        schema:
          type: string
      - name: active
        in: query
        description: '(Optional) The active state of the resource. NA results in all Tpes with no active. NOT query is supported. The allowed active values are: true, false'
        style: form
        explode: true
        schema:
          type: string
      - name: content
        in: query
        description: (Optional) The TPE content level
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content1'
          - description: (Optional) The TPE content level
      - name: location
        in: query
        description: (Optional) TPE location delimited by dashes
        style: form
        explode: true
        schema:
          type: string
      - name: locationFormat
        in: query
        description: (Optional) Format for the given location; when not given, assume location is [[shelf-]slot-]port
        style: form
        explode: true
        schema:
          type: string
      - name: structureType
        in: query
        description: (Optional) Comma separated list of TPE structure types. NA results in all Tpes with no structureType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentId
        in: query
        description: (Optional) Equipment identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id. NA results in all Tpes with no eqpIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id. NA results in all Tpes with no serviceIntentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.intent.id
        in: query
        description: (Optional) The intent id. NA results in all Tpes with no intentId. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.intent.type
        in: query
        description: (Optional) The intent type. NA results in all Tpes with no intentType. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMin
        in: query
        description: "(Optional) Minimum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: startDateMax
        in: query
        description: "(Optional) Maximum value of startDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMin
        in: query
        description: "(Optional) Minimum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: endDateMax
        in: query
        description: "(Optional) Maximum value of endDate, format is: yyyy-MM-dd'T'HH:mm:ss.SSSZ"
        style: form
        explode: true
        schema:
          type: string
      - name: gneSubnetName
        in: query
        description: (Optional) GNE Subnet name of the TPE. NA results in all Tpes with no gneSubnetName. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) List of srlg values separated by comma. NA results in all Tpes with no srlg. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address. NA results in all Tpes with no ipAddress. NOT query is supported.
        style: form
        explode: true
        schema:
          type: string
      - name: esiId
        in: query
        description: (Optional) Esi Id. Present in Ethernet Segment data in EVPN VPWS service.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: stackDirection, layerRate, state, cardType, structureType, structureSubType, resourceState'
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataQualifiers
        in: query
        description: '(Optional) List of meta data options. The allowed values are: absoluteTotals'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, tpePlanned, tpeDiscovered, concrete, networkConstructs, srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: subslot
        in: query
        description: (Optional) Subslot ([shelf]-[slot]-[subslot]-[port]) value . Use with tdmLayerRatewithpacketiwfList namedQuery
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /kafkacomet/api/v1/socket:
    get:
      tags:
      - Socket
      summary: GetactiveKafkatopicwebsocketconnections
      description: Get active Kafka topic websocket connections
      operationId: GetactiveKafkatopicwebsocketconnections
      parameters: []
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
        '500':
          description: Error
          headers: {}
          content: {}
      deprecated: false
  /kafkacomet/api/v1/socket/{topic}:
    get:
      tags:
      - Socket
      summary: GetactiveKafkatopicwebsocketconnectionsbytopic
      description: Get active Kafka topic websocket connections by topic
      operationId: GetactiveKafkatopicwebsocketconnectionsbytopic
      parameters:
      - name: topic
        in: path
        description: Kafka topic name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/socketClient'
                description: ''
        '404':
          description: Not found, no subscribers to topic
          headers: {}
          content: {}
        '500':
          description: Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/reports/clients:
    get:
      tags:
      - Clients
      summary: getClients
      description: Get Clients within a given report
      operationId: getClients
      parameters:
      - name: reportId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: features
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: clients
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: partNumbers
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: size
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
            application/json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
        '400':
          description: Bad page size
          headers: {}
          content: {}
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/reports/clients/export:
    get:
      tags:
      - Clients
      summary: exportAllClients
      description: Get all clients for the current report
      operationId: exportAllClients
      parameters:
      - name: reportId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
            application/json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
        '409':
          description: Export request in progress
          headers: {}
          content: {}
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/reports/features:
    get:
      tags:
      - Features
      summary: getFeatures
      description: Get Features within a given report
      operationId: getFeatures
      parameters:
      - name: reportId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: features
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: partNumbers
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: size
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
            application/json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
        '400':
          description: Bad page size
          headers: {}
          content: {}
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/reports/features/export:
    get:
      tags:
      - Features
      summary: exportAllFeatures
      description: Get all Features within a given report
      operationId: exportAllFeatures
      parameters:
      - name: reportId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
            application/json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
        '409':
          description: Export request in progress
          headers: {}
          content: {}
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing-feature/api/v1/features/getAllLicenses:
    get:
      tags:
      - Licenses
      summary: getAllLicenses
      description: Return all MCP licenses and their current state
      operationId: getAllLicenses
      parameters: []
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResponseListRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseListRO'
        '500':
          description: Encountered an internal error
          headers: {}
          content: {}
      deprecated: false
  /licensing-feature/api/v1/features/getLicense:
    get:
      tags:
      - Licenses
      summary: getLicense
      description: 'Checks for an mcp license with given name. Other licenses not related to MCP will return a 406 Not Acceptable response. Example: mcp-base-license'
      operationId: getLicense
      parameters:
      - name: commonName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: featureName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/FeatureResponseInterface'
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureResponseInterface'
        '400':
          description: Must have one of name or feature
          headers: {}
          content: {}
        '406':
          description: Not an acceptable license name
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/loadLicense:
    post:
      tags:
      - Load License file to license server
      summary: loadLicense
      description: Loads license file to license servers
      operationId: loadLicense
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                site:
                  type: string
                  default: primary
        required: false
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content: {}
        '409':
          description: Too many requests
          headers: {}
          content: {}
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/register:
    get:
      tags:
      - Register
      summary: register
      description: Register the license server
      operationId: register
      parameters: []
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/File'
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/oms/{projectId}:
    get:
      tags:
      - Reports
      summary: GeneratetheOMSreportfortheprojectnetwork
      description: Generate the OMS report for the project network
      operationId: GeneratetheOMSreportfortheprojectnetwork
      parameters:
      - name: projectId
        in: path
        description: The planning project id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.OmsReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/equipment/{projectId}:
    get:
      tags:
      - Reports
      summary: Generatetheequipmentreportfortheprojectnetwork
      description: Generate the equipment report for the project network
      operationId: Generatetheequipmentreportfortheprojectnetwork
      parameters:
      - name: projectId
        in: path
        description: The planning project id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.EquipmentReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/networkReportData:
    get:
      tags:
      - Reports
      summary: GeneratetheNetworkData
      description: Generate the Network Data
      operationId: GeneratetheNetworkData
      parameters: []
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Automation.NetworkReportData'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/equipment/{projectId}/delta:
    get:
      tags:
      - Reports
      summary: Generatetheequipmentdeltareportfortheprojectnetwork
      description: Generate the equipment delta report for the project network
      operationId: Generatetheequipmentdeltareportfortheprojectnetwork
      parameters:
      - name: projectId
        in: path
        description: The planning project id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.EquipmentDeltaReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/nodeandequipmentdata/{projectId}:
    get:
      tags:
      - Reports
      summary: Generatethenodeandequipmentdatareportfortheprojectnetwork
      description: Generate the node and equipment data report for the project network
      operationId: Generatethenodeandequipmentdatareportfortheprojectnetwork
      parameters:
      - name: projectId
        in: path
        description: The planning project id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.ProjectNodeAndEquipmentDataReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/importvalidation/{projectId}:
    get:
      tags:
      - Reports
      summary: >-
        Gettheimportvalidationreportforaproject



        <para/>Returnsacachedversionofthereportifitexists.
      description: >-
        Get the import validation report for a project



        <para />Returns a cached version of the report if it exists.
      operationId: >-
        Gettheimportvalidationreportforaproject



        <para/>Returnsacachedversionofthereportifitexists.
      parameters:
      - name: projectId
        in: path
        description: The planning project ID
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.RuleExecutionReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/importvalidation:
    get:
      tags:
      - Reports
      summary: >-
        Gettheimportvalidationreportforaproject



        <para/>Returnsacachedversionofthereportifitexists.1
      description: >-
        Get the import validation report for a project



        <para />Returns a cached version of the report if it exists.
      operationId: >-
        Gettheimportvalidationreportforaproject



        <para/>Returnsacachedversionofthereportifitexists.1
      parameters:
      - name: projectName
        in: query
        description: The planning project name
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.RuleExecutionReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/importvalidation/{projectId}/execute:
    post:
      tags:
      - Reports
      summary: Executesimportvalidationontheproject
      description: Executes import validation on the project
      operationId: Executesimportvalidationontheproject
      parameters:
      - name: projectId
        in: path
        description: The planning project ID
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.RuleExecutionReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Reports/importvalidation/execute:
    post:
      tags:
      - Reports
      summary: PostExecutesimportvalidationontheproject
      description: Executes import validation on the project
      operationId: PostExecutesimportvalidationontheproject
      parameters:
      - name: projectName
        in: query
        description: The planning project name
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reports.RuleExecutionReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /licensing/api/v1/licensing/reports:
    get:
      tags:
      - Reports
      summary: listReports
      description: Get all current reports
      operationId: listReports
      parameters:
      - name: cursor
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: size
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
            application/json:
              schema:
                $ref: '#/components/schemas/CursorListRO'
        '400':
          description: Bad page size
          headers: {}
          content: {}
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Reports
      summary: createReport
      description: Creates a new report or returns an in progress report ID.
      operationId: createReport
      parameters: []
      requestBody:
        description: Report request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ReportRequestObject'
              - description: Report request
        required: false
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ReportRequestRO'
                - description: The information regarding the request of a report
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ReportRequestRO'
                - description: The information regarding the request of a report
        '409':
          description: Report Conflict
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/reports/report:
    get:
      tags:
      - Reports
      summary: getReport
      description: Get the report with corresponding reportId value
      operationId: getReport
      parameters:
      - name: reportId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: meta
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Report'
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '404':
          description: Report not found
          headers: {}
          content: {}
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/status:
    get:
      tags:
      - Status
      summary: getServiceStatus
      description: Get the licensing service status
      operationId: getServiceStatus
      parameters: []
      responses:
        '200':
          description: Successful Operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/StatusRO'
                - description: The status of the licensing service
        '500':
          description: Service Error
          headers: {}
          content: {}
      deprecated: false
  /licensing/api/v1/licensing/triggerHealthCheck:
    post:
      tags:
      - Status
      summary: triggerHealthCheck
      description: Trigger an immediate license server health check
      operationId: triggerHealthCheck
      parameters: []
      responses:
        '200':
          description: Triggering of health check was successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
      deprecated: false
  /licensing/api/v1/licensing/updateAll:
    post:
      tags:
      - Status
      summary: updateAll
      description: Trigger an immediate update of all licenses
      operationId: updateAll
      parameters: []
      responses:
        '200':
          description: Triggering of license update was successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRO'
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/add-extended-sub-domains:
    post:
      tags:
      - application-slices
      summary: AddExtendedSubDomainsToApplicationSlice
      description: Add extended subdomains to the specified application slice
      operationId: AddExtendedSubDomainsToApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice for which extended subdomains are to be added
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Specifies the IDs of the extended subdomains to be added
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AppSliceSubDomains'
              - description: Specifies the IDs of the extended subdomains to be added
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
        '201':
          description: Created
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/remove-extended-sub-domains:
    post:
      tags:
      - application-slices
      summary: RemoveExtendedSubDomainsFromApplicationSlice
      description: Remove extended subdomains from the specified application slice
      operationId: RemoveExtendedSubDomainsFromApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice for which subdomains are to be added and/or removed
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Specifies the IDs of the subdomains to be removed
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AppSliceSubDomains'
              - description: Specifies the IDs of the subdomains to be removed
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
        '201':
          description: Created
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices:
    get:
      tags:
      - application-slices
      summary: ListApplicationSlices
      description: Get all of the application slices in the market
      operationId: ListApplicationSlices
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply16'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply16'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - application-slices
      summary: CreateApplicationSlice
      description: Create an application slice using the information in the provided application slice object
      operationId: CreateApplicationSlice
      parameters: []
      requestBody:
        description: Specification defining a application slice
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ApplicationSlicesRequest'
              - description: Specification defining a application slice
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/count:
    get:
      tags:
      - application-slices
      summary: CountApplicationSlices
      description: Count the application slices in the market
      operationId: CountApplicationSlices
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}:
    get:
      tags:
      - application-slices
      summary: GetApplicationSlice
      description: Get a specific application slice from the market
      operationId: GetApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifier of the requested application slice
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - application-slices
      summary: UpdateApplicationSlice
      description: Update an application slice in the market based on the data in the provided instance
      operationId: UpdateApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifier of the application slice to update
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Specification defining an application slice
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ApplicationSlicesRequest1'
              - description: Specification defining an application slice
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - application-slices
      summary: DeleteApplicationSlice
      description: Delete an application slice from the market
      operationId: DeleteApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifier of the application slice to delete
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - application-slices
      summary: PatchApplicationSlice
      description: Patch update an application slice in the market based on the data in the provided instance
      operationId: PatchApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifier of the application slice to update
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Partial application slice object specifying the data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ApplicationSlicesRequest1'
              - description: Partial application slice object specifying the data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplicationSlice'
                - description: Information describing an application slice
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/parents:
    get:
      tags:
      - application-slices
      summary: ListParentApplicationSlices
      description: Lists parent slices of the given application slice id
      operationId: ListParentApplicationSlices
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose parent slices are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect parent application-slices as well, i.e., parent of the parent, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/children:
    get:
      tags:
      - application-slices
      summary: ListChildrenApplicationSlices
      description: Lists all children slices of the given application slice id
      operationId: ListChildrenApplicationSlices
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose children slices are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect children application slices as well, i.e., children of the children, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply16'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply16'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/sub-domains:
    get:
      tags:
      - application-slices
      summary: ListApplicationSliceSubDomains
      description: Lists all non-extended subdomains of the given application slice
      operationId: ListApplicationSliceSubDomains
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/sub-domains/count:
    get:
      tags:
      - application-slices
      summary: CountApplicationSliceSubDomains
      description: Count non-extended subdomains of the given application slice
      operationId: CountApplicationSliceSubDomains
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/extended-sub-domains:
    get:
      tags:
      - application-slices
      summary: ListApplicationSliceExtendedSubDomains
      description: Lists all extended subdomains of the given application slice by id
      operationId: ListApplicationSliceExtendedSubDomains
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose extended subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/extended-sub-domains/count:
    get:
      tags:
      - application-slices
      summary: CountApplicationSliceExtendedSubDomains
      description: Count extended subdomains of the given application slice by id
      operationId: CountApplicationSliceExtendedSubDomains
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose extended subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/children/count:
    get:
      tags:
      - application-slices
      summary: CountChildrenApplicationSlices
      description: Count children slices of the given application slice id
      operationId: CountChildrenApplicationSlices
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose children slices are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect children application slices as well, i.e., children of the children, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/parents/count:
    get:
      tags:
      - application-slices
      summary: CountParentApplicationSlices
      description: Count parent slices of the given application slice id
      operationId: CountParentApplicationSlices
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice whose parent slices are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect parent application-slices as well, i.e., parent of the parent, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/remove-sub-domains:
    post:
      tags:
      - application-slices
      summary: RemoveSubDomainsFromApplicationSlice
      description: Remove subdomains from the specified application slice
      operationId: RemoveSubDomainsFromApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice for which subdomains are to be removed
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Specifies the IDs of the subdomains to be removed
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AppSliceSubDomains'
              - description: Specifies the IDs of the subdomains to be removed
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
        '201':
          description: Created
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/application-slices/{applicationSliceId}/add-sub-domains:
    post:
      tags:
      - application-slices
      summary: AddSubDomainsToApplicationSlice
      description: Add subdomains to the specified application slice
      operationId: AddSubDomainsToApplicationSlice
      parameters:
      - name: applicationSliceId
        in: path
        description: Identifies the application slice for which subdomains are to be added
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Specifies the IDs of the subdomains to be added
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AppSliceSubDomains'
              - description: Specifies the IDs of the subdomains to be added
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationSliceSubDomainsReport'
        '201':
          description: Created
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domain-types:
    get:
      tags:
      - domain-types
      summary: ListDomainTypes
      description: Get all of the domain types in the market
      operationId: ListDomainTypes
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply24'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply24'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domain-types/count:
    get:
      tags:
      - domain-types
      summary: CountDomainTypes
      description: Count all of the domain types in the market
      operationId: CountDomainTypes
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domains/count:
    get:
      tags:
      - domains
      summary: CountDomains
      description: Count the domains in the market
      operationId: CountDomains
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domains:
    get:
      tags:
      - domains
      summary: ListDomains
      description: Get all of the domains in the market
      operationId: ListDomains
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply7'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply7'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - domains
      summary: CreateDomain
      description: Create a domain in the market using the provided properties
      operationId: CreateDomain
      parameters:
      - name: validate
        in: query
        description: Whether to use a custom validator
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: Properties defining a domain
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1DomainsRequest'
              - description: Properties defining a domain
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domains/validate:
    post:
      tags:
      - domains
      summary: ValidateDomainCreate
      description: Validate domain creation in market using the provided properties
      operationId: ValidateDomainCreate
      parameters:
      - name: full
        in: query
        description: Whether to perform a full validation request
        required: true
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        description: Properties defining a domain
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1DomainsValidateRequest'
              - description: Properties defining a domain
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domains/{domainId}:
    get:
      tags:
      - domains
      summary: GetDomain
      description: Get a specific domain from the market
      operationId: GetDomain
      parameters:
      - name: domainId
        in: path
        description: Identifier of the domain being queried
        required: true
        style: simple
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - domains
      summary: UpdateDomain
      description: The id from the Domain object parameter is optional and ignored on update.
      operationId: UpdateDomain
      parameters:
      - name: domainId
        in: path
        description: Identifier of the domain to update
        required: true
        style: simple
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: Specification defining a domain
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1DomainsRequest1'
              - description: Specification defining a domain
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - domains
      summary: DeleteDomain
      description: Delete a domain from the market
      operationId: DeleteDomain
      parameters:
      - name: domainId
        in: path
        description: Identifier of the domain to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - domains
      summary: PatchDomain
      description: The id from the Domain object parameter is optional and ignored on update.
      operationId: PatchDomain
      parameters:
      - name: domainId
        in: path
        description: Identifier of the domain to update
        required: true
        style: simple
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: The partial domain data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1DomainsRequest1'
              - description: The partial domain data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Domain'
                - description: Represents an autonomous domain provider
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domains/{domainId}/products:
    get:
      tags:
      - domains
      summary: ListProductsByDomain
      description: List all of the products offered by a specific domain
      operationId: ListProductsByDomain
      parameters:
      - name: domainId
        in: path
        description: Identifier of the domain whose product offerings are being queried
        required: true
        style: simple
        schema:
          type: string
      - name: includeInactive
        in: query
        description: If false, returns only products that are actively offered; if true, returns all products
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply11'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply11'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/domains/{domainId}/resync:
    post:
      tags:
      - domains
      summary: ResyncDomain
      description: Execute a resync request for the specified domain
      operationId: ResyncDomain
      parameters:
      - name: domainId
        in: path
        description: Identifier of the domain to be resynced
        required: true
        style: simple
        schema:
          type: string
      - name: full
        in: query
        description: Whether the requeset is for a full resync
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '202':
          description: Accepted
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncReply'
                - description: Information describing the reply of a resync request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncReply'
                - description: Information describing the reply of a resync request
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/unclaimed/{type}:
    get:
      tags:
      - jobs
      summary: ListUnclaimedJobs
      description: Retrieves a page of up to <code>maxCount</code> unclaimed jobs. When <code>afterJobId</code> is unspecified, the API returns the first page. For the next page, set <code>afterJobId</code> to the last <code>jobId</code> of the last response.
      operationId: ListUnclaimedJobs
      parameters:
      - name: type
        in: path
        description: Job type
        required: true
        style: simple
        schema:
          type: string
      - name: maxWait
        in: query
        description: Maximum wait time in milliseconds before returning results (maximum 120000)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 60000
      - name: minCount
        in: query
        description: Minimum number of jobs to return (unless maxWait is exceeded)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1
      - name: maxCount
        in: query
        description: Maximum number of jobs to return in a page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      - name: afterJobId
        in: query
        description: The last jobId of the page preceding the desired page
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply8'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply8'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/claimed/{type}/count:
    get:
      tags:
      - jobs
      summary: CountClaimedJobs
      description: Count jobs that have been claimed but not completed for a given job type
      operationId: CountClaimedJobs
      parameters:
      - name: type
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: state
        in: query
        description: Optional query parameter to filter to only executing or suspended jobs
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/state261'
          - description: Optional query parameter to filter to only executing or suspended jobs
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply6'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply6'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/claimed/{type}:
    get:
      tags:
      - jobs
      summary: ListClaimedJobs
      description: Retrieves claimed jobs whose state are either executing or suspended. Use the state parameter to further limit the results to one of the two states.
      operationId: ListClaimedJobs
      parameters:
      - name: type
        in: path
        description: Job type
        required: true
        style: simple
        schema:
          type: string
      - name: state
        in: query
        description: Optional query parameter to filter to only executing or suspended jobs
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/state261'
          - description: Optional query parameter to filter to only executing or suspended jobs
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ClaimedJob'
                - description: A digest version of the Job entity for executing jobs
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ClaimedJob'
                - description: A digest version of the Job entity for executing jobs
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/{jobId}:
    get:
      tags:
      - jobs
      summary: GetJob
      description: Get a job by Id
      operationId: GetJob
      parameters:
      - name: jobId
        in: path
        description: Identifier of the job being queried
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/{jobId}/claim:
    post:
      tags:
      - jobs
      summary: ClaimJob
      description: Claim a job for execution
      operationId: ClaimJob
      parameters:
      - name: jobId
        in: path
        description: Identifier of the job to claim
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Job claim executor information
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1JobsClaimRequest'
              - description: Job claim executor information
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '415':
          description: Unsupported Media Type
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/{jobId}/execution-status:
    get:
      tags:
      - jobs
      summary: CheckJobOnly
      description: Retrieve executor job status if claimed job is executing or suspended
      operationId: CheckJobOnly
      parameters:
      - name: jobId
        in: path
        description: Identifier of the job to check
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/CheckJobStatusResponse'
                - description: Response for CheckJob
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/CheckJobStatusResponse'
                - description: Response for CheckJob
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - jobs
      summary: CheckJobModify
      description: Retrieve job executor status if claimed job is executing or suspended, possibly fail the job based on results
      operationId: CheckJobModify
      parameters:
      - name: jobId
        in: path
        description: Identifier of the job to check
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/CheckJobStatusResponse'
                - description: Response for CheckJob
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/CheckJobStatusResponse'
                - description: Response for CheckJob
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/{jobId}/progress:
    put:
      tags:
      - jobs
      summary: PutJobProgress
      description: Report job execution progress
      operationId: PutJobProgress
      parameters:
      - name: jobId
        in: path
        description: Identifier of the job whose execution is in progress
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Job progress description
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1JobsProgressRequest'
              - description: Job progress description
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
      deprecated: false
  /bpocore/market/api/v1/jobs/{jobId}/result:
    put:
      tags:
      - jobs
      summary: PutJobResult
      description: Report a job execution result
      operationId: PutJobResult
      parameters:
      - name: jobId
        in: path
        description: Identifier of the job whose execution is complete
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Job execution result information
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1JobsResultRequest'
              - description: Job execution result information
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Job'
                - description: Job entity tracking the execution of a resource operation
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/jobs/{jobId}/suspended:
    put:
      tags:
      - jobs
      summary: PutJobSuspended
      description: Suspend or resume a job
      operationId: PutJobSuspended
      parameters:
      - name: jobId
        in: path
        description: Identifier of the job to be suspended or resumed
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Desired job suspension state
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1JobsSuspendedRequest'
              - description: Desired job suspension state
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/products:
    get:
      tags:
      - products
      summary: ListProducts
      description: Get all of the products in the market
      operationId: ListProducts
      parameters:
      - name: includeInactive
        in: query
        description: If false, returns only products that are actively offered; if true, returns all products
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply11'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply11'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - products
      summary: CreateProduct
      description: Returns the created product object
      operationId: CreateProduct
      parameters: []
      requestBody:
        description: Specification defining a product
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ProductsRequest'
              - description: Specification defining a product
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/products/count:
    get:
      tags:
      - products
      summary: CountProducts
      description: Count products in the market
      operationId: CountProducts
      parameters:
      - name: includeInactive
        in: query
        description: If false, returns only products that are actively offered; if true, returns all products
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/products/{productId}:
    get:
      tags:
      - products
      summary: GetProduct
      description: Get the product from the market based on its product identifier
      operationId: GetProduct
      parameters:
      - name: productId
        in: path
        description: Identifier of the product being queried
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - products
      summary: UpdateProduct
      description: The id from the Product object is optional and ignored on update.
      operationId: UpdateProduct
      parameters:
      - name: productId
        in: path
        description: Identifier of the product to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The complete product data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ProductsRequest'
              - description: The complete product data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - products
      summary: DeleteProduct
      description: A product that is in use (pending orders or active resources refer to it) cannot be deleted.
      operationId: DeleteProduct
      parameters:
      - name: productId
        in: path
        description: Identifier of the product being delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - products
      summary: PatchProduct
      description: The id from the Product object is optional and ignored on update.
      operationId: PatchProduct
      parameters:
      - name: productId
        in: path
        description: Identifier of the product to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The partial product data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ProductsRequest'
              - description: The partial product data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Product'
                - description: Information describing a product
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/products/{productId}/resync:
    post:
      tags:
      - products
      summary: ResyncProduct
      description: Execute a resync request for the specified product
      operationId: ResyncProduct
      parameters:
      - name: productId
        in: path
        description: Identifier of the product to be resynced
        required: true
        style: simple
        schema:
          type: string
      - name: full
        in: query
        description: Whether the requeset is for a full resync
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '202':
          description: Accepted
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncReply'
                - description: Information describing the reply of a resync request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncReply'
                - description: Information describing the reply of a resync request
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/relationships:
    get:
      tags:
      - relationships
      summary: ListRelationships
      description: List all of the relationships registered with the Market
      operationId: ListRelationships
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: relationshipTypeId
        in: query
        description: Optional query to limit relationships by the relationship type (including derived types)
        style: form
        explode: true
        schema:
          type: string
      - name: exactRelationshipTypeId
        in: query
        description: Optional query to limit relationships by an exact relationship type
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply13'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply13'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - relationships
      summary: CreateRelationship
      description: Create a new relationship in Market
      operationId: CreateRelationship
      parameters: []
      requestBody:
        description: Specification defining a relationship
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1RelationshipsRequest'
              - description: Specification defining a relationship
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Relationship'
                - description: Information describing a single relationship
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Relationship'
                - description: Information describing a single relationship
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/relationships/count:
    get:
      tags:
      - relationships
      summary: CountRelationships
      description: Count the relationships registered with the Market
      operationId: CountRelationships
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: relationshipTypeId
        in: query
        description: Optional query to limit relationships by the relationship type (including derived types)
        style: form
        explode: true
        schema:
          type: string
      - name: exactRelationshipTypeId
        in: query
        description: Optional query to limit relationships by an exact relationship type
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/relationships/unresolved:
    get:
      tags:
      - relationships
      summary: ListUnresolvedRelationships
      description: List all unresolved relationships in Market
      operationId: ListUnresolvedRelationships
      parameters:
      - name: resourceId
        in: query
        description: Identifier of the resource whose unresolved relationships to be listed
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply18'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply18'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/relationships/unresolved/count:
    get:
      tags:
      - relationships
      summary: CountUnresolvedRelationships
      description: Count unresolved relationships in Market
      operationId: CountUnresolvedRelationships
      parameters:
      - name: resourceId
        in: query
        description: Identifier of the resource whose unresolved relationships to be listed
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/relationships/{relationshipId}:
    get:
      tags:
      - relationships
      summary: GetRelationship
      description: Get the relationship from the market
      operationId: GetRelationship
      parameters:
      - name: relationshipId
        in: path
        description: Identifier of the relationship being queried
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Relationship'
                - description: Information describing a single relationship
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Relationship'
                - description: Information describing a single relationship
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - relationships
      summary: DeleteRelationship
      description: Delete a relationship
      operationId: DeleteRelationship
      parameters:
      - name: relationshipId
        in: path
        description: Identifier of the relationship
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-providers:
    get:
      tags:
      - resource-providers
      summary: ListResourceProviders
      description: Get all of the resource providers in the market
      operationId: ListResourceProviders
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply21'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply21'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - resource-providers
      summary: CreateResourceProvider
      description: Create a resource provider using the information in the provided resource provider object
      operationId: CreateResourceProvider
      parameters: []
      requestBody:
        description: Specification defining a resource provider (id is ignored in creation request)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourceProvidersRequest'
              - description: Specification defining a resource provider (id is ignored in creation request)
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-providers/count:
    get:
      tags:
      - resource-providers
      summary: CountResourceProviders
      description: Count the resource providers in the market
      operationId: CountResourceProviders
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-providers/{resourceProviderId}:
    get:
      tags:
      - resource-providers
      summary: GetResourceProvider
      description: Get a specific resource provider from the market
      operationId: GetResourceProvider
      parameters:
      - name: resourceProviderId
        in: path
        description: Identifier of the requested resource provider
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - resource-providers
      summary: UpdateResourceProvider
      description: The id from the ResourceProvider object parameter is ignored on update.
      operationId: UpdateResourceProvider
      parameters:
      - name: resourceProviderId
        in: path
        description: Identifier of the resource provider to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a resource provider
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourceProvidersRequest'
              - description: Specification defining a resource provider
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - resource-providers
      summary: DeleteResourceProvider
      description: Delete a resource provider from the market
      operationId: DeleteResourceProvider
      parameters:
      - name: resourceProviderId
        in: path
        description: Identifier of the resource provider to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - resource-providers
      summary: PatchResourceProvider
      description: The id from the ResourceProvider object parameter is ignored on update.
      operationId: PatchResourceProvider
      parameters:
      - name: resourceProviderId
        in: path
        description: Identifier of the resource provider to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Partial resource provider object specifying the data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourceProvidersRequest'
              - description: Partial resource provider object specifying the data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceProvider'
                - description: Information describing a resource provider
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-providers/{resourceProviderId}/domains:
    get:
      tags:
      - resource-providers
      summary: ListDomainsByRp
      description: List all of the domains for a given resource provider
      operationId: ListDomainsByRp
      parameters:
      - name: resourceProviderId
        in: path
        description: Identifier of the resource provuder whose domains are being queried
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply7'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply7'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-types:
    get:
      tags:
      - resource-types
      summary: ListResourceTypes
      description: List all of the resource types in the Market
      operationId: ListResourceTypes
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: includeAbstract
        in: query
        description: If true, also includes abstract resource types
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply9'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply9'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-types/{resourceTypeId}:
    get:
      tags:
      - resource-types
      summary: GetResourceType
      description: Get a resource type by Id
      operationId: GetResourceType
      parameters:
      - name: resourceTypeId
        in: path
        description: Identifier of the resource type being queried
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceTypeDefinition'
                - description: Meta-information and content for a resource type
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceTypeDefinition'
                - description: Meta-information and content for a resource type
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-types/count:
    get:
      tags:
      - resource-types
      summary: CountResourceTypes
      description: Count the resource types in the Market
      operationId: CountResourceTypes
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: includeAbstract
        in: query
        description: If true, also includes abstract resource types
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resource-types/{resourceTypeId}/products:
    get:
      tags:
      - resource-types
      summary: ListProductsByResourceType
      description: List all of the products offered for the specific resource type
      operationId: ListProductsByResourceType
      parameters:
      - name: resourceTypeId
        in: path
        description: Products are filtered to those that are of this resource type
        required: true
        style: simple
        schema:
          type: string
      - name: includeInactive
        in: query
        description: If false, returns only products that are actively offered; if true, returns all products
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply11'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply11'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}:
    get:
      tags:
      - resources
      summary: GetResource
      description: Get a resource by Id
      operationId: GetResource
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource being queried
        required: true
        style: simple
        schema:
          type: string
      - name: full
        in: query
        description: If true, returns volatile status attributes from the provider that are not stored in the database
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: minRevision
        in: query
        description: Require the revision of the returned resource to be greater than or equal to minRevision. Respond with a 503 if the resource exists, but the revision does not meet the minRevision.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - resources
      summary: UpdateResource
      description: The id from the Resource object is optional and ignored on update.
      operationId: UpdateResource
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource to update
        required: true
        style: simple
        schema:
          type: string
      - name: validate
        in: query
        description: Whether to perform custom validation in addition to built-in schema and accessor validations
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: The resource data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesRequest'
              - description: The resource data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - resources
      summary: DeleteResource
      description: Delete a resource
      operationId: DeleteResource
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource
        required: true
        style: simple
        schema:
          type: string
      - name: validate
        in: query
        description: Whether to perform custom validation
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - resources
      summary: PatchResource
      description: The id from the Resource object is optional and ignored on update.
      operationId: PatchResource
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource to update
        required: true
        style: simple
        schema:
          type: string
      - name: validate
        in: query
        description: Whether to perform custom validation in addition to built-in schema and accessor validations
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: The partial resource data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesRequest1'
              - description: The partial resource data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources:
    get:
      tags:
      - resources
      summary: ListResources
      description: >-
        One (and only one) of productId, resourceTypeId or exactTypeId must be specified when using the q or p filters on properties.

        The Resource `differences` attribute supports q filtering whether any differences exist or not via `q=differences:empty` or `q=differences:nonEmpty` respectively.
      operationId: ListResources
      parameters:
      - name: productId
        in: query
        description: Optional query to limit resources by product type
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Optional query to limit resources by domain
        style: form
        explode: true
        schema:
          type: string
      - name: resourceProviderId
        in: query
        description: Optional query to limit resources by resource provider
        style: form
        explode: true
        schema:
          type: string
      - name: resourceTypeId
        in: query
        description: Optional query to limit resources by one or more resource types. Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: providerResourceId
        in: query
        description: Optional query to identify resource by provider resource ID
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Optional query to limit resources by one or more exact resource types (takes precedence over resourceTypeId). Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: subDomainId
        in: query
        description: Optional query to limit resources by one or more subdomain ids. Use a comma-separated string to specify multiple subdomain ids.
        style: form
        explode: true
        schema:
          type: string
      - name: applicationSliceId
        in: query
        description: Optional query to limit resources by the application slice id.
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: Optional query parameter to define a tag filter. May use whitespace-separated AND/OR query (e.g. (one:1) OR (two:2) AND (three:3)) syntax or tagKey:tagValue syntax
        style: form
        explode: true
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply10'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply10'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - resources
      summary: CreateResource
      description: Initial orchestration state is requested.  Poll resource until state is active or failed.
      operationId: CreateResource
      parameters:
      - name: validate
        in: query
        description: Whether to perform custom validation in addition to built-in schema and accessor validations
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: Specification defining a resource
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesRequest2'
              - description: Specification defining a resource
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/audit:
    post:
      tags:
      - resources
      summary: AuditResources
      description: >-
        Audit the resources by calling a GET asynchronously to the provider for each resource that matches the criteria.
                One of productId, domainId, or resourceProviderId must be specified.
                When using the q or p filters on properties, one (and only one) of productId, resourceTypeId or exactTypeId must be specified.
      operationId: AuditResources
      parameters:
      - name: productId
        in: query
        description: Identifier of the product whose resources should be audited
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Identifier of the domain whose resources should be audited
        style: form
        explode: true
        schema:
          type: string
      - name: resourceProviderId
        in: query
        description: Identifier of the provider whose resources should be audited
        style: form
        explode: true
        schema:
          type: string
      - name: resourceTypeId
        in: query
        description: Option to limit the audit to one or more resource types specified and their derived types. Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Option to limit the audit to one or more resource types specified (takes precedence over resourceTypeId). Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: Optional query parameter to define a tag filter using tagKey:tagValue syntax
        style: form
        explode: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuditReply'
                - description: Information describing an item of a audit request reply
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuditReply'
                - description: Information describing an item of a audit request reply
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/count:
    get:
      tags:
      - resources
      summary: CountResources
      description: 'Deprecated: (use /count-filtered) Count resources with filter.'
      operationId: CountResources
      parameters:
      - name: productId
        in: query
        description: Identifier of the product whose resources should be counted
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Identifier of the domain whose resources should be counted
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Identifier of the exact resource type whose resources should be counted
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/count-filtered:
    get:
      tags:
      - resources
      summary: GetCountResources
      description: >-
        One (and only one) of productId, resourceTypeId or exactTypeId must be specified when using the q or p filters on properties.
              The Resource `differences` attribute supports q filtering whether any differences exist or not via `q=differences:empty` or `q=differences:nonEmpty` respectively.
      operationId: GetCountResources
      parameters:
      - name: productId
        in: query
        description: Optional query to limit resources by product type
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Optional query to limit resources by domain
        style: form
        explode: true
        schema:
          type: string
      - name: resourceProviderId
        in: query
        description: Optional query to limit resources by resource provider
        style: form
        explode: true
        schema:
          type: string
      - name: resourceTypeId
        in: query
        description: Optional query to limit resources by one or more resource types. Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: providerResourceId
        in: query
        description: Optional query to identify resource by provider resource ID
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Optional query to limit resources by one or more exact resource types (takes precedence over resourceTypeId). Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: subDomainId
        in: query
        description: Optional query to limit resources by one or more subdomain ids. Use a comma-separated string to specify multiple subdomain IDs.
        style: form
        explode: true
        schema:
          type: string
      - name: applicationSliceId
        in: query
        description: Optional query to limit resources by the application slice ID.
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: Optional query parameter to define a tag filter. May use whitespace-separated AND/OR query (e.g. (one:1) OR (two:2) AND (three:3)) syntax or tagKey:tagValue syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/history:
    get:
      tags:
      - resources
      summary: ListResourceHistory
      description: Enter date/time values in UTC (Zulu time) ISO-8601 format e.g., 2014-10-24T16:29:56.640Z
      operationId: ListResourceHistory
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose history will be queried
        required: true
        style: simple
        schema:
          type: string
      - name: after
        in: query
        description: Consider create/delete event since this time only
        style: form
        explode: true
        schema:
          type: string
      - name: before
        in: query
        description: Consider create/delete event before this time only
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply22'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply22'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/sub-domain:
    put:
      tags:
      - resources
      summary: AssignResourceToSubDomain
      description: Assign the resource to a specific subdomain
      operationId: AssignResourceToSubDomain
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource to be assigned to the subdomain
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining subdomain information to set the resource to
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesSubDomainRequest'
              - description: Specification defining subdomain information to set the resource to
        required: true
      responses:
        '200':
          description: Updated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '201':
          description: Created
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/operations:
    get:
      tags:
      - resources
      summary: ListResourceOperations
      description: >-
        Resource types may define custom operations in addition to activate, update and terminate lifecycle plans.
                  This endpoint shows the history of these custom operations invoked on the specified resource.
      operationId: ListResourceOperations
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose operations will be queried
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply19'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply19'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - resources
      summary: CreateResourceOperation
      description: >-
        Instantiate an operation as defined by the resource's type which is executed asynchronously.
                   The current status can be retrieved via GET while valid operation definitions can be found under the /interfaces API
      operationId: CreateResourceOperation
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource for whom the operation is being created
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a resource operation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesOperationsRequest'
              - description: Specification defining a resource operation
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - resources
      summary: BulkDeleteResourceOperations
      description: Bulk delete resource operations
      operationId: BulkDeleteResourceOperations
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource
        required: true
        style: simple
        schema:
          type: string
      - name: beforeDate
        in: query
        description: "Only delete operations before the given date. For example: '2020-02-12' would delete any operations before Feb 2nd, 2020. If no date is specified, it will delete all completed operations."
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/operations/count:
    get:
      tags:
      - resources
      summary: CountResourceOperations
      description: >-
        Resource types may define custom operations in addition to activate, update and terminate lifecycle plans.
                  This endpoint counts these custom operations invoked on the specified resource.
      operationId: CountResourceOperations
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose operations will be queried
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply19'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply19'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/operations/{operationId}:
    get:
      tags:
      - resources
      summary: GetResourceOperation
      description: Get details of a specific operation for a given resource
      operationId: GetResourceOperation
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose operations will be queried
        required: true
        style: simple
        schema:
          type: string
      - name: operationId
        in: path
        description: Identifier of the operation to be queried
        required: true
        style: simple
        schema:
          type: string
      - name: minRevision
        in: query
        description: Require the revision of the returned resource to be greater than or equal to minRevision. Respond with a 503 if the resource exists, but the revision does not meet the minRevision
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - resources
      summary: UpdateResourceOperation
      description: Update attributes of a specific operation for a given resource
      operationId: UpdateResourceOperation
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose operation will be changed
        required: true
        style: simple
        schema:
          type: string
      - name: operationId
        in: path
        description: Identifier of the operation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a resource operation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesOperationsRequest1'
              - description: Specification defining a resource operation
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - resources
      summary: DeleteResourceOperation
      description: Delete a resource operation
      operationId: DeleteResourceOperation
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource
        required: true
        style: simple
        schema:
          type: string
      - name: operationId
        in: path
        description: Identifier of the resource operation
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - resources
      summary: PatchResourceOperation
      description: Patch the attributes of a specific operation for a given resource
      operationId: PatchResourceOperation
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose operations will be changed
        required: true
        style: simple
        schema:
          type: string
      - name: operationId
        in: path
        description: Identifier of the operation to be patched
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a resource operation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesOperationsRequest1'
              - description: Specification defining a resource operation
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResourceOperation'
                - description: Information describing a resource operation
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/promote:
    post:
      tags:
      - resources
      summary: PromoteResourceAssembly
      description: >-
        Given the id of a top-level resource whose assembly is in the Assembled state, promote the entire assembly
                   to a managed service
      operationId: PromoteResourceAssembly
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource to promote
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The partial resource data to patch during promotion
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesPromoteRequest'
              - description: The partial resource data to patch during promotion
        required: false
      responses:
        '202':
          description: Accepted
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/operations/validate:
    post:
      tags:
      - resources
      summary: ValidateResourceOperationCreation
      description: Execute a validation request for a proposed resource operation creation
      operationId: ValidateResourceOperationCreation
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource for which the operation will be created against
        required: true
        style: simple
        schema:
          type: string
      - name: full
        in: query
        description: Whether the request body represents a full resource operation
        required: true
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        description: Specification defining a resource operation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesOperationsValidateRequest'
              - description: Specification defining a resource operation
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/operations/{operationId}/validate:
    post:
      tags:
      - resources
      summary: ValidateResourceOperationChange
      description: Execute a change validation request for the specified resource operation
      operationId: ValidateResourceOperationChange
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource being validated against
        required: true
        style: simple
        schema:
          type: string
      - name: operationId
        in: path
        description: Identifier of the operation to be changed
        required: true
        style: simple
        schema:
          type: string
      - name: method
        in: query
        description: The HTTP method for the resource operation to be validated against
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/method11'
          - description: The HTTP method for the resource operation to be validated against
      requestBody:
        description: Specification defining a resource operation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesOperationsValidateRequest1'
              - description: Specification defining a resource operation
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/interfaces:
    get:
      tags:
      - resources
      summary: ListResourceInterfaces
      description: List all implemented interfaces which define how to create resource operations.
      operationId: ListResourceInterfaces
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose interfaces will be queried
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply20'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply20'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/interfaces/count:
    get:
      tags:
      - resources
      summary: CountResourceInterfaces
      description: Count implemented interfaces which define how to create resource operations.
      operationId: CountResourceInterfaces
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource whose interfaces will be queried
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply20'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply20'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/reassemble:
    post:
      tags:
      - resources
      summary: ReassembleResourceAssembly
      description: Given the id of a assembling resource, reevaluate the discovery template
      operationId: ReassembleResourceAssembly
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource who needs to be reassembled
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/dependencies:
    get:
      tags:
      - resources
      summary: ListDependenciesOfResource
      description: Dependencies are resources that this resource depends upon, i.e., targets of relationships that source from this resource. One (and only one) of productId, resourceTypeId or exactTypeId must be specified when using the q or p filters on properties.
      operationId: ListDependenciesOfResource
      parameters:
      - name: resourceId
        in: path
        description: Identifies the resource for which dependency resources are searched
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect dependencies as well, i.e., dependencies of the dependencies, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: productId
        in: query
        description: Optional query to limit resources by product type
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Optional query to limit resources by domain
        style: form
        explode: true
        schema:
          type: string
      - name: resourceProviderId
        in: query
        description: Optional query to limit resources by resource provider
        style: form
        explode: true
        schema:
          type: string
      - name: resourceTypeId
        in: query
        description: Optional query to limit resources by one or more resource types. Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Optional query to limit resources by one or more exact resource types (takes precedence over resourceTypeId). Use comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: subDomainId
        in: query
        description: Optional query to limit resources by one or more subdomain ids. Use a comma-separated string to specify multiple subdomain ids.
        style: form
        explode: true
        schema:
          type: string
      - name: applicationSliceId
        in: query
        description: Optional query to limit resources by the application slice id.
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: Optional query parameter to define a tag filter using tagKey:tagValue syntax
        style: form
        explode: true
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply10'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply10'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/dependents:
    get:
      tags:
      - resources
      summary: ListDependentsOfResource
      description: Dependents are resources that depend upon this resource, i.e., sources of relationships that target at this resource. One (and only one) of productId, resourceTypeId or exactTypeId must be specified when using the q or p filters on properties.
      operationId: ListDependentsOfResource
      parameters:
      - name: resourceId
        in: path
        description: Identifies the resource for which dependent resources are searched
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect dependents as well, i.e., dependents of the dependents, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: productId
        in: query
        description: Optional query to limit resources by product type
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Optional query to limit resources by domain
        style: form
        explode: true
        schema:
          type: string
      - name: resourceProviderId
        in: query
        description: Optional query to limit resources by resource provider
        style: form
        explode: true
        schema:
          type: string
      - name: resourceTypeId
        in: query
        description: Optional query to limit resources by one or more resource types. Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Optional query to limit resources by one or more exact resource types (takes precedence over resourceTypeId). Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: subDomainId
        in: query
        description: Optional query to limit resources by one or more subdomain ids. Use a comma-separated string to specify multiple subdomain ids.
        style: form
        explode: true
        schema:
          type: string
      - name: applicationSliceId
        in: query
        description: Optional query to limit resources by the application slice id.
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: Optional query parameter to define a tag filter using tagKey:tagValue syntax
        style: form
        explode: true
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply10'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply10'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/dependencies/count:
    get:
      tags:
      - resources
      summary: CountDependenciesOfResource
      description: Dependencies are resources that this resource depends upon, i.e., targets of relationships that source from this resource. One (and only one) of productId, resourceTypeId or exactTypeId must be specified when using the q or p filters on properties.
      operationId: CountDependenciesOfResource
      parameters:
      - name: resourceId
        in: path
        description: Identifies the resource for which dependency resources are searched
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect dependencies as well, i.e., dependencies of the dependencies, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: productId
        in: query
        description: Optional query to limit resources by product type
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Optional query to limit resources by domain
        style: form
        explode: true
        schema:
          type: string
      - name: resourceProviderId
        in: query
        description: Optional query to limit resources by resource provider
        style: form
        explode: true
        schema:
          type: string
      - name: resourceTypeId
        in: query
        description: Optional query to limit resources by one or more resource types. Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Optional query to limit resources by one or more exact resource types (takes precedence over resourceTypeId). Use comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: subDomainId
        in: query
        description: Optional query to limit resources by one or more subdomain IDs. Use a comma-separated string to specify multiple subdomain ids.
        style: form
        explode: true
        schema:
          type: string
      - name: applicationSliceId
        in: query
        description: Optional query to limit resources by the application slice ID.
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: Optional query parameter to define a tag filter using tagKey:tagValue syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply10'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply10'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/dependents/count:
    get:
      tags:
      - resources
      summary: CountDependentsOfResource
      description: Dependents are resources that depend upon this resource, i.e., sources of relationships that target at this resource. One (and only one) of productId, resourceTypeId or exactTypeId must be specified when using the q or p filters on properties.
      operationId: CountDependentsOfResource
      parameters:
      - name: resourceId
        in: path
        description: Identifies the resource for which dependent resources are searched
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect dependents as well, i.e., dependents of the dependents, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: productId
        in: query
        description: Optional query to limit resources by product type
        style: form
        explode: true
        schema:
          type: string
      - name: domainId
        in: query
        description: Optional query to limit resources by domain
        style: form
        explode: true
        schema:
          type: string
      - name: resourceProviderId
        in: query
        description: Optional query to limit resources by resource provider
        style: form
        explode: true
        schema:
          type: string
      - name: resourceTypeId
        in: query
        description: Optional query to limit resources by one or more resource types. Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: exactTypeId
        in: query
        description: Optional query to limit resources by one or more exact resource types (takes precedence over resourceTypeId). Use a comma-separated string to specify multiple resource types.
        style: form
        explode: true
        schema:
          type: string
      - name: subDomainId
        in: query
        description: Optional query to limit resources by one or more subdomain IDs. Use a comma-separated string to specify multiple subdomain ids.
        style: form
        explode: true
        schema:
          type: string
      - name: applicationSliceId
        in: query
        description: Optional query to limit resources by the application slice ID.
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: Optional query parameter to define a tag filter using tagKey:tagValue syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply10'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply10'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/observed:
    get:
      tags:
      - resources
      summary: GetResourceObserved
      description: Observed state is the state of the resource as seen by the provider
      operationId: GetResourceObserved
      parameters:
      - name: resourceId
        in: path
        description: Identifies the resource to get
        required: true
        style: simple
        schema:
          type: string
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - resources
      summary: PutResourceObserved
      description: Observed state is the state of the resource as seen by the provider
      operationId: PutResourceObserved
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource to update
        required: true
        style: simple
        schema:
          type: string
      - name: validate
        in: query
        description: Whether to perform custom validation in addition to built-in schema and accessor validations
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: The resource data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesObservedRequest'
              - description: The resource data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - resources
      summary: PatchResourceObserved
      description: Observed state is the state of the resource as seen by the provider
      operationId: PatchResourceObserved
      parameters:
      - name: resourceId
        in: path
        description: Identifies the resource to update
        required: true
        style: simple
        schema:
          type: string
      - name: validate
        in: query
        description: Whether to perform custom validation in addition to built-in schema and accessor validations
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: obfuscate
        in: query
        description: If true, schema obfuscated values will be replaced with a fixed string in the response.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: The partial resource data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesObservedRequest1'
              - description: The partial resource data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Resource'
                - description: Information describing a single resource
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/validate:
    post:
      tags:
      - resources
      summary: ValidateResourceCreation
      description: Execute a validation request for a proposed resource creation
      operationId: ValidateResourceCreation
      parameters:
      - name: full
        in: query
        description: Whether the request body represents a full resource
        required: true
        style: form
        explode: true
        schema:
          type: boolean
      - name: custom
        in: query
        description: Whether to perform custom validation in addition to built-in schema and accessor validations
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: Specification defining a resource
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesValidateRequest'
              - description: Specification defining a resource
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/validate:
    post:
      tags:
      - resources
      summary: ValidateResourceChange
      description: Execute a change validation request for the specified resource
      operationId: ValidateResourceChange
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource being validated against
        required: true
        style: simple
        schema:
          type: string
      - name: method
        in: query
        description: The HTTP method for the resource to be validated against
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/method21'
          - description: The HTTP method for the resource to be validated against
      - name: custom
        in: query
        description: Whether to perform custom validation in addition to built-in schema and accessor validations
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      requestBody:
        description: Specification defining a resource
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1ResourcesValidateRequest1'
              - description: Specification defining a resource
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ValidationReport'
                - description: A report for the processing results of a resource validation request
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/resync:
    post:
      tags:
      - resources
      summary: ResyncResource
      description: Execute a resync request for the specified resource
      operationId: ResyncResource
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource to be resynced
        required: true
        style: simple
        schema:
          type: string
      - name: full
        in: query
        description: Whether the requeset is for a full resync
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '202':
          description: Accepted
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncReply'
                - description: Information describing the reply of a resync request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncReply'
                - description: Information describing the reply of a resync request
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resources/{resourceId}/audit:
    post:
      tags:
      - resources
      summary: AuditResource
      description: Execute an audit request for the specified resource
      operationId: AuditResource
      parameters:
      - name: resourceId
        in: path
        description: Identifier of the resource to be audited
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: Accepted
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuditReply'
                - description: Information describing an item of a audit request reply
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuditReply'
                - description: Information describing an item of a audit request reply
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/resources:
    get:
      tags:
      - resources
      summary: resources_list
      description: List of all resources.
      operationId: resources_list
      parameters:
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: customerModifiable
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - resources
      summary: resources_create
      description: Create a new resource.
      operationId: resources_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - resource
              - name
              type: object
              properties:
                resource:
                  type: string
                  description: HTTP Resource like api/v1/users
                name:
                  type: string
                  description: Resource name
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/resources/{uuid}:
    get:
      tags:
      - resources
      summary: resources_read
      description: Get a specific resource by UUID.
      operationId: resources_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - resources
      summary: resources_update
      description: Defines resources for the permission.
      operationId: resources_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - resource
              - name
              type: object
              properties:
                resource:
                  type: string
                  description: HTTP Resource like api/v1/users
                name:
                  type: string
                  description: Resource name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - resources
      summary: resources_partial_update
      description: Defines resources for the permission.
      operationId: resources_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                resource:
                  type: string
                  description: HTTP Resource like api/v1/users
                name:
                  type: string
                  description: Resource name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ResourceSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - resources
      summary: resources_delete
      description: Defines resources for the permission.
      operationId: resources_delete
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/resyncs/{resyncId}:
    get:
      tags:
      - resyncs
      summary: GetResyncStatus
      description: Get the status of a resync request
      operationId: GetResyncStatus
      parameters:
      - name: resyncId
        in: path
        description: ID of the resync being requested
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncStatus'
                - description: Information describing the status of a resync request
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ResyncStatus'
                - description: Information describing the status of a resync request
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sharing-permissions:
    get:
      tags:
      - sharing-permissions
      summary: ListSharingPermissions
      description: Get all of the sharing permissions in the market
      operationId: ListSharingPermissions
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply12'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply12'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - sharing-permissions
      summary: CreateSharingPermission
      description: Create a sharing permission using the information in the provided sharing permission object
      operationId: CreateSharingPermission
      parameters: []
      requestBody:
        description: Specification defining a sharing permission (id is honored in creation request)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1SharingPermissionsRequest'
              - description: Specification defining a sharing permission (id is honored in creation request)
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sharing-permissions/count:
    get:
      tags:
      - sharing-permissions
      summary: CountSharingPermissions
      description: Count the sharing permissions in the market
      operationId: CountSharingPermissions
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sharing-permissions/{sharingPermissionId}:
    get:
      tags:
      - sharing-permissions
      summary: GetSharingPermission
      description: Get a specific sharing permission from the market
      operationId: GetSharingPermission
      parameters:
      - name: sharingPermissionId
        in: path
        description: Identifier of the requested sharing permission
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - sharing-permissions
      summary: UpdateSharingPermission
      description: The id from the SharingPermission object parameter is ignored on update.
      operationId: UpdateSharingPermission
      parameters:
      - name: sharingPermissionId
        in: path
        description: Identifier of the sharing permission to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a sharing permission
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1SharingPermissionsRequest1'
              - description: Specification defining a sharing permission
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - sharing-permissions
      summary: DeleteSharingPermission
      description: Delete a sharing permission from the market
      operationId: DeleteSharingPermission
      parameters:
      - name: sharingPermissionId
        in: path
        description: Identifier of the sharing permission to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - sharing-permissions
      summary: PatchSharingPermission
      description: The id from the SharingPermission object parameter is ignored on update.
      operationId: PatchSharingPermission
      parameters:
      - name: sharingPermissionId
        in: path
        description: Identifier of the sharing permission to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Partial sharing permission object specifying the data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1SharingPermissionsRequest1'
              - description: Partial sharing permission object specifying the data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SharingPermission'
                - description: Information describing a sharing permission
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains:
    get:
      tags:
      - sub-domains
      summary: ListSubDomains
      description: Get all of the subdomains in the market
      operationId: ListSubDomains
      parameters:
      - name: domainId
        in: query
        description: Optional query to limit subdomains by domain ID
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - sub-domains
      summary: CreateSubDomain
      description: Create a subdomain using the information in the provided subdomain object
      operationId: CreateSubDomain
      parameters: []
      requestBody:
        description: Specification defining a subdomain
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1SubDomainsRequest'
              - description: Specification defining a subdomain
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains/{subDomainId}:
    get:
      tags:
      - sub-domains
      summary: GetSubDomain
      description: Get a specific subdomain from the market
      operationId: GetSubDomain
      parameters:
      - name: subDomainId
        in: path
        description: Identifier of the requested subdomain
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - sub-domains
      summary: UpdateSubDomain
      description: Update a subdomain in the market based on the data in the provided instance
      operationId: UpdateSubDomain
      parameters:
      - name: subDomainId
        in: path
        description: Identifier of the subdomain to update
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Specification defining a subdomain
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1SubDomainsRequest1'
              - description: Specification defining a subdomain
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - sub-domains
      summary: DeleteSubDomain
      description: Delete a subdomain from the market
      operationId: DeleteSubDomain
      parameters:
      - name: subDomainId
        in: path
        description: Identifier of the subdomain to delete
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - sub-domains
      summary: PatchSubDomain
      description: Patch update a subdomain in the market based on the data in the provided instance
      operationId: PatchSubDomain
      parameters:
      - name: subDomainId
        in: path
        description: Identifier of the subdomain to update
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Partial subdomain object specifying the data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1SubDomainsRequest1'
              - description: Partial subdomain object specifying the data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SubDomain'
                - description: Information describing a sub-domain
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains/{subDomainId}/containers:
    get:
      tags:
      - sub-domains
      summary: ListContainers
      description: Lists all container subdomains of the given subdomain id
      operationId: ListContainers
      parameters:
      - name: subDomainId
        in: path
        description: Identifies the subdomain whose container subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect container subdomains as well, i.e., container of the container, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains/{subDomainId}/containees:
    get:
      tags:
      - sub-domains
      summary: ListContainees
      description: Lists all containee subdomains of the given subdomain id
      operationId: ListContainees
      parameters:
      - name: subDomainId
        in: path
        description: Identifies the subdomain whose containee subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect containee subdomains as well, i.e., containees of the containees, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains/{subDomainId}/add-resources:
    post:
      tags:
      - sub-domains
      summary: AddResourcesToSubDomain
      description: >-
        All resources should belong to the same domain as the subdomain.
            The order in which the list is updated is not guaranteed.
            Maximum list size == 1000.
      operationId: AddResourcesToSubDomain
      parameters:
      - name: subDomainId
        in: path
        description: Identifier of the subdomain to add the resources
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Specify IDs of the resources to be added
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SubDomainResourceSet'
              - description: Specify IDs of the resources to be added
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddResourcesToSubDomainReport'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/AddResourcesToSubDomainReport'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '415':
          description: Unsupported Media Type
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains/{subDomainId}/containees/count:
    get:
      tags:
      - sub-domains
      summary: CountContainees
      description: Count containee subdomains of the given subdomain id
      operationId: CountContainees
      parameters:
      - name: subDomainId
        in: path
        description: Identifies the subdomain whose containee subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect containee subdomains as well, i.e., containees of the containees, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains/{subDomainId}/containers/count:
    get:
      tags:
      - sub-domains
      summary: CountContainers
      description: Count container subdomains of the given subdomain id
      operationId: CountContainers
      parameters:
      - name: subDomainId
        in: path
        description: Identifies the subdomain whose container subdomains are to be listed
        required: true
        style: simple
        schema:
          type: string
      - name: recursive
        in: query
        description: If true, returns indirect container subdomains as well, i.e., container of the container, etc.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply23'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply23'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/sub-domains/count:
    get:
      tags:
      - sub-domains
      summary: CountSubDomains
      description: Count the subdomains in the market
      operationId: CountSubDomains
      parameters:
      - name: domainId
        in: query
        description: Optional query to limit subdomains by domain ID
        style: form
        explode: true
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tag-keys/{tagKey}/tag-values:
    get:
      tags:
      - tag-keys
      summary: ListTagValues
      description: Get all of the tag values for a given tag key
      operationId: ListTagValues
      parameters:
      - name: tagKey
        in: path
        description: Tag key whose tag values are being requested
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply15'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply15'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - tag-keys
      summary: CreateTagValue
      description: The key in the TagValue object is optional and ignored on create
      operationId: CreateTagValue
      parameters:
      - name: tagKey
        in: path
        description: Tag key for the tag value being created
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a tag value
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1TagKeysTagValuesRequest'
              - description: Specification defining a tag value
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tag-keys/{tagKey}/tag-values/{tagValue}:
    get:
      tags:
      - tag-keys
      summary: GetTagValue
      description: Get a specific tag value from the market
      operationId: GetTagValue
      parameters:
      - name: tagKey
        in: path
        description: Tag key whose tag value is being requested
        required: true
        style: simple
        schema:
          type: string
      - name: tagValue
        in: path
        description: Tag value to get
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - tag-keys
      summary: UpdateTagValue
      description: Update a tag value based on the data in the provided instance
      operationId: UpdateTagValue
      parameters:
      - name: tagKey
        in: path
        description: Tag key for the tag value being updated
        required: true
        style: simple
        schema:
          type: string
      - name: tagValue
        in: path
        description: Tag value being updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a tag value
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1TagKeysTagValuesRequest'
              - description: Specification defining a tag value
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - tag-keys
      summary: DeleteTagValue
      description: Delete a tag value
      operationId: DeleteTagValue
      parameters:
      - name: tagKey
        in: path
        description: Tag key for the tag value being deleted
        required: true
        style: simple
        schema:
          type: string
      - name: tagValue
        in: path
        description: Tag value being deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - tag-keys
      summary: PatchTagValue
      description: Patch update a tag value based on the data in the provided instance
      operationId: PatchTagValue
      parameters:
      - name: tagKey
        in: path
        description: Tag key for the tag value being updated
        required: true
        style: simple
        schema:
          type: string
      - name: tagValue
        in: path
        description: Tag value being updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Partial tag value defining the fields to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1TagKeysTagValuesRequest'
              - description: Partial tag value defining the fields to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagValue'
                - description: Tag value with description
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tag-keys:
    get:
      tags:
      - tag-keys
      summary: ListTagKeys
      description: Get all of the tag keys in the market
      operationId: ListTagKeys
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply14'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply14'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - tag-keys
      summary: CreateTagKey
      description: Create a tag key in the market using the information in the provided tag key object
      operationId: CreateTagKey
      parameters: []
      requestBody:
        description: Specification defining a tag key
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1TagKeysRequest'
              - description: Specification defining a tag key
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tag-keys/count:
    get:
      tags:
      - tag-keys
      summary: CountTagKeys
      description: Count the tag keys in the market
      operationId: CountTagKeys
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tag-keys/{tagKey}:
    get:
      tags:
      - tag-keys
      summary: GetTagKey
      description: Get a specific tag key from the market
      operationId: GetTagKey
      parameters:
      - name: tagKey
        in: path
        description: Requested tag key
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - tag-keys
      summary: UpdateTagKey
      description: Update a tag key in the market based on the data in the provided instance
      operationId: UpdateTagKey
      parameters:
      - name: tagKey
        in: path
        description: Tag key to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Specification defining a tag key
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1TagKeysRequest'
              - description: Specification defining a tag key
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - tag-keys
      summary: DeleteTagKey
      description: Delete a tag key from the market
      operationId: DeleteTagKey
      parameters:
      - name: tagKey
        in: path
        description: Tag key to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - tag-keys
      summary: PatchTagKey
      description: Patch update a tag key in the market based on the data in the provided instance
      operationId: PatchTagKey
      parameters:
      - name: tagKey
        in: path
        description: Tag key to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Partial tag key object specifying data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocoreMarketApiV1TagKeysRequest'
              - description: Partial tag key object specifying data to update
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TagKey'
                - description: Tag key with description
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tag-keys/{tagKey}/tag-values/count:
    get:
      tags:
      - tag-keys
      summary: CountTagValues
      description: Count tag values for a given tag key
      operationId: CountTagValues
      parameters:
      - name: tagKey
        in: path
        description: Tag key whose tag values are being requested
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tenants/resync:
    post:
      tags:
      - tenants
      summary: ResyncTenants
      description: Do a full reset of the tenants in bpocore to mirror the current state of Tron
      operationId: ResyncTenants
      parameters: []
      responses:
        '202':
          description: Accepted
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/tenants/{tenantId}:
    get:
      tags:
      - tenants
      summary: GetTenant
      description: Get a tenant by Id
      operationId: GetTenant
      parameters:
      - name: tenantId
        in: path
        description: Identifier of the tenant being queried
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Tenant'
                - description: Information describing a tenant
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Tenant'
                - description: Information describing a tenant
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/tenants:
    get:
      tags:
      - tenants
      summary: tenants_list
      description: List all tenants.
      operationId: tenants_list
      parameters:
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: isMaster
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: isActive
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: search
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - tenants
      summary: tenants_create
      description: Create a new Tenant.
      operationId: tenants_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - parent
              - name
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                displayName:
                  type: string
                  description: Tenant display name
                description:
                  type: string
                  description: Tenant description
                parent:
                  type: string
                  description: Parent tenant UUID
                type:
                  type: string
                  description: Tenant type
                concurrent_session_max_per_tenant:
                  type: integer
                  description: The maximum number of concurrent sessions per tenant. (0=infinity)
                  format: int32
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions for tenant users. (0=infinity)
                  format: int32
                email_dormancy_weekly_notifications:
                  type: integer
                  description: Number of weeks before dormancy to send emails. One email sent per week.
                  format: int32
                email_dormancy_daily_notifications:
                  type: integer
                  description: Number of days before dormancy to send emails. One email sent per day.
                  format: int32
                name:
                  type: string
                  description: Tenant name
                isActive:
                  type: boolean
                  description: Designates whether this tenant should be treated as active. If Tenant is not active, none of its users can be authenticated
                message:
                  type: string
                  description: Message to be displayed after the user logs-in. Can be text, html, etc..
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/tenants/{uuid}:
    get:
      tags:
      - tenants
      summary: tenants_read
      description: Get a specific tenant by UUID.
      operationId: tenants_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - tenants
      summary: tenants_update
      description: Replace the tenant with this UUID.
      operationId: tenants_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - parent
              - name
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                displayName:
                  type: string
                  description: Tenant display name
                description:
                  type: string
                  description: Tenant description
                parent:
                  type: string
                  description: Parent tenant UUID
                type:
                  type: string
                  description: Tenant type
                concurrent_session_max_per_tenant:
                  type: integer
                  description: The maximum number of concurrent sessions per tenant. (0=infinity)
                  format: int32
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions for tenant users. (0=infinity)
                  format: int32
                email_dormancy_weekly_notifications:
                  type: integer
                  description: Number of weeks before dormancy to send emails. One email sent per week.
                  format: int32
                email_dormancy_daily_notifications:
                  type: integer
                  description: Number of days before dormancy to send emails. One email sent per day.
                  format: int32
                name:
                  type: string
                  description: Tenant name
                isActive:
                  type: boolean
                  description: Designates whether this tenant should be treated as active. If Tenant is not active, none of its users can be authenticated
                message:
                  type: string
                  description: Message to be displayed after the user logs-in. Can be text, html, etc..
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - tenants
      summary: tenants_partial_update
      description: Update some values for the tenant with this UUID.
      operationId: tenants_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                displayName:
                  type: string
                  description: Tenant display name
                description:
                  type: string
                  description: Tenant description
                parent:
                  type: string
                  description: Parent tenant UUID
                type:
                  type: string
                  description: Tenant type
                concurrent_session_max_per_tenant:
                  type: integer
                  description: The maximum number of concurrent sessions per tenant. (0=infinity)
                  format: int32
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions for tenant users. (0=infinity)
                  format: int32
                email_dormancy_weekly_notifications:
                  type: integer
                  description: Number of weeks before dormancy to send emails. One email sent per week.
                  format: int32
                email_dormancy_daily_notifications:
                  type: integer
                  description: Number of days before dormancy to send emails. One email sent per day.
                  format: int32
                name:
                  type: string
                  description: Tenant name
                isActive:
                  type: boolean
                  description: Designates whether this tenant should be treated as active. If Tenant is not active, none of its users can be authenticated
                message:
                  type: string
                  description: Message to be displayed after the user logs-in. Can be text, html, etc..
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/type-artifacts/realm:
    get:
      tags:
      - type-artifacts
      summary: GetTypeLayerVersion
      description: >-
        This resource contains metadata on the type layer itself. This metadata can be used to determine the
              status of pending type definition on-boarding operations. Specifically, the content of the response can be
              compared against the result of an accepted pull request to determine whether the changes have finished propagating
              into market. The version represents the latest commit fully incorporated into the type layer. The headCommit is
              the latest accepted commit in the asset area. The property current is set to true when those values match.
      operationId: GetTypeLayerVersion
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TypeLayerCurrentReply'
                - description: Version values used to determine if the Type Catalog is current with respect to the Asset Area
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TypeLayerCurrentReply'
                - description: Version values used to determine if the Type Catalog is current with respect to the Asset Area
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/type-artifacts:
    get:
      tags:
      - type-artifacts
      summary: ListTypeArtifacts
      description: Get all of the type artifacts in the market
      operationId: ListTypeArtifacts
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply17'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply17'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/type-artifacts/count:
    get:
      tags:
      - type-artifacts
      summary: CountTypeArtifacts
      description: Count the type artifacts in the market
      operationId: CountTypeArtifacts
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply17'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply17'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/type-artifacts/realm/validate:
    post:
      tags:
      - type-artifacts
      summary: ValidateDefinitionRealm
      description: Verifies that the currently used model in the definition realm is fully compliant
      operationId: ValidateDefinitionRealm
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateDefinitionRealmReply'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ValidateDefinitionRealmReply'
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
      deprecated: false
  /bpocore/market/api/v1/type-artifacts/{typeArtifactUri}:
    get:
      tags:
      - type-artifacts
      summary: GetTypeArtifact
      description: Get a type artifact by Id
      operationId: GetTypeArtifact
      parameters:
      - name: typeArtifactUri
        in: path
        description: Identifier of the type artifact being queried
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TypeArtifactDefinition'
                - description: Information describing a single type artifact
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TypeArtifactDefinition'
                - description: Information describing a single type artifact
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /configmgmt/api/v1/bulkOperations/assignSegmentIdentifier:
    post:
      tags:
      - 000 - configmgmtapiv1bulkOperations
      summary: assignSegmentIdentifier
      description: Assign segment identifier to segment routing enabled network elements
      operationId: assignSegmentIdentifier
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          enum:
          - application/x-www-form-urlencoded
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - assignmentType
              type: object
              properties:
                assignmentType:
                  allOf:
                  - $ref: '#/components/schemas/assignmentType'
                  - description: assignmentType of segment identifier
                typeGroup:
                  type: string
                  description: typeGroup of segment routing enabled network elements
                softwareVersion:
                  type: string
                  description: softwareVersion of segment routing enabled network elements
                networkConstruct.id:
                  type: string
                  description: Network Construct identifier
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationsResponse'
        '201':
          description: Operation executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationsResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to find resource to carry out bulk operations
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/bulkOperations/getNEResourcesOfOperation:
    get:
      tags:
      - 000 - configmgmtapiv1bulkOperations
      summary: retrieveNEResourcesOfOperation
      description: >-
        Collection of resources of the bulk operation returned as a JSON objects

        <p>Prerequiste: None.
      operationId: retrieveNEResourcesOfOperation
      parameters:
      - name: operationType
        in: query
        description: Operation Type
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: startTime
        in: query
        description: Start time of the operation
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. Allowed value is: state'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationNEResourceCollection'
        '201':
          description: Collection of resources of bulk operation(s)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationNEResourceCollection'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to find resource to retrieve network construct resources of bulk operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of network construct resources of bulk operation failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/bulkOperations/getProgressOfOperation:
    get:
      tags:
      - 000 - configmgmtapiv1bulkOperations
      summary: retrieveProgressStatusOfOperations
      description: >-
        Progress status of bulk operation returned as a JSON objects

        <p>Prerequiste: None.
      operationId: retrieveProgressStatusOfOperations
      parameters:
      - name: operationType
        in: query
        description: Operation Type
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: startTime
        in: query
        description: Start time of the operation
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationProgressStatus'
        '201':
          description: Progress status of bulk operation(s)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationProgressStatus'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to find resource to retrieve progress status of the bulk operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of progress status of the  bulk operation failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/bulkOperations/getStatusOfOperations:
    get:
      tags:
      - 000 - configmgmtapiv1bulkOperations
      summary: retrieveStatusOfOperations
      description: >-
        Collection of status of bulk operations returned as a JSON objects

        <p>Prerequiste: None.
      operationId: retrieveStatusOfOperations
      parameters:
      - name: id
        in: query
        description: (Optional) List of comma separated operation IDs
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: (Optional) List of comma separated operation types
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: '(Optional) List of operation states. Allowed values: completed, inprogress, failed'
        style: form
        explode: true
        schema:
          type: string
      - name: fromRecentOperationTime
        in: query
        description: (Optional) Start time of the operation
        style: form
        explode: true
        schema:
          type: string
      - name: toRecentOperationTime
        in: query
        description: (Optional) End time of the operation
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. Allowed value is: state'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatusCollection'
        '201':
          description: Collection of status of bulk operation(s)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatusCollection'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to find resource to retrieve status of bulk operations
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of status of bulk operations failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/batches:
    get:
      tags:
      - Batch Management v1
      summary: getAllConfigMgmtBatches
      description: "Get all existing Batches as a JSON list of objects. \n<p>Prerequiste: None."
      operationId: getAllConfigMgmtBatches
      parameters: []
      responses:
        '200':
          description: Batches fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchStatusList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Batches are not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/batches/{batchId}:
    get:
      tags:
      - Batch Management v1
      summary: getConfigMgmtBatch
      description: "Get Batch as a JSON object of given Batch Id. \n<p>Prerequiste: Batches must exist for specified batchId."
      operationId: getConfigMgmtBatch
      parameters:
      - name: batchId
        in: path
        description: The batchId used for lookup inside created batch
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Batch fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchStatus'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Batch is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    put:
      tags:
      - Batch Management v1
      summary: updateBatches
      description: "Updates Batch attributes for a batch. \n<p>Prerequiste: Batch must exist."
      operationId: updateBatches
      parameters:
      - name: batchId
        in: path
        description: Update batch associated with given batchId
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The batch attributes to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BatchStatus'
              - description: The batch attributes to update
        required: true
      responses:
        '204':
          description: Batch updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchStatus'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service Unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/deleteBatch:
    post:
      tags:
      - Batch Management v1
      summary: deleteConfigMgmtBatch
      description: "Delete the Batches for given Batch Ids. \n <p>Prerequisites: The following attributes should be specified in the request:<ul><li>id - Any string<li>batchIds - The list of Batch Ids comma separated</ul>"
      operationId: deleteConfigMgmtBatch
      parameters: []
      requestBody:
        description: Batch removal request having list of batch ids.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BatchRemoveRequest'
              - description: Batch removal request having list of batch ids.
        required: true
      responses:
        '204':
          description: Batches are deleted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Batches are not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/nes/{batchId}:
    get:
      tags:
      - Batch Management v1
      summary: getBatchedNes
      description: "Get all Network Elements given Batch Id as a JSON list of objects. \n<p>Prerequiste: Batches must exist for specified batchId."
      operationId: getBatchedNes
      parameters:
      - name: batchId
        in: path
        description: Retrieve all NEs associated with a batchId
        required: true
        style: simple
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: List of NEs associated with batch
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeBackupRestoreStatusList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve batched NEs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of batched NEs failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v2/nes:
    get:
      tags:
      - Batch Management v2
      summary: getBatchedNesByBatchType
      description: "Get all Network Elements given Batch Type as a JSON list of objects. \n<p>Prerequiste: None."
      operationId: getBatchedNesByBatchType
      parameters:
      - name: batchType
        in: query
        description: Retrieve all NEs details by batch type
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/batchType1'
          - description: Retrieve all NEs details by batch type
      responses:
        '200':
          description: List of NEs for batch type
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchNeStatusList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve NEs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of NEs failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v2/nes/{batchId}:
    get:
      tags:
      - Batch Management v2
      summary: getBatchedNesByBatchId
      description: "Get all Network Elements given Batch Id as a JSON list of objects. \n<p>Prerequiste: Batches must exist for specified batchId."
      operationId: getBatchedNesByBatchId
      parameters:
      - name: batchId
        in: path
        description: Retrieve all NEs associated with a batchId
        required: true
        style: simple
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: List of NEs associated with batch
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchNeStatusList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve batched NEs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of batched NEs failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/commissioningFunctions:
    get:
      tags:
      - Commissioning Functions v1
      summary: getCommissioningFunctions
      description: >-
        Retrieves a list of commissioning functions
         <p>Prerequisite: None.
      operationId: getCommissioningFunctions
      parameters: []
      responses:
        '200':
          description: List of Commissioning functions filtered by any provided parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissioningFunctionList'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Commissioning functions failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/commissioningFunctions/profileMetaData:
    get:
      tags:
      - Commissioning Functions v1
      summary: getCommissioningProfileMetaDataForFunction
      description: >-
        Retrieves Metadata for Profiles Specific to Commissioning Function
         <p>Prerequisite: None.
      operationId: getCommissioningProfileMetaDataForFunction
      parameters:
      - name: function
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroups
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Profile MetaData Filtered for Input Function
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Profile MetaData failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/commissioningProfiles:
    get:
      tags:
      - Commissioning Profiles v1
      summary: getCommissioningProfiles
      description: >-
        Retrieves a list of commissioning profiles
         <p>Prerequisite: None.
      operationId: getCommissioningProfiles
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied.
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: List of commissioning Profiles Ids.
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroups
        in: query
        description: (Optional) List of type Group for Commissioning profile
        style: form
        explode: true
        schema:
          type: string
      - name: function
        in: query
        description: The commissioning Profiles by function to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: profileName
        in: query
        description: List of commissioning profiles names.
        style: form
        explode: true
        schema:
          type: string
      - name: description
        in: query
        description: The commissioning profiles by description to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: profileType
        in: query
        description: The commissioning profiles by profileType to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: typeGroups, function, profileType'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of Ccmmissioning profiles filtered by any provided parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissioningProfileList'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of commissioning profiles failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Commissioning Profiles v1
      summary: createCommissioningProfile
      description: >-
        <p>Upon success, code 201 is returned.<p>Prerequiste: The following attributes should be specified in the post request:<ul><li>typeGroups - The associated typeGroups<li>function - The associated function<li>profileName - The name of the commissioning profile<li>profileData - The list of key/value pair</ul><p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "commissioningProfile",
                "attributes": {
                    "typeGroups": ["Ciena6500"],
                    "function": "NTP",
                    "profileName": "A Test NTP Profile",
                    "description": "A Test NTP Profile",
                    "profileData": [
                        {
                            "key": "NTP Server1 IP",
                            "value": "10.186.0.220"
                        },
                        {
                            "key": "NTP Server2 IP",
                            "value": "10.186.3.98"
                        }
                    ],
                    "profileType": "Custom",
                    "role": "AN"
                }
            }
        }</code></pre>
      operationId: createCommissioningProfile
      parameters: []
      requestBody:
        description: Create commissioning profile
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CommissioningProfile'
              - description: Create commissioning profile
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissioningProfile'
        '201':
          description: CommissioningProfile object is created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissioningProfile'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/commissioningProfiles/{commissioningProfileId}:
    delete:
      tags:
      - Commissioning Profiles v1
      summary: deleteCommissioningProfile
      description: '<p>Prerequiste: The following attributes should be specified in the request:<ul><li>commissioningProfileId - commissioningProfile  id</ul>'
      operationId: deleteCommissioningProfile
      parameters:
      - name: commissioningProfileId
        in: path
        description: The commissioning profile with id to be removed.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Commissioning profile is successfully deleted
          headers: {}
          content: {}
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Commissioning profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Commissioning Profiles v1
      summary: updateCommissioningProfile
      description: >-
        <p>Upon success, code 200 is returned
         <p>Prerequisite: <p>Only profileData attribute is allowed to update<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "commissioningProfile",
                "attributes": {
                    "profileData": [
                        {
                            "key": "NTP Server1 IP",
                            "value": "10.186.0.220"
                        }
                    ]
                }
            }
        }</code></pre>
      operationId: updateCommissioningProfile
      parameters:
      - name: commissioningProfileId
        in: path
        description: Identifier of the commissioningProfile
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The partial Commissioning Profile data to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CommissioningProfile'
              - description: The partial Commissioning Profile data to update
        required: true
      responses:
        '200':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissioningProfile'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Commissioning profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/commissioning:
    get:
      tags:
      - Commissioning v1
      summary: getCommissioningSettings
      description: "List of Network Element(s) with Commissioning Settings details returned as a JSON list of objects \n <p>Prerequisite: One of the following parameter is required along with Commissioning Function: <ul><li>neNames - List of comma separated neName values<li>typeGroup - List of networkConstruct typeGroups<li>resourceType - List of networkConstruct resourceTypes<li>ipAddress- Ip Address of Network Construct</ul>"
      operationId: getCommissioningSettings
      parameters:
      - name: function
        in: query
        description: Commissioning Function
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: neNames
        in: query
        description: (Optional) List of comma separated neName values
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: associationState,resourceType , typeGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of Network Element(s) details with Commissioning Settings details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissioningSettingDetailsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve Network element upgrade details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Network element upgrade details failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Commissioning v1
      summary: applyFunctionAndProfile
      description: >-
        <p>Upon success, code 200 is returned.<p>Prerequisite: The following attributes should be specified in the post request:<ul><li>functionName - The commissioning function to be applied<li>commissioningProfiles - The Id of the commissioningProfile<li>networkConstructs - The Network Construct Id of NEs on which the commissioningProfile to be applied</ul><p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "id": "0d9b7924-ad50-48ab-aa0a-3d86f5651617",
                "type": "commissioning",
                "attributes": {
                    "resyncNE": false,
                    "functions": [
                        {
                            "functionName": "VRF",
                            "relationships": {
                                "commissioningProfile": {
                                    "data": {
                                        "type": "commissioningProfiles",
                                        "id": "c32b62bc-1f67-4d07-9b80-5c7cd4ea18bf"
                                    }
                                }
                            }
                        }
                    ]
                },
                "relationships": {
                    "networkConstructs": {
                        "data": [
                            {
                                "type": "networkConstructs",
                                "id": "473cca67-a2db-3bd2-a471-c8d1a8466064"
                            },
                            {
                                "type": "networkConstructs",
                                "id": "ee5f3f35-3c67-3200-8f5c-03bcdc38ada3"
                            }
                        ]
                    }
                }
            }
        }</code></pre>
      operationId: applyFunctionAndProfile
      parameters: []
      requestBody:
        description: Apply a commissioning profile of selected Function on a list of Network Elements
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Commissioning'
              - description: Apply a commissioning profile of selected Function on a list of Network Elements
        required: true
      responses:
        '200':
          description: Commissioning is applied.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/commissioning/{function}/remove:
    post:
      tags:
      - Commissioning v1
      summary: deleteCommissioningRequest
      description: >-
        <p>Upon success, code 200 is returned.<p>Prerequisite: The following attributes should be specified in the post request:<ul><li>functionName - The commissioning function to be applied<li>neCommissioningDetails - The Network Elements commissioning settings to be deleted</ul><p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "type": "commissioning",
            "attributes": {
              "neCommissioningDetails": [
                {
                  "neName": "5162-1_onxl8239",
                  "identifiers": [
                    {
                      "id": "isisInstanceNam1"
                    }
                  ]
                },
                {
                  "neName": "5162-2_onxl8239",
                  "identifiers": [
                    {
                      "id": "isisInstanceNam2"
                    }
                  ]
                }
              ]
            }
          }
        }</code></pre>
      operationId: deleteCommissioningRequest
      parameters:
      - name: function
        in: path
        description: Commissioning Function
        required: true
        style: simple
        schema:
          allOf:
          - $ref: '#/components/schemas/function1'
          - description: Commissioning Function
      requestBody:
        description: Commissioning delete request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeleteCommissioningRequest'
              - description: Commissioning delete request
        required: true
      responses:
        '200':
          description: The delete commissioning request successfully completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCommissioningRequest'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Failed to find the commissioning settings requested for deletion
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/backupImages:
    get:
      tags:
      - Configuration Details v1
      summary: getAllBackupImages
      description: "Get all Backups of given Network Element as a JSON list of objects \n<p>Prerequiste: Successfull Backup operation must executed to retrieve available images."
      operationId: getAllBackupImages
      parameters:
      - name: nename
        in: query
        description: Retrieve all backup images for an NE.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: netype
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of backup images for a Network Element
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeBackupImagesResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve backup images
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of backup images failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/backupRestoreStatus:
    get:
      tags:
      - Configuration Details v1
      summary: getNeBackupRestoreStatus
      description: "List of Network Element(s) Backup and Restore status returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: getNeBackupRestoreStatus
      parameters: []
      responses:
        '200':
          description: List of Network Element(s) Backup and Restore status
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeBackupRestoreStatusList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve Backup and Restore status
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Backup and Restore status failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/mhopbfdsessions:
    get:
      tags:
      - Create BFD session v1
      summary: getBFDSessions
      description: "This API returns a BFD session created on the NE. \n<p>Prerequisites: The following attributes should be specified in the get request:<ul><li>sourceNE - name of the source NE <li>neighbourNE (Optional) - name of the remote NE</ul>"
      operationId: getBFDSessions
      parameters:
      - name: sourceNE
        in: query
        description: Source NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: remoteNE
        in: query
        description: (Optional) Remote NE
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: BFD sessions retrieved
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Create BFD session v1
      summary: createBFDSession
      description: "This API creates a BFD session between two NEs. \n<p>Prerequisites: The following attributes should be specified in the post request:<ul><li>bfdSessionName - name of the BFD session <li>sourceNE - name of the source NE <li>neighbourNE - name of the neighbour NE<li>bfdProfileName - name of bfd profile to be used (optional parameter)</ul>"
      operationId: createBFDSession
      parameters: []
      requestBody:
        description: Create BFD session
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateBFDSessionRequest'
              - description: Create BFD session
        required: true
      responses:
        '200':
          description: Create BFD session request is executed.
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Create BFD session v1
      summary: deleteBFDSession
      description: "This API deletes a BFD session between two NEs. \n<p>Prerequisites: The following attributes should be specified in the post request:<ul><li>bfdSessionName - name of the BFD session <li>sourceNE - name of the source NE <li>neighbourNE - name of the neighbour NE</ul>"
      operationId: deleteBFDSession
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Delete BFD session request is executed.
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/lag/provisioning:
    post:
      tags:
      - Create?EditDelete a LAG and addremove LAG members.
      summary: lagProvisioning
      description: >-
        This API is to provision LAG.
         <p>Prerequisite: None.
      operationId: lagProvisioning
      parameters: []
      requestBody:
        description: Create, Update or Delete lag
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LagProvisioningRequest'
              - description: Create, Update or Delete lag
        required: true
      responses:
        '200':
          description: Ok
          headers: {}
          content: {}
        '201':
          description: LAG Provisioning operation executed successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorzed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service Unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/bgpsessions:
    post:
      tags:
      - CreateEdit BGP session v1
      summary: createBGPSession
      description: "This API creates, edits or delete a BGP session. \n<p>The following attributes can be specified in the request:<ul><li>action - action for operations. Values are 'create' and 'update' <li>addressFamilies - address family. Values are 'unicast' and labelled-unicast' <li>bfdMonitor - Values are 'shop' and 'mhop'. shop:singlehop BFD session, mhop: Multi hop bfd session\n<li>bgpBest2  - The key is to determine best-2 setting for BGP PIC configuration.\n<li>bgpDiversePath - The key is used to determine diverse_path setting for BGP PIC configuration.\n<li>description - Description of BGP session<li>vpnUnicast - To enable vpn-unicast<li>keepaliveTime - Keep alive time of BGP session <li>holdTime - Hold time of BGP session <li>advertisementInterval - Advertisement interval time of BGP session <li>grEnabled - Values are true or false \n<p>aEnd or zEnd attributes \n<li>neName - NE name or Management ip can be used<li>ipInterface - Used for bgp session on interface<li>nodeRole - Used for node role of NE. Values are 'AN', 'AGN'<li>peerAs - Used for peer as number of bgp session<li>peerIp - Used for peer ip of bgp session<li>shelf - Shelf no of NE<li>group - Equipmentgroup no of NE<li>rrEnabled - rrEnabled = true determines the server end of the session.<li>isSecretMode - True if password is in encrypted format else False.<li>authenticationPassword - authentication password of bgp session.<li>orf - orf values for bgp session.<li>prefixList - prefixList values for bgp session.<li>routeMap - routeMap values for bgp session.<li>nextHopSelf - nextHopSelf values for bgp session.<li>addPaths - addPath values for bgp session. Capability values are send/receive/both and advertise values are all/best-2/best-3<p>Deletion of BGP session : \n<li>action - action for operations. Value is 'delete' <li>neName - NE name or Management ip can be used<li>ipInterface - Used for bgp session on interface</ul>"
      operationId: createBGPSession
      parameters: []
      requestBody:
        description: Create, Update or Delete BGP session
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateBGPSessionRequest'
              - description: Create, Update or Delete BGP session
        required: true
      responses:
        '200':
          description: Create or Edit BGP session request is executed.
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/parentPolicer:
    post:
      tags:
      - CreateUpdateDelete Parent Policer v1
      summary: createParentPolicerOperation
      description: "This API Create Parent Policer. \n <p>Prerequiste: The following are the conditions and attributes should be specified in the post request:\"<ul><li>Parent Policer name to be created should not exist on NE<li>Either or both of NE name and NCID is Mandatory<li>neName - network element name<li>ncId - network construct id<li>parentPolicerName  - Name of the parent policer to create ,  this parameter is Mandatory <li>cir - cir value , this parameter is Mandatory<li>cbs - cbs value , this parameter is Mandatory<li>port - port associated with parent policer value , this parameter is recommended but not mandatory<li>reSyncInventory - Default is true , set to false to stop NE resync</ul>"
      operationId: createParentPolicerOperation
      parameters: []
      requestBody:
        description: Parent Policer Create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ParentPolicerCreateDetails'
              - description: Parent Policer Create
        required: true
      responses:
        '200':
          description: Create parent policer operation successful
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - CreateUpdateDelete Parent Policer v1
      summary: updateParentPolicerOperation
      description: "This API Update Parent Policer. \n <p>Prerequiste: The following are the conditions and attributes should be specified in the patch request:\"<ul><li>Parent Policer to be updated should exist on NE<li>Either or both of NE name and NCID is Mandatory<li>Either or both of CIR and CBS can only be updated for a parent policer and is Mandatory<li>neName - network element name<li>ncId - network construct id<li>parentPolicerName  - Name of the parent policer , this parameter is Mandatory<li>cir - cir value<li>cbs - cbs value<li>reSyncInventory - Default is true , set to false to stop NE resync</ul>"
      operationId: updateParentPolicerOperation
      parameters: []
      requestBody:
        description: Parent Policer Update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ParentPolicerUpdateDetails'
              - description: Parent Policer Update
        required: true
      responses:
        '200':
          description: Update parent policer operation successful
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - CreateUpdateDelete Parent Policer v1
      summary: deleteParentPolicerOperation
      description: "This API Delete Parent Policer. \n <p>Prerequiste: The following are the conditions and attributes should be specified in the delete request:\"<ul><li>Parent Policer to be deleted should exist on NE<li>No child should be assosicated with the parent policer to be deleted<li>Either or both of NE name and NCID is Mandatory<li>neName - network element name<li>ncId - network construct id<li>parentPolicerName  - Name of the parent policer , this parameter is Mandatory<li>reSyncInventory - Default is true , set to false to stop NE resync</ul>"
      operationId: deleteParentPolicerOperation
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Parent Policer deleted successful
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/customScripts:
    get:
      tags:
      - Custom Scripts v1
      summary: getCustomScripts
      description: "Custom scripts returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: getCustomScripts
      parameters:
      - name: typeGroup
        in: query
        description: TypeGroup of the custom scripts
        style: form
        explode: true
        schema:
          type: string
      - name: protocolType
        in: query
        description: Protocol type of the custom scripts
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ProtocolType11'
          - description: Protocol type of the custom scripts
      responses:
        '200':
          description: List of custom scripts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomScriptList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of custom scripts failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Custom Scripts v1
      summary: uploadCustomScript
      description: "Upload a script into cassandra database. \n <p>Prerequiste: None.\""
      operationId: uploadCustomScript
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              - typeGroup
              - protocolType
              - scriptName
              type: object
              properties:
                file:
                  type: string
                  description: The Input stream of the custom script file to be uploaded.
                  format: binary
                typeGroup:
                  type: string
                  description: TypeGroup for which this custom script file is uploaded
                protocolType:
                  $ref: '#/components/schemas/ProtocolType12'
                scriptName:
                  type: string
                  description: Name of the custom script
                description:
                  type: string
                  description: description of custom script
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomScriptList'
        '201':
          description: Custom script successfully uploaded
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomScriptList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/customScripts/scriptStatus:
    get:
      tags:
      - Custom Scripts v1
      summary: getCustomScriptsStatus
      description: "Custom scripts status returned as a JSON list of objects for Network elements \n <p>Prerequiste: None."
      operationId: getCustomScriptsStatus
      parameters: []
      responses:
        '200':
          description: Custom scripts status for list of Network Element(s)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CMOperationStatusList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of custom scripts status failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/customScripts/{id}:
    get:
      tags:
      - Custom Scripts v1
      summary: downloadCustomScript
      description: "download a custom script from cassandra database. \n <p>Prerequiste: None.\""
      operationId: downloadCustomScript
      parameters:
      - name: id
        in: path
        description: Custom script id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Custom script successfully downloaded
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '404':
          description: Not found
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
      deprecated: false
    delete:
      tags:
      - Custom Scripts v1
      summary: deleteCustomScript
      description: "deleteCustomScript a script from cassandra database. \n <p>Prerequiste: None.\""
      operationId: deleteCustomScript
      parameters:
      - name: id
        in: path
        description: Custom script id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Custom script successfully deleted
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
      deprecated: false
  /configmgmt/api/v2/customScripts:
    get:
      tags:
      - Custom Scripts v2
      summary: GetgetCustomScripts
      description: "List of Custom Script(s) details returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: GetgetCustomScripts
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied.
        style: form
        explode: true
        schema:
          type: string
      - name: scriptId
        in: query
        description: List of customScript Ids
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: The custom scripts by typeGroup to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: protocolType
        in: query
        description: The custom scripts by protocol type to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: scriptName
        in: query
        description: List of custom scripts names
        style: form
        explode: true
        schema:
          type: string
      - name: description
        in: query
        description: The custom scripts by description to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: protocolType, typeGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: Profiles fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomScriptsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/doc:
    get:
      tags:
      - DOC v1
      summary: getDOCs
      description: "Get DOC configuration for NEs \n<p>Attributes: <ul><li>networkConstructNames - List of comma networkConstructs name </ul><p>Prerequiste: None."
      operationId: getDOCs
      parameters:
      - name: networkConstructNames
        in: query
        description: Networkconstruct Names for which config DOCs to be retrieved.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Config DOCs fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigDOCResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - DOC v1
      summary: editDOCs
      description: "Edit DOCs configuration on NEs \n<p>Prerequiste: The following attributes should be specified in the post request:<ul><li>operationType - the operation to invoke enable/disable <p>docDetails \n<li>networkConstructName - The name of Network Element on which operation is invoked<li>docNames - Array of Doc names on which operation is invoked</ul>"
      operationId: editDOCs
      parameters: []
      requestBody:
        description: Edit DOCs
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EditDOC'
              - description: Edit DOCs
        required: true
      responses:
        '200':
          description: Edit DOCs successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigDOCResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /fallback-user-mgmt/api/v1/fallbackUsers:
    get:
      tags:
      - Fallback Users v1
      summary: getUsers
      description: Retrieve fallback user info for NEs
      operationId: getUsers
      parameters:
      - name: neNames
        in: query
        description: Comma-separated NE names
        style: form
        explode: true
        schema:
          type: string
      - name: lastOperationState
        in: query
        description: Last operation state, supported values are 'In-progress', 'Succeeded', 'Failed' and 'System-restored'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the next page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page, defaulted to 20
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Fallback user info is found successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackUserListResponse'
        '400':
          description: Query parameter value is invalid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Fallback Users v1
      summary: createUser
      description: >-
        Specify the NE resource type only to create fallback users on all managed NEs of the specified type.<p>Specify the NE resource type and a comma-separated list of NE names to create fallback users on the specified NEs.<p>A global UID and randomly generated passwords are used to create fallback users. UID and password are not specified in the request body.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "neType": "6500",
            "neNames": ["{{6500_NE_NAME}}"]
        }</code></pre>
      operationId: createUser
      parameters: []
      requestBody:
        description: Fallback user creation request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FallbackUserCreationRequest'
              - description: Fallback user creation request
        required: true
      responses:
        '202':
          description: Create user request is accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackUserCreationResponse'
        '400':
          description: The create user request input is invalid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Fallback Users v1
      summary: deleteUser
      description: >-
        Specify the NE resource type only to delete all fallback users previously created on NEs of the specified type.<p>Specify the NE resource type and a comma-separated list of NE names to delete fallback users on the specified NEs.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "neType": "6500",
            "neNames": ["{{6500_NE_NAME}}"]
        }</code></pre>
      operationId: deleteUser
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '202':
          description: Delete user request is accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackUserDeletionResponse'
        '400':
          description: The delete user request input is invalid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The fallback user is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: The NE is not managed in the system
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /fallback-user-mgmt/api/v1/fallbackUsers/passwordPolicy:
    get:
      tags:
      - Fallback Users v1
      summary: getPasswordPolicy
      description: Retrieve password generation values
      operationId: getPasswordPolicy
      parameters: []
      responses:
        '200':
          description: Password generation values fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackPasswordPolicyResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Fallback Users v1
      summary: updatePasswordPolicy
      description: Update password policy information
      operationId: updatePasswordPolicy
      parameters: []
      requestBody:
        description: Fallback password policy
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FallbackPasswordPolicyBO'
              - description: Fallback password policy
        required: true
      responses:
        '200':
          description: Password Policy updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackPasswordPolicyBO'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /fallback-user-mgmt/api/v1/fallbackUsers/resetPasswords:
    post:
      tags:
      - Fallback Users v1
      summary: resetFallbackPasswords
      description: >-
        Specify the NE resource type only to reset passwords for all fallback users previously created on NEs of the specified type.<p>Specify the NE resource type and a comma-separated list of NE names to reset fallback passwords on the specified NEs.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "neType": "6500",
            "neNames": ["{{6500_NE_NAME}}"],
            "resetSchedule": {
                    "startTime" : "2019-08-22T22:01:00Z",
                    "frequency" : "daily"
               }
        }</code></pre>
      operationId: resetFallbackPasswords
      parameters: []
      requestBody:
        description: Fallback password reset request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FallbackPasswordResetRequest'
              - description: Fallback password reset request
        required: true
      responses:
        '202':
          description: Reset password request is accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackPasswordResetResponse'
        '400':
          description: The reset password request input is invalid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The fallback user is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: The NE is not managed in the system
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /fallback-user-mgmt/api/v1/fallbackUsers/resetPasswords/schedules:
    get:
      tags:
      - Fallback Users v1
      summary: getPasswordResetSchedules
      description: Retrieve password reset schedules
      operationId: getPasswordResetSchedules
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Password reset schedules info is found successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackResetScheduleListResponse'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /fallback-user-mgmt/api/v1/fallbackUsers/resetPasswords/schedules/{id}:
    get:
      tags:
      - Fallback Users v1
      summary: getPasswordResetSchedule
      description: Retrieve specified password reset schedule
      operationId: getPasswordResetSchedule
      parameters:
      - name: id
        in: path
        description: The ID of the password reset schedule
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Password reset schedule is found successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FallbackResetScheduleResponse'
        '404':
          description: Failed to find the specified password reset schedule
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while searching
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Fallback Users v1
      summary: deletePasswordResetSchedule
      description: Delete specified password reset schedule
      operationId: deletePasswordResetSchedule
      parameters:
      - name: id
        in: path
        description: The ID of the password reset schedule
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Password reset schedule is deleted successfully
          headers: {}
          content: {}
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Failed to find the specified password reset schedule
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/packetmgmt/conflictingEntities:
    get:
      tags:
      - Managing Packet resources v1
      summary: conflictingEntities
      description: Conflicting Sid Data
      operationId: conflictingEntities
      parameters:
      - name: identifier
        in: query
        description: (Optional) Identifier, ConflictingSid or ConflictingLoop
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingSid'
        '201':
          description: Collection of information related to Conflicting Sid
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingSid'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve information related to Conflict Sid Data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of information related to Conflicting Entites failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/packetmgmt/segmentRoutingEnabledNetworkElements:
    get:
      tags:
      - Managing Packet resources v1
      summary: segmentRoutingEnabledNetworkElements
      description: >-
        List of Packet Resources details returned as a JSON list of objects
         <p>Prerequisite: None.
      operationId: segmentRoutingEnabledNetworkElements
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: (Optional) List of networkConstruct Ids
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of networkConstruct names
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: softwareActiveVersion
        in: query
        description: (Optional) List of networkConstruct software versions
        style: form
        explode: true
        schema:
          type: string
      - name: loopbackIpAddress
        in: query
        description: (Optional) Loopback IP Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: nodeSid
        in: query
        description: (Optional) Prefix SID of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. The allowed values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: recentOperation
        in: query
        description: '(Optional) List of recent operations. Allowable values: sidAssignment'
        style: form
        explode: true
        schema:
          type: string
      - name: recentOperationState
        in: query
        description: (Optional) Recent operation state of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: recentOperationProgressState
        in: query
        description: (Optional) Recent operation progress state of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: fromRecentOperationTime
        in: query
        description: (Optional) Time of recent operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: toRecentOperationTime
        in: query
        description: (Optional) Time of recent operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) Resource partition info
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, softwareActiveVersion'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PacketNEInfoCollection'
        '201':
          description: Collection of information related to packet network elements
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PacketNEInfoCollection'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve information related to packet network elements
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of information related to packet network elements failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/neBackups:
    post:
      tags:
      - Network Element Backup v1
      summary: createConfigMgmtBackup
      description: "This API validates user input and execute or schedule a network element  Backup. \n<p>Prerequiste: The following attributes should be specified in the post request:<ul><li>maxConnections - maximum connection <li>scheduleTime - time to when the job should be executed<li>scriptName - script name <li>profileName - profile name <li>type - type of job (eg: job)<li>neName - network element name<li>neType - network element type</ul>"
      operationId: createConfigMgmtBackup
      parameters: []
      requestBody:
        description: Execute job user input as JSON wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UserInput'
              - description: Execute job user input as JSON wrapper object
        required: true
      responses:
        '200':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/jobs:
    get:
      tags:
      - Network Element Configuration Job Management v1
      summary: getAllConfigMgmtJobs
      description: "Get jobs status as a list of JSON objects of all executed or scheduled jobs given the job id \n<p>Prerequiste: None."
      operationId: getAllConfigMgmtJobs
      parameters:
      - name: scriptName
        in: query
        description: The job name used for current status of a config job lookup
        style: form
        explode: true
        schema:
          type: string
      - name: cmdFileName
        in: query
        description: The name of the custom script command file name
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieve all job status
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigMgmtJobResponse'
        '404':
          description: Network element configuration job is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Network Element Configuration Job Management v1
      summary: createConfigMgmtJob
      description: "This API validates user input and execute or schedule a network element configuration job. \n<p>Prerequiste: The following attributes should be specified in the post request:<ul><li>maxConnections - maximum connection <li>scheduleTime - time to when the job should be executed<li>scriptName - script name <li>profileName - profile name <li>type - type of job (eg: job)<li>neName - network element name<li>neType - network element type</ul>"
      operationId: createConfigMgmtJob
      parameters: []
      requestBody:
        description: Execute job user input as JSON wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UserInput'
              - description: Execute job user input as JSON wrapper object
        required: true
      responses:
        '201':
          description: Network element configuration job is executed and scheduled.
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/jobs/{jobId}:
    get:
      tags:
      - Network Element Configuration Job Management v1
      summary: getConfigMgmtJob
      description: "Get the job status as a JSON object given the job id \n<p>Prerequiste: Jobs must exist for specified jobId."
      operationId: getConfigMgmtJob
      parameters:
      - name: jobId
        in: path
        description: The job execution id used for current status of a config job lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Retrieve job status
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigMgmtJobResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Network element configuration job is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Network Element Configuration Job Management v1
      summary: deleteConfigMgmtJob
      description: "Delete a job \n<p>Prerequiste: Jobs must exist for specified jobId."
      operationId: deleteConfigMgmtJob
      parameters:
      - name: jobId
        in: path
        description: The job execution id used for current status of a config job lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Job deleted
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Network element configuration job is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Network Element Configuration Job Management v1
      summary: patchConfigMgmtJobPatch
      description: >-
        This API updates the config job execution attributes.
         <p>Prerequiste: Jobs must exist for specified jobId.
      operationId: patchConfigMgmtJobPatch
      parameters:
      - name: jobId
        in: path
        description: The job execution id used for current status of a config job lookup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Update config job execution user input attributes as JSON wrapper object
        content:
          application/json:
            schema:
              type: string
              description: Update config job execution user input attributes as JSON wrapper object
        required: true
      responses:
        '200':
          description: Config job attributes are updated and scheduled
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInput'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/neRestores:
    post:
      tags:
      - Network Element Restore v1
      summary: configMgmtRestore
      description: "This API validates user input and execute or schedule a network element Restore. \n<p>Prerequiste: The following attributes should be specified in the post request:<ul><li>maxConnections - maximum connection <li>scheduleTime - time to when the job should be executed<li>scriptName - script name <li>profileName - profile name <li>type - type of job (eg: job)<li>neName - network element name<li>neType - network element type</ul>"
      operationId: configMgmtRestore
      parameters: []
      requestBody:
        description: Execute job user input as JSON wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UserInput'
              - description: Execute job user input as JSON wrapper object
        required: true
      responses:
        '200':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/neMaintenanceDetails:
    get:
      tags:
      - Network Elements Maintenance Details Resource v1
      summary: getNetworkElementsMaintenance
      description: "List of Network Element(s) Maintenance details returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: getNetworkElementsMaintenance
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: List of networkConstruct Ids
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: List of networkConstruct names
        style: form
        explode: true
        schema:
          type: string
      - name: longName
        in: query
        description: (Optional) List of comma separated longName values
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values
        style: form
        explode: true
        schema:
          type: string
      - name: sessionId
        in: query
        description: List of Management Session Ids
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. The allowed values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: syncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. The allowed values are: notSynchronized, synchronizing, synchronized, failed, aborted, deleting, deleteFailed'
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id
        style: form
        explode: true
        schema:
          type: string
      - name: subnetName
        in: query
        description: (Optional) SubnetName of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: softwareActiveVersion
        in: query
        description: (Optional) List of networkConstruct software versions
        style: form
        explode: true
        schema:
          type: string
      - name: recentOperation
        in: query
        description: '(Optional) List of Recent operations. The allowed values are: Download, Upgrade, PostUpgrade, CommitUpgrade, CancelUpgrade, FULLUPGRADE, BACKUP, RESTORE, SCRIPT, CUSTOM_SCRIPT'
        style: form
        explode: true
        schema:
          type: string
      - name: nextOperation
        in: query
        description: '(Optional) List of Next operations. The allowed values are: Download, Upgrade, PostUpgrade, CommitUpgrade, CancelUpgrade, FULLUPGRADE, BACKUP, RESTORE, SCRIPT, CUSTOM_SCRIPT'
        style: form
        explode: true
        schema:
          type: string
      - name: recentOperationState
        in: query
        description: (Optional) Recent operation state of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: recentOperationProgressState
        in: query
        description: (Optional) Recent operation progress state of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: softwareAvailableVersion
        in: query
        description: (Optional) Software version available on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: backupSchedule
        in: query
        description: (Optional) List of backup schedules for Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: upgradeSchedule
        in: query
        description: (Optional) List of upgrade schedules for Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: customScriptSchedule
        in: query
        description: (Optional) List of customScript schedules for Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: fromRecentOperationTime
        in: query
        description: (Optional) Time of recent operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: toRecentOperationTime
        in: query
        description: (Optional) Time of recent operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: fromNextOperationTime
        in: query
        description: (Optional) Time of next operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: toNextOperationTime
        in: query
        description: (Optional) Time of next operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) Resource partition info
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifier
        in: query
        description: (Optional) Association state qualifier. The allowed values are MANUAL, SYSTEM, NETWORK
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, syncState, softwareActiveVersion, associationStateQualifier'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of Network Element(s) maintenance details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeMaintenanceDetailsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve Network element maintenance details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Network element maintenance details failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/neUpgradeDetails:
    get:
      tags:
      - Network Elements Upgrade Details Resource v1
      summary: GetgetNetworkElementsMaintenance
      description: "List of Network Element(s) upgrade details returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: GetgetNetworkElementsMaintenance
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: List of networkConstruct Ids
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: List of networkConstruct names
        style: form
        explode: true
        schema:
          type: string
      - name: longName
        in: query
        description: (Optional) List of comma separated longName values
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values
        style: form
        explode: true
        schema:
          type: string
      - name: sessionId
        in: query
        description: List of Management Session Ids
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. The allowed values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: syncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. The allowed values are: notSynchronized, synchronizing, synchronized, failed, aborted, deleting, deleteFailed'
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id
        style: form
        explode: true
        schema:
          type: string
      - name: subnetName
        in: query
        description: (Optional) SubnetName of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: softwareActiveVersion
        in: query
        description: (Optional) List of networkConstruct software versions
        style: form
        explode: true
        schema:
          type: string
      - name: softwareAvailableVersion
        in: query
        description: (Optional) Software version available on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: upgradeSchedules
        in: query
        description: (Optional) List of upgrade schedules for Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: releaseMgmtSchedules
        in: query
        description: (Optional) List of releaseMgmt schedules for Network Constructs
        style: form
        explode: true
        schema:
          type: string
      - name: upgradeStage
        in: query
        description: (Optional) List of upgrade stages for Network Constructs
        style: form
        explode: true
        schema:
          type: string
      - name: upgradeStatus
        in: query
        description: (Optional) List of upgrade status for Network Constructs
        style: form
        explode: true
        schema:
          type: string
      - name: manualInvokeOnCards
        in: query
        description: (Optional) Network Constructs with manual Invoke
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) Resource partition info
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifier
        in: query
        description: (Optional) Association state qualifier. The allowed values are MANUAL, SYSTEM, NETWORK
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, syncState, softwareActiveVersion, associationStateQualifier, upgradeStage, upgradeStatus, manualInvokeOnCards'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of Network Element(s) upgrade details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeUpgradeDetailsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve Network element upgrade details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Network element upgrade details failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/port/deProvision:
    post:
      tags:
      - Port Provisioning v1
      summary: deProvisionPort
      description: "Port De-provisioning. \n <p>Prerequiste: None.\""
      operationId: deProvisionPort
      parameters: []
      requestBody:
        description: De-provisioning Details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PortDeProvisioningDetails'
              - description: De-provisioning Details
        required: true
      responses:
        '200':
          description: Port de-provisioned successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/port/mappings:
    get:
      tags:
      - Port Provisioning v1
      summary: getAllPortRateMappings
      description: "PecCode mapping definitions returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: getAllPortRateMappings
      parameters: []
      responses:
        '200':
          description: List of pec code mapping definitions
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortMappingList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Retrieval of pec code mapping definitions failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Port Provisioning v1
      summary: uploadPortRateMappingFile
      description: "Upload a pec code mapping definition into cassandra database. \n <p>Prerequiste: None.\""
      operationId: uploadPortRateMappingFile
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              - name
              type: object
              properties:
                file:
                  type: string
                  description: The Input stream of the pec code mapping definition to be uploaded.
                  format: binary
                name:
                  type: string
                  description: Name of the pec code mapping definition
        required: false
      responses:
        '201':
          description: Pec code mapping definition successfully uploaded
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortMapping'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/port/mappings/{id}:
    get:
      tags:
      - Port Provisioning v1
      summary: downloadPortRateMappping
      description: "download a pec code mapping definition from cassandra database. \n <p>Prerequiste: None.\""
      operationId: downloadPortRateMappping
      parameters:
      - name: id
        in: path
        description: Pec code mapping definition id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Pec code mapping definition successfully downloaded
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
      deprecated: false
    delete:
      tags:
      - Port Provisioning v1
      summary: deletePortRateMapping
      description: "Delete pec code mapping definition from cassandra database. \n <p>Prerequiste: None.\""
      operationId: deletePortRateMapping
      parameters:
      - name: id
        in: path
        description: Pec code mapping definition id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Pec code mapping definition successfully deleted
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
      deprecated: false
  /configmgmt/api/v1/port/pecs:
    get:
      tags:
      - Port Provisioning v1
      summary: getAllPecCodeMappings
      description: "Pec code definitions returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: getAllPecCodeMappings
      parameters: []
      responses:
        '200':
          description: List of pec code definitions
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortMappingList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Retrieval of pec code definitions failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Port Provisioning v1
      summary: uploadPecCodeFile
      description: "Upload a pec code definition into cassandra database. \n <p>Prerequiste: None.\""
      operationId: uploadPecCodeFile
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              - name
              type: object
              properties:
                file:
                  type: string
                  description: The Input stream of the pec code definition to be uploaded.
                  format: binary
                name:
                  type: string
                  description: Name of the pec code definition
        required: false
      responses:
        '201':
          description: Pec code definition successfully uploaded
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortMapping'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/port/pecs/{id}:
    get:
      tags:
      - Port Provisioning v1
      summary: downloadPecCodeMapping
      description: "download a pec code definition from cassandra database. \n <p>Prerequiste: None.\""
      operationId: downloadPecCodeMapping
      parameters:
      - name: id
        in: path
        description: Pec code definition id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Pec code definition successfully downloaded
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
      deprecated: false
    delete:
      tags:
      - Port Provisioning v1
      summary: deletePecCodeMapping
      description: "Delete pecCode definition from cassandra database. \n <p>Prerequiste: None.\""
      operationId: deletePecCodeMapping
      parameters:
      - name: id
        in: path
        description: Pec code definition id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Pec code definition successfully deleted
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
      deprecated: false
  /configmgmt/api/v1/port/provision:
    post:
      tags:
      - Port Provisioning v1
      summary: provisionPort
      description: "Port provisioning. \n <p>Prerequiste: None.\""
      operationId: provisionPort
      parameters: []
      requestBody:
        description: Provisioning Details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PortProvisioningDetails'
              - description: Provisioning Details
        required: true
      responses:
        '200':
          description: Port provisioned successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/profiles:
    get:
      tags:
      - Profiles v1
      summary: getFtpProfiles
      description: "Get profiles informations for profileType or typeGroup \n<p>Attributes: <ul><li>name - profile name <li>profileType - profile type <li>protocolType - protocol used to do file transfer (here supported protocolType is ftp, sftp and https)<li>storageMethod - Used to specify if to use database or file system<li>userName - user name <li>userPassword - user password <li>ipAddress - Ip Address of the machine <li>port - port no to access the machine<li>imageLocation - Image location for doing file transfer from \n<p>\n Additional attributes: <li>typeGroup - Used for network element typeGroup in profile type upgrade<li>releaseNumber - Used for network element release number for profile type upgrade<li>numberOfBackupFiles - used for number of backup files to be maintained for profile type backup_restore<li>sshPort - used for profile type backup_restore and upgrade \n<li>profileDescription - profile description</ul><p>Prerequiste: None."
      operationId: getFtpProfiles
      parameters:
      - name: profileType
        in: query
        description: The NE Maintenance profiles by profile type to be retrieved.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ProfileType11'
          - description: The NE Maintenance profiles by profile type to be retrieved.
      - name: neType
        in: query
        description: The NE Maintenance profiles by typeGroup to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Profiles fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FtpProfileResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    post:
      tags:
      - Profiles v1
      summary: createFtpProfile
      description: "The Api to create Profile as a JSON Object \n <p>Prerequiste: The following attributes should be specified in the post request:<ul><li>name - profile name <li>profileType - profile type <li>protocolType - protocol used to do file transfer (here supported protocolType is ftp, sftp and https)<li>storageMethod - Used to specify if to use database or file system<li>userName - user name <li>userPassword - user password <li>ipAddress - Ip Address of the machine <li>port - port no to access the machine<li>imageLocation - Image location for doing file transfer from \n<p>Additional attributes \n<li>typeGroup - Used for network element typeGroup in profile type upgrade<li>releaseNumber - Used for network element release number for profile type upgrade<li>numberOfBackupFiles - used for number of backup files to be maintained for profile type backup_restore<li>sshPort - used for profile type backup_restore and upgrade<li>profileDescription - profile description</ul>"
      operationId: createFtpProfile
      parameters: []
      requestBody:
        description: Create profile
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FtpProfile'
              - description: Create profile
        required: true
      responses:
        '200':
          description: profile created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FtpProfileAttribs'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Creation of profiles failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/profiles/associations/{profileId}:
    get:
      tags:
      - Profiles v1
      summary: getFtpProfileAssociations
      description: "Get profile association information as a JSON Object for given profile id. \n <p>Attributes: \n<ul><li>jobExecuted - job execution status <li>associatedSchedules - associated schedules </ul><p>Prerequiste: Profile must exist for specified profile id."
      operationId: getFtpProfileAssociations
      parameters:
      - name: profileId
        in: path
        description: The ftp profile id for which associations to be retrieved.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Profile association fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileAssociations'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/profiles/{profileId}:
    get:
      tags:
      - Profiles v1
      summary: getFtpProfileBasedOnId
      description: "Get profile information as a JSON Object for given profile id. \n <p>Attributes: \n<ul><li>name - profile name <li>profileType - profile type <li>protocolType - protocol used to do file transfer (here supported protocolType is ftp, sftp and https)<li>storageMethod - Used to specify if to use database or file system<li>userName - user name <li>userPassword - user password <li>ipAddress - Ip Address of the machine <li>port - port no to access the machine<li>imageLocation - Image location for doing file transfer from \n<p>Additional attributes: \n<li>typeGroup - Used for network element typeGroup in profile type upgrade<li>releaseNumber - Used for network element release number for profile type upgrade<li>numberOfBackupFiles - used for number of backup files to be maintained for profile type backup_restore<li>sshPort - used for profile type backup_restore and upgrade \n<li>profileDescription - profile description</ul><p>Prerequiste: Profile must exist for specified profile id."
      operationId: getFtpProfileBasedOnId
      parameters:
      - name: profileId
        in: path
        description: The ftp profile with id to be retrieved.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Profile fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FtpProfileAttribs'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    delete:
      tags:
      - Profiles v1
      summary: deleteProfile
      description: "Delete the profile with given profile id. \n <p>Prerequiste: The following attributes should be specified in the request:<ul><li>profileId - profile id</ul>"
      operationId: deleteProfile
      parameters:
      - name: profileId
        in: path
        description: The ftp profile with id to be retrieved.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: profile is deleted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Profile are not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Profiles v1
      summary: updateFtpProfile
      description: "Update profile information as a JSON Object for given profile id. \n <p>For backup_restore profile type, Following attributes can be modified<ul><li>userName - user name <li>userPassword - user password <li>port - port no to access the machine<li>numberOfBackupFiles - used for number of backup files to be maintained for profile type backup_restore, This setting will take effect on next backup<li>sshPort - used for profile type backup_restore and upgrade<li>profileDescription - profile description</ul><p>For upgrade profile type, Following attributes can be modified<ul><li>userName - user name <li>userPassword - user password <li>ipAddress - Ip Address of the machine <li>port - port no to access the machine<li>imageLocation - Image location for doing file transfer from \n<li>sshPort - used for profile type backup_restore and upgrade<li>profileDescription - profile description</ul><p>Prerequiste: Profile must exist for specified profile id."
      operationId: updateFtpProfile
      parameters:
      - name: profileId
        in: path
        description: The ftp profile with id to be retrieved.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: updated profile
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FtpProfile'
              - description: updated profile
        required: true
      responses:
        '200':
          description: Profile updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FtpProfileAttribs'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v2/profiles:
    get:
      tags:
      - Profiles v2
      summary: GetgetFtpProfiles
      description: "Get profiles informations for profileType or typeGroup \n<p>Attributes: <ul><li>name - profile name <li>profileType - profile type <li>protocolType - protocol used to do file transfer (here supported protocolType is ftp, sftp and https)<li>storageMethod - Used to specify if to use database or file system<li>userName - user name <li>userPassword - user password <li>ipAddress - Ip Address of the machine <li>port - port no to access the machine<li>imageLocation - Image location for doing file transfer from \n<p>\n Additional attributes: <li>typeGroup - Used for network element typeGroup in profile type upgrade<li>releaseNumber - Used for network element release number for profile type upgrade<li>numberOfBackupFiles - used for number of backup files to be maintained for profile type backup_restore<li>sshPort - used for profile type backup_restore and upgrade \n<li>profileDescription - profile description</ul><p>Prerequiste: None."
      operationId: GetgetFtpProfiles
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied.
        style: form
        explode: true
        schema:
          type: string
      - name: profileId
        in: query
        description: List of profile Ids
        style: form
        explode: true
        schema:
          type: string
      - name: profileType
        in: query
        description: The NE Maintenance profiles by profile type to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: The NE Maintenance profiles by typeGroup to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: List of profile names
        style: form
        explode: true
        schema:
          type: string
      - name: releaseNumber
        in: query
        description: The NE Maintenance upgrade profiles by release number to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: storageMethod
        in: query
        description: The NE Maintenance profiles by storage method to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: port
        in: query
        description: The NE Maintenance profiles by port to be retrieved.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sshPort
        in: query
        description: The NE Maintenance profiles by sshPort to be retrieved.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: protocolType
        in: query
        description: The NE Maintenance profiles by protocol type to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: profileType, protocolType, storageMethod'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: Profiles fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeMaintenanceProfilesList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Profiles v2
      summary: PostcreateFtpProfile
      description: "The Api to create Profile as a JSON Object \n <p>Prerequiste: The following attributes should be specified in the post request:<ul><li>name - profile name <li>profileType - profile type <li>protocolType - protocol used to do file transfer (here supported protocolType is ftp, sftp and https)<li>storageMethod - Used to specify if to use database or file system<li>userName - user name <li>userPassword - user password <li>ipAddress - Ip Address of the machine <li>port - port no to access the machine<li>imageLocation - Image location for doing file transfer from \n<p>Additional attributes \n<li>typeGroup - Used for network element typeGroup in profile type upgrade<li>releaseNumber - Used for network element release number for profile type upgrade<li>numberOfBackupFiles - used for number of backup files to be maintained for profile type backup_restore<li>sshPort - used for profile type backup_restore and upgrade<li>profileDescription - profile description</ul>"
      operationId: PostcreateFtpProfile
      parameters: []
      requestBody:
        description: Create profile
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FtpProfile'
              - description: Create profile
        required: true
      responses:
        '200':
          description: profile created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeMaintenanceProfilesList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Creation of profiles failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v2/profiles/{profileId}:
    patch:
      tags:
      - Profiles v2
      summary: PatchupdateFtpProfile
      description: "Update profile information as a JSON Object for given profile id. \n <p>For backup_restore profile type, Following attributes can be modified<ul><li>userName - user name <li>userPassword - user password <li>port - port no to access the machine<li>numberOfBackupFiles - used for number of backup files to be maintained for profile type backup_restore, This setting will take effect on next backup<li>sshPort - used for profile type backup_restore and upgrade<li>profileDescription - profile description</ul><p>For upgrade profile type, Following attributes can be modified<ul><li>userName - user name <li>userPassword - user password <li>ipAddress - Ip Address of the machine <li>port - port no to access the machine<li>imageLocation - Image location for doing file transfer from \n<li>sshPort - used for profile type backup_restore and upgrade<li>profileDescription - profile description</ul><p>Prerequiste: Profile must exist for specified profile id."
      operationId: PatchupdateFtpProfile
      parameters:
      - name: profileId
        in: path
        description: The ftp profile with id to be retrieved.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: updated profile
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FtpProfile'
              - description: updated profile
        required: true
      responses:
        '200':
          description: Profile updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeMaintenanceProfilesList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/bgpconfiguration/{nename}:
    get:
      tags:
      - Provision BGP nodal commissioning
      summary: getBGPConfiguration
      description: "GET bgp configuration \n<p>Prerequiste: Bgp configuration is expected to exist."
      operationId: getBGPConfiguration
      parameters:
      - name: nename
        in: path
        description: The nename is used for bgp configuration lookup
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: BGP configuration retrieved
          headers: {}
          content: {}
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/queue/provisioning:
    post:
      tags:
      - Queue provisioning.
      summary: lagQueueProvisioning
      description: "This API configures or migrates Queue. \n <p>Prerequisite: None."
      operationId: lagQueueProvisioning
      parameters: []
      requestBody:
        description: Queue configuration and migration
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/QueueProvisionRequest'
              - description: Queue configuration and migration
        required: true
      responses:
        '200':
          description: Ok
          headers: {}
          content: {}
        '201':
          description: Queue Provisioning operation executed successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorzed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '405':
          description: Not Allowed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '406':
          description: Not acceptable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service Unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/schedules:
    get:
      tags:
      - Schedule Management v1
      summary: getSchedules
      description: "List of Network Element(s) Maintenance details returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: getSchedules
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied.
        style: form
        explode: true
        schema:
          type: string
      - name: scheduleId
        in: query
        description: List of schedule Ids
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: List of schedule names
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: List of schedule types
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: List of schedule states
        style: form
        explode: true
        schema:
          type: string
      - name: profileName
        in: query
        description: List of profile names
        style: form
        explode: true
        schema:
          type: string
      - name: releaseNumber
        in: query
        description: List of releaseNumbers
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: List of typeGroups
        style: form
        explode: true
        schema:
          type: string
      - name: frequency
        in: query
        description: List of schedule frequencies, Allowed values ONCE, DAILY, WEEKLY, MONTHLY
        style: form
        explode: true
        schema:
          type: string
      - name: weekDays
        in: query
        description: List of Schedule weekdays
        style: form
        explode: true
        schema:
          type: string
      - name: monday
        in: query
        description: Monday, Allowed values ON or OFF
        style: form
        explode: true
        schema:
          type: string
      - name: tuesday
        in: query
        description: Tuesday, Allowed values ON or OFF
        style: form
        explode: true
        schema:
          type: string
      - name: wednesday
        in: query
        description: Wednesday, Allowed values ON or OFF
        style: form
        explode: true
        schema:
          type: string
      - name: thursday
        in: query
        description: Thursday, Allowed values ON or OFF
        style: form
        explode: true
        schema:
          type: string
      - name: friday
        in: query
        description: Friday, Allowed values ON or OFF
        style: form
        explode: true
        schema:
          type: string
      - name: saturday
        in: query
        description: Saturdy, Allowed values ON or OFF
        style: form
        explode: true
        schema:
          type: string
      - name: sunday
        in: query
        description: Sunday, Allowed values ON or OFF
        style: form
        explode: true
        schema:
          type: string
      - name: fromRecentOperationTime
        in: query
        description: (Optional) Time of recent operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: toRecentOperationTime
        in: query
        description: (Optional) Time of recent operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: fromNextOperationTime
        in: query
        description: (Optional) Time of next operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: toNextOperationTime
        in: query
        description: (Optional) Time of next operation on Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) Resource partition info
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: type, frequency, state, weekDays'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of Network Element(s) maintenance details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleDetailsResponseList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve Network element maintenance details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Network element maintenance details failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Schedule Management v1
      summary: createSchedule
      description: Create Schedule
      operationId: createSchedule
      parameters: []
      requestBody:
        description: The schedule attributes to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ScheduleAttributes'
              - description: The schedule attributes to create
        required: true
      responses:
        '200':
          description: Schedule Created
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service Unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/schedules/nes:
    patch:
      tags:
      - Schedule Management v1
      summary: updateScheduleNes
      description: "Updates Schedule Nes. \n<p>Prerequiste: Schedule must exist."
      operationId: updateScheduleNes
      parameters: []
      requestBody:
        description: The schedule attributes to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ScheduleNesPatch'
              - description: The schedule attributes to update
        required: true
      responses:
        '204':
          description: Schedule updated
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service Unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/schedules/{scheduleId}:
    put:
      tags:
      - Schedule Management v1
      summary: updateSchedule
      description: "Updates Schedule attributes. \n<p>Prerequiste: Schedule must exist."
      operationId: updateSchedule
      parameters:
      - name: scheduleId
        in: path
        description: Update schedule associated with given scheduleId
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The schedule attributes to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ScheduleAttributes'
              - description: The schedule attributes to update
        required: true
      responses:
        '200':
          description: Schedule updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleDetailsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service Unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Schedule Management v1
      summary: DeletedeleteConfigMgmtBatch
      description: "Delete the schedule with given schedule Id. \n <p>Prerequiste: The following attributes should be specified in the request:<ul><li>scheduleId - Schedule Id</ul>"
      operationId: DeletedeleteConfigMgmtBatch
      parameters:
      - name: scheduleId
        in: path
        description: Id of the schedule to be deleted.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Schedule is deleted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Schedule not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/schedule/assignNE:
    post:
      tags:
      - Scheduls Assign NE v1
      summary: updateSchedulePOST
      description: Assign Schedules to NE Ip with partition id
      operationId: updateSchedulePOST
      parameters: []
      requestBody:
        description: Schedule NE Mapping
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SchedulesAssignNE'
              - description: Schedule NE Mapping
        required: true
      responses:
        '201':
          description: Pre-Enroll Successful.
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service Unavailable
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Scheduls Assign NE v1
      summary: DeletedeleteConfigMgmtBatch1
      description: Delete a schedule assigned to NE during pre-enrollment
      operationId: DeletedeleteConfigMgmtBatch1
      parameters: []
      responses:
        '201':
          description: Schedule to NE mapping is deleted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Schedule not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/scriptExecutionDetails:
    get:
      tags:
      - Script Execution Details v1
      summary: getScriptExecutionDetails
      description: >-
        Retrieves a list of Script Execution Details
         <p>Prerequisite: None.
      operationId: getScriptExecutionDetails
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied.
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: List of Script Execution Details Ids.
        style: form
        explode: true
        schema:
          type: string
      - name: operationType
        in: query
        description: The Script Execution Details by operation type to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: jobid
        in: query
        description: The Script Execution Details by jobid to be retrieved.
        style: form
        explode: true
        schema:
          type: string
      - name: scriptName
        in: query
        description: List of Script Execution Details by scriptName .
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: operationType, jobid, scriptName'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of Script Execution Details filtered by any provided parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptExecutionDetailsList'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of Script Execution Details (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/scriptExecutionDetails/{jobID}:
    get:
      tags:
      - Script Execution Details v1
      summary: GetdownloadCustomScript
      description: "Download output of custom script. \n <p>Prerequiste: None.\""
      operationId: GetdownloadCustomScript
      parameters:
      - name: jobID
        in: path
        description: Custom script job id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Custom script output successfully downloaded
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '500':
          description: Internal system error
          headers: {}
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
      deprecated: false
  /configmgmt/api/v1/scripts:
    get:
      tags:
      - Script Management v1
      summary: getAllScripts
      description: "Get all available scripts present in the config management root directory \n <p>Prerequiste: None."
      operationId: getAllScripts
      parameters: []
      responses:
        '200':
          description: Scripts retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptDefResponseBO'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Script is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/scriptsByName/{scriptName}:
    get:
      tags:
      - Script Management v1
      summary: getScriptByName
      description: "Get script by Script Name, if present in the config management root directory \n <p>Prerequiste: Scripts must exist for specified scriptName."
      operationId: getScriptByName
      parameters:
      - name: scriptName
        in: path
        description: The type group used for scripts lookup
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptDefResponseBO'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Script is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/scriptsByTypeGroup/{typeGroup}:
    get:
      tags:
      - Script Management v1
      summary: getAllScriptsByTypeGroup
      description: "Get scripts belongs to the given TypeGroup, present in the config management root directory \n <p>Prerequiste: Scripts must exist for specified typeGroup."
      operationId: getAllScriptsByTypeGroup
      parameters:
      - name: typeGroup
        in: path
        description: The type group used for scripts lookup
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Script is retrieved based on typeGroup
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptDefResponseBO'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Script is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/scriptProfiles:
    get:
      tags:
      - Script Profiles v1
      summary: GetgetCustomScripts1
      description: "Script Profiles returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: GetgetCustomScripts1
      parameters: []
      responses:
        '200':
          description: List of script profiles
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptProfileList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Retrieval of script profiles failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Script Profiles v1
      summary: uploadScriptProfile
      description: "Upload a script profile into cassandra database. \n <p>Prerequiste: None.\""
      operationId: uploadScriptProfile
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              - profileName
              type: object
              properties:
                file:
                  type: string
                  description: The Input stream of the script profile to be uploaded.
                  format: binary
                profileName:
                  type: string
                  description: Name of the script profile
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptProfileList'
        '201':
          description: Script profile successfully uploaded
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptProfileList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/scriptProfiles/{id}:
    get:
      tags:
      - Script Profiles v1
      summary: downloadScriptProfile
      description: "download a script profile from cassandra database. \n <p>Prerequiste: None.\""
      operationId: downloadScriptProfile
      parameters:
      - name: id
        in: path
        description: Script profile id
        required: true
        style: simple
        schema:
          type: string
      - name: content
        in: query
        description: (Optional) The Script profile output content
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content21'
          - description: (Optional) The Script profile output content
      responses:
        '200':
          description: Script profile successfully downloaded
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
            application/json:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
            application/json:
              schema: {}
      deprecated: false
    put:
      tags:
      - Script Profiles v1
      summary: updateScriptProfile
      description: >-
        <p>Upon success, code 200 is returned.<p>Prerequiste: The following attributes should be specified in the post request:<ul><li>id - The id of the script profile<li>profileName - The name of the script profile<li>profileParams - The key/value pair for the profile</ul><p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "scriptProfile",
                "attributes": {
                    "profileName": "vlanProfile_6.x",
                    "profileParams": [
                        {
                            "key": "VLAN_ID",
                            "value": "915"
                        },
                        {
                            "key": "VLAN_PORT_ID",
                            "value": "5"
                        },
                        {
                            "key": "MAX_FRAME_SIZE",
                            "value": "9216"
                        },
                        {
                            "key": "INTERFACE_NAME",
                            "value": "if2"
                        },
                        {
                            "key": "IP_ADDRESS",
                            "value": "10.9.9.9/24"
                        },
                        {
                            "key": "ORIG_MAX_FRAME_SIZE",
                            "value": "1526"
                        }
                    ]
                }
            }
        }</code></pre>
      operationId: updateScriptProfile
      parameters:
      - name: id
        in: path
        description: Script profile id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new script profile data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ScriptProfile'
              - description: The new script profile data
        required: true
      responses:
        '200':
          description: Script Profile with given id has been updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptProfileList'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Script Profiles v1
      summary: deleteScriptProfile
      description: "Delete script profile from cassandra database. \n <p>Prerequiste: None.\""
      operationId: deleteScriptProfile
      parameters:
      - name: id
        in: path
        description: Script profile id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Script profile successfully deleted
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            multipart/form-data:
              schema: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            multipart/form-data:
              schema: {}
      deprecated: false
  /configmgmt/api/v2/scriptProfiles:
    get:
      tags:
      - Script Profiles v2
      summary: getScriptProfiles
      description: "List of Script Profile(s) details returned as a JSON list of objects \n <p>Prerequiste: None."
      operationId: getScriptProfiles
      parameters:
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied.
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: List of script profile Ids
        style: form
        explode: true
        schema:
          type: string
      - name: profileName
        in: query
        description: List of script profile names
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: Script Profiles fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptProfileList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Script Profiles v2
      summary: createScriptProfile
      description: >-
        <p>Upon success, code 200 is returned.<p>Prerequiste: The following attributes should be specified in the post request:<ul><li>profileName - The name of the script profile<li>profileParams - The key/value pair for the profile</ul><p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "scriptProfile",
                "attributes": {
                    "profileName": "vlanProfile_6.x",
                    "profileParams": [
                        {
                            "key": "VLAN_ID",
                            "value": "915"
                        },
                        {
                            "key": "VLAN_PORT_ID",
                            "value": "5"
                        },
                        {
                            "key": "MAX_FRAME_SIZE",
                            "value": "9216"
                        },
                        {
                            "key": "INTERFACE_NAME",
                            "value": "if2"
                        },
                        {
                            "key": "IP_ADDRESS",
                            "value": "10.9.9.9/24"
                        },
                        {
                            "key": "ORIG_MAX_FRAME_SIZE",
                            "value": "1526"
                        }
                    ]
                }
            }
        }</code></pre>
      operationId: createScriptProfile
      parameters: []
      requestBody:
        description: The new script profile data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ScriptProfile'
              - description: The new script profile data
        required: true
      responses:
        '200':
          description: Script Profile with given input has been created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptProfileList'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: The script profile already exists
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/neUpgradeStatus:
    get:
      tags:
      - Upgrade operation v1
      summary: getNeUpgradeStatus
      description: "Upgrade status returned as a JSON object indicating upgrade status of a Network element. \n <p>Prerequiste: None."
      operationId: getNeUpgradeStatus
      parameters:
      - name: ncid
        in: query
        description: Management session id of an NE.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: operationtype
        in: query
        description: Operation type of job execution on NE.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Upgrade status of a Network Element
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CMOperationStatus'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Retrieval of upgrade status failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/upgradeStatus:
    get:
      tags:
      - Upgrade operation v1
      summary: getUpgradeStatus
      description: "Upgrade status returned as a JSON list of objects for Network elements \n <p>Prerequiste: None."
      operationId: getUpgradeStatus
      parameters: []
      responses:
        '200':
          description: Upgrade status for list of Network Element(s)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CMOperationStatusList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Retrieval of upgrade status failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /configmgmt/api/v1/upgrade/applyFPGA:
    post:
      tags:
      - Upgrade operations v1
      summary: applyFPGA
      description: "Apply FPGA Upgrade on the Circuit Pack. \n <p>Prerequiste: The Circuit Pack Stage should be COLDINVOKE and Upgrade Result should be AVAILABLE.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{\n   \"networkConstructName\": \"OME0979_e03501\",\n   \"aid\": \"SP-1-15\"\n}</code></pre>"
      operationId: applyFPGA
      parameters: []
      requestBody:
        description: Apply FPGA Upgrade
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApplyFPGAAttributes'
              - description: Apply FPGA Upgrade
        required: true
      responses:
        '204':
          description: Apply FPGA Upgrade submitted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/fpgaDetails:
    get:
      tags:
      - Upgrade operations v1
      summary: retrieveFPGADetails
      description: "Get FPGA details for NEs \n<p>Attributes: <ul><li>networkConstructName - The networkConstructs name <li>AID - The AID of card</ul><p>Prerequiste: None."
      operationId: retrieveFPGADetails
      parameters:
      - name: networkConstructName
        in: query
        description: Networkconstruct Name for which FPGA Details to be retrieved.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: AID
        in: query
        description: AID for which FPGA Details to be retrieved.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: FPGA Details fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FPGADetailsResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/fpgaInventory:
    get:
      tags:
      - Upgrade operations v1
      summary: retrieveFPGAInventory
      description: "Get FPGA inventory for NEs \n<p>Attributes: <ul><li>networkConstructName - The networkConstructs name </ul><p>Prerequiste: None."
      operationId: retrieveFPGAInventory
      parameters:
      - name: networkConstructName
        in: query
        description: Networkconstruct Name for which FPGA Inventory to be retrieved.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: FPGA Inventory fetched
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FPGADetailsResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/manualInvoke:
    post:
      tags:
      - Upgrade operations v1
      summary: manualInvoke
      description: "Manual Invoke of cards. \n <p>Specify the NE name and Shelf ID\" +\n<p>Example request:</p>\" +{\n	\"networkConstructName\": \"65TS_0137\",\n	\"slotId\": \"PWR-1-61\"\n}"
      operationId: manualInvoke
      parameters: []
      requestBody:
        description: Manual invoke attributes
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ManualInvokeAttributes'
              - description: Manual invoke attributes
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeStatusResponse'
        '204':
          description: Manual invoke submitted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/resume:
    post:
      tags:
      - Upgrade operations v1
      summary: manualResume
      description: "Manual resume of upgrade. Resume can be applied on one or more Network Elements \n <p>Specify the NE name, type and typeGroup are optional. neDetails can contain one or more network elements<p>Prerequiste: The Network Elements must be in Suspended State<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{  \n   \"data\":{ \n      \"type\":\"resume\",\n      \"attributes\":{  \n         \"neDetails\":[  \n            {  \n               \"neName\":\"NE1\",\n               \"neType\":\"6500\",\n               \"typeGroup\":\"Ciena6500\"\n            },\n            {  \n               \"neName\":\"NE2\",\n               \"neType\":\"6500\",\n               \"typeGroup\":\"Ciena6500\"\n            }\n         ]\n      }\n   }\n}</code></pre>"
      operationId: manualResume
      parameters: []
      requestBody:
        description: Manual resume attributes
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ManualResume'
              - description: Manual resume attributes
        required: true
      responses:
        '204':
          description: Manual resume executed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/rtrvUpgradeStatus:
    get:
      tags:
      - Upgrade operations v1
      summary: retrieveUpgradeStatus
      description: "Upgrade status returned as a JSON list of objects for Network element \n <p>Attributes: <ul><li>networkConstructName - The networkConstructs name </ul><p>Prerequiste: None."
      operationId: retrieveUpgradeStatus
      parameters:
      - name: networkConstructName
        in: query
        description: Networkconstruct Name for which details need to be retrieved.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Upgrade status for list of Network Element(s)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeStatusResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Unable to retrieve upgrade status
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/status:
    get:
      tags:
      - Upgrade operations v1
      summary: retrieveCircuitPacks
      description: "Circuit Packs Upgrade status returned as a JSON list of objects for Network element \n <p>Attributes: <ul><li>networkConstructName - The networkConstructs name </ul><p>Prerequiste: None."
      operationId: retrieveCircuitPacks
      parameters:
      - name: networkConstructName
        in: query
        description: Networkconstruct Name for which details need to be retrieved.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Upgrade status for list of Network Element(s)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeStatusResponse'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Unable to retrieve upgrade status
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/stop:
    post:
      tags:
      - Upgrade operations v1
      summary: stopUpgrade
      description: "Stop NE upgrade. \n <p>Prerequiste: Upgrade should be in progress.\"<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{\n   \"networkConstructNames\":[\"ACMBOCA6500_e05501\",\"OME0979_e03501\",\"OME0979_e06901\"]\n}</code></pre>"
      operationId: stopUpgrade
      parameters: []
      requestBody:
        description: Stop upgrade attributes
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/StopUpgradeAttributes'
              - description: Stop upgrade attributes
        required: true
      responses:
        '204':
          description: Stop upgrade executed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/upgrade/suspend:
    post:
      tags:
      - Upgrade operations v1
      summary: manualSuspend
      description: "Manual suspend of upgrade. Suspend can be applied on one or more Network Elements \n <p>Specify the NE name, type and typeGroup are optional. neDetails can contain one or more network elements<p>Prerequiste: The Network Elements Upgrade must be in progress State<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{  \n   \"data\":{ \n      \"type\":\"suspend\",\n      \"attributes\":{  \n         \"neDetails\":[  \n            {  \n               \"neName\":\"NE1\",\n               \"neType\":\"6500\",\n               \"typeGroup\":\"Ciena6500\"\n            },\n            {  \n               \"neName\":\"NE2\",\n               \"neType\":\"6500\",\n               \"typeGroup\":\"Ciena6500\"\n            }\n         ]\n      }\n   }\n}</code></pre>"
      operationId: manualSuspend
      parameters: []
      requestBody:
        description: Manual suspend attributes
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ManualSuspend'
              - description: Manual suspend attributes
        required: true
      responses:
        '204':
          description: Manual Suspend executed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/transportResource/generateResourceId:
    get:
      tags:
      - transport resources v1
      summary: getTransportResourceByType
      description: Get a next possible id for given resourceType
      operationId: getTransportResourceByType
      parameters:
      - name: types
        in: query
        description: Type of the TransportResource
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: Identifier of the NetworkConstruct
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Generated next id for given resourceType
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransportResourceList'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of transport resources failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /configmgmt/api/v1/vpnResources/generateResourceId:
    get:
      tags:
      - vpn resources v1
      summary: getVpnResourceByType
      description: Get a next possible id for given resourceType
      operationId: getVpnResourceByType
      parameters:
      - name: types
        in: query
        description: Type of the vpnResource
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: Identifier of the NetworkConstuct
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Generated next id for given resourceType
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpnResourceCollection'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of vpn resources failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /discovery/api/neprofiles:
    get:
      tags:
      - neprofiles
      summary: getNEConnectionProfiles
      description: Return all NE Connection Profiles for the type group.
      operationId: getNEConnectionProfiles
      parameters:
      - name: typeGroup
        in: query
        description: (Optional) Device Type Group
        style: form
        explode: true
        schema:
          type: string
      - name: protocol
        in: query
        description: (Optional) Protocol
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieval of NE Connection Profiles complete
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileListV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileListV3RO'
        '204':
          description: No data found.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Response'
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - neprofiles
      summary: createNEConnectionProfile
      description: Create the specified NE Connection Profile. On success, status 201 is returned with the full resource, including the resource identifier.
      operationId: createNEConnectionProfile
      parameters: []
      requestBody:
        description: NE Connection Profile to be created with the specified contents
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NEConnectionProfileV3RO'
              - description: NE Connection Profile to be created with the specified contents
        required: false
      responses:
        '201':
          description: NE Connection Profile is created
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '400':
          description: Unable to process NE Connection Profile content
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /discovery/api/neprofiles/{id}:
    get:
      tags:
      - neprofiles
      summary: getNEConnectionProfile
      description: Return a specific NE Connection Profile.
      operationId: getNEConnectionProfile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the NE Connection Profile to fetch
        required: true
        style: simple
        schema:
          pattern: .+
          type: string
      responses:
        '200':
          description: Retrieval of NE Connection Profile complete
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '400':
          description: Unable to process NE Connection Profile request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No NE Connection Profile found for given Id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - neprofiles
      summary: updateNEConnectionProfile
      description: 'LATEST VERSION: V2. Create or update a specific NE Connection Profile.'
      operationId: updateNEConnectionProfile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the NE Connection Profile to update
        required: true
        style: simple
        schema:
          pattern: .+
          type: string
      requestBody:
        description: NE Connection Profile data as a JSON object.  Existing profile will be replaced by the new contents.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NEConnectionProfileV3RO'
              - description: NE Connection Profile data as a JSON object.  Existing profile will be replaced by the new contents.
        required: false
      responses:
        '200':
          description: NE Connection Profile has been updated
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '201':
          description: NE Connection Profile has been created
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '400':
          description: Unable to process NE Connection Profile content
          headers: {}
          content: {}
        '500':
          description: NE Connection Profile update failed (error message provided)
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - neprofiles
      summary: deleteNEConnectionProfile
      description: Delete a specific NE Connection Profile.
      operationId: deleteNEConnectionProfile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the NE Connection Profile to delete
        required: true
        style: simple
        schema:
          pattern: .+
          type: string
      responses:
        '204':
          description: NE Connection Profile was deleted
          headers: {}
          content: {}
        '400':
          description: Unable to process NE Connection Profile request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /discovery/api/v1/neprofiles:
    get:
      tags:
      - neprofiles v1
      summary: GetgetNEConnectionProfiles
      description: Return all NE Connection Profiles for the type group.
      operationId: GetgetNEConnectionProfiles
      parameters:
      - name: typeGroup
        in: query
        description: (Optional) Device Type Group
        style: form
        explode: true
        schema:
          type: string
      - name: protocol
        in: query
        description: (Optional) Protocol
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieval of NE Connection Profiles complete
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileListV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileListV3RO'
        '204':
          description: No data found.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Response'
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - neprofiles v1
      summary: PostcreateNEConnectionProfile
      description: Create the specified NE Connection Profile. On success, status 201 is returned with the full resource, including the resource identifier.
      operationId: PostcreateNEConnectionProfile
      parameters: []
      requestBody:
        description: NE Connection Profile to be created with the specified contents
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NEConnectionProfileV3RO'
              - description: NE Connection Profile to be created with the specified contents
        required: false
      responses:
        '201':
          description: NE Connection Profile is created
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '400':
          description: Unable to process NE Connection Profile content
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /discovery/api/v1/neprofiles/{id}:
    get:
      tags:
      - neprofiles v1
      summary: GetgetNEConnectionProfile
      description: Return a specific NE Connection Profile.
      operationId: GetgetNEConnectionProfile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the NE Connection Profile to fetch
        required: true
        style: simple
        schema:
          pattern: .+
          type: string
      responses:
        '200':
          description: Retrieval of NE Connection Profile complete
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '400':
          description: Unable to process NE Connection Profile request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No NE Connection Profile found for given Id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - neprofiles v1
      summary: PutupdateNEConnectionProfile
      description: Update a specific NE Connection Profile.
      operationId: PutupdateNEConnectionProfile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the NE Connection Profile to update
        required: true
        style: simple
        schema:
          pattern: .+
          type: string
      requestBody:
        description: NE Connection Profile data as a JSON object.  Existing profile will be replaced by the new contents.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NEConnectionProfileV3RO'
              - description: NE Connection Profile data as a JSON object.  Existing profile will be replaced by the new contents.
        required: false
      responses:
        '200':
          description: NE Connection Profile has been updated
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '400':
          description: Unable to process NE Connection Profile content
          headers: {}
          content: {}
        '404':
          description: No NE Connection Profile found for given Id
          headers: {}
          content: {}
        '500':
          description: NE Connection Profile update failed (error message provided)
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    delete:
      tags:
      - neprofiles v1
      summary: DeletedeleteNEConnectionProfile
      description: Delete a specific NE Connection Profile.
      operationId: DeletedeleteNEConnectionProfile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the NE Connection Profile to delete
        required: true
        style: simple
        schema:
          pattern: .+
          type: string
      responses:
        '204':
          description: NE Connection Profile was deleted
          headers: {}
          content: {}
        '400':
          description: Unable to process NE Connection Profile request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /discovery/api/v2/neprofiles/{id}:
    put:
      tags:
      - neprofiles v2
      summary: PutupdateNEConnectionProfile1
      description: Create or update a specific NE Connection Profile.
      operationId: PutupdateNEConnectionProfile1
      parameters:
      - name: id
        in: path
        description: Unique identifier of the NE Connection Profile to update
        required: true
        style: simple
        schema:
          pattern: .+
          type: string
      requestBody:
        description: NE Connection Profile data as a JSON object.  Existing profile will be replaced by the new contents.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NEConnectionProfileV3RO'
              - description: NE Connection Profile data as a JSON object.  Existing profile will be replaced by the new contents.
        required: false
      responses:
        '200':
          description: NE Connection Profile has been updated
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '201':
          description: NE Connection Profile has been created
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
            application/json:
              schema:
                $ref: '#/components/schemas/NEConnectionProfileV3RO'
        '400':
          description: Unable to process NE Connection Profile content
          headers: {}
          content: {}
        '500':
          description: NE Connection Profile update failed (error message provided)
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /discovery/api/managementSessions:
    get:
      tags:
      - managementSessions
      summary: getNetworkConstructs
      description: 'Retrieves a list of management sessions which represent the connections to the network elements<p>LATEST VERSION: V4'
      operationId: getNetworkConstructs
      parameters:
      - name: states
        in: query
        description: '(Optional) List of comma separated discoveryStates. <p> Valid values are: <table><tr><td>PENDING</td><td> - prior to enrollment</td></tr><tr><td>AUTO_DISCOVERED</td><td> - prior to enrollment and added by the enrollment of another network element</td></tr><tr><td>VALIDATING</td><td> - attempting to communicate with the network element</td></tr><tr><td>VALIDATING_FAILED</td><td> - communication with the network element failed</td></tr><tr><td>CONNECTING</td><td> - creating a session to the network element</td></tr><tr><td>POKING</td><td> - checking available accesses to the network element</td></tr><tr><td>CONNECTED</td><td> - session established with network element</td></tr><tr><td>DISCOVERING</td><td> - retrieving session data from network element</td></tr><tr><td>COMPLETED</td><td> - management session is fully operational and connected to the network element</td></tr><tr><td>DISCOVERY_RETRY</td><td> - failed to retrieve session data from the network element</td></tr><tr><td>CHANGE_SESSION</td><td> - attempting to changing the active session to the network element</td></tr><tr><td>DEENROLLING</td><td> - disconnecting from the network element and removing the management session</td></tr></table>'
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of comma separated name values
        style: form
        explode: true
        schema:
          type: string
      - name: longName
        in: query
        description: (Optional) List of comma separated longName values
        style: form
        explode: true
        schema:
          type: string
      - name: profileName
        in: query
        description: (Optional) List of comma separated profileName values
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of management sessions
        style: form
        explode: true
        schema:
          type: string
      - name: aliasName
        in: query
        description: (Optional) Key that holds the alias name
        style: form
        explode: true
        schema:
          type: string
      - name: aliasValue
        in: query
        description: (Optional) List of alias name values
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: typeGroup
        in: query
        description: (Optional) List of the management session typeGroup
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of the management session resourceType
        style: form
        explode: true
        schema:
          type: string
      - name: shortResourceType
        in: query
        description: (Optional) List of the management session shortResourceType
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of the management session associationState. The valid values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, discoveryState, displayState, typeGroup, profileName, resourcePartitionInfo, shortResourceType'
        style: form
        explode: true
        schema:
          type: string
      - name: displayState
        in: query
        description: '(Optional) List of comma separated display states. The allowed values are: Pending, Connecting, Not connected, Connected, Failed'
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values
        style: form
        explode: true
        schema:
          type: string
      - name: displayPreferredConnectionName
        in: query
        description: (Optional) Name of preferred connection
        style: form
        explode: true
        schema:
          type: string
      - name: displayPartitions
        in: query
        description: (Optional) List of comma separated display partitions
        style: form
        explode: true
        schema:
          type: string
      - name: displayAlternativeConnectionIPs
        in: query
        description: (Optional) List of comma seperated display alternative connection IPs
        style: form
        explode: true
        schema:
          type: string
      - name: displayAlternativeConnectionNames
        in: query
        description: (Optional) List of comma seperated display alternative connection names
        style: form
        explode: true
        schema:
          type: string
      - name: profileId
        in: query
        description: (Optional) List of NE security connection profile identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifier
        in: query
        description: (Optional) List of associationStateQualifiers. The allowed values are MANUAL, NETWORK, SYSTEM
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifierReason
        in: query
        description: (Optional) Reason for putting a Management Session to 'inMaintenance'.
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) List of comma separated resource partitions, 'none' to search unpartitioned resource if user has sufficient privilege
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of management sessions filtered by any provided parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval of management sessions failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    post:
      tags:
      - managementSessions
      summary: postManagementSession
      description: >-
        <p>LATEST VERSION: V3<p>Upon success, code 201 is returned.<p>ProfileId can be obtained from creating a profile through discovery/api/v1/neprofiles.<p>The profile can optionally be specified by name using the profileName attribute.<p>The default discoveryState is PENDING, which is a pre-enrollment state used to prepare and stage the enrollment process.<p>To trigger an immediate enrollment you can provide an initial discoverySate of CONNECTING. This starts the enrollment process as the management session object is created. Optionally you can assign one or multiple partitions to the management session.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                "type": "managementSessions",
                "attributes": {
                    "ipAddress": "1.1.1.1",
                    "additionalIpAddresses": ["1.1.1.2"],
                    "discoveryState": "CONNECTING",
                    "profile": "profileId"
                    "resourcePartitionInfo": ["Partition1"]
                }
            }
        }

        </code></pre>
      operationId: postManagementSession
      parameters: []
      requestBody:
        description: managementSession to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ManagementSessionRO'
              - description: managementSession to create
        required: false
      responses:
        '201':
          description: ManagementSession object is created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /discovery/api/managementSessions/{sessionId}:
    get:
      tags:
      - managementSessions
      summary: getManagementSessionById
      description: '<p>LATEST VERSION: V3'
      operationId: getManagementSessionById
      parameters:
      - name: sessionId
        in: path
        description: The 'id' of management session to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Unable to retrieve  management session by the specified id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - managementSessions
      summary: deleteManagementSession
      description: '<p>LATEST VERSION: V3'
      operationId: deleteManagementSession
      parameters:
      - name: sessionId
        in: path
        description: The 'id' of the management session to be deleted or de-enrolled
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: De-enrollment or deletion request was successful triggered
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '204':
          description: Management session has already been deleted
          headers: {}
          content: {}
        '403':
          description: Deenrollment of auto-discovered management session is not allowed, or insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - managementSessions
      summary: patchOperation
      description: >-
        <p>LATEST VERSION: V4<p>Upon request accepted, code 202 is returned and the output consists of JSON objects representing current management session resource.<p>If NE state is Pending, then the supported operations are: replace (for updating IP address and/or additionalIpAddresses, and/or ne-profile and/or partition), enroll (to enroll NE), and replace + enroll (to update and enroll the NE).<p>If NE state is Connected/Failed, then the supported operations are: replace (to update or re-apply ne-profile, or to update partition), replace + reconnect (to replace IP address and/or additionalIpAddresses and reconnect), reconnect, and resync (to resynchronize the NE).<p>"reconnect" operation force reconnect NE at enrollment IP address.<p>A MCP user can force reconnect an enrolled GNE or RNE. When a GNE is force reconnected, its associated RNE is reconnected automatically. A pre-enrlled or auto discovered GNE is not able to be force reconnected.<p>If NE state is Auto_discovered, the supported operations are replace and replace + enroll.<p>Example request to change enrollment IP:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "ipAddress" : "10.1.1.1",
                        "additionalIpAddresses": ["1.1.1.2"], (optional)
                        "profile" : "300-200-100" (optional)
                    }
                },
                {
                    "op" : "reconnect"
                }
            ]
        }

        </code></pre><p>Example request to change ne-profile:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "profile" : "300-200-100"
                    }
                }
            ]
        }

        </code></pre><p>Example request to change partition:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "resourcePartitionInfo" : "Partition2"
                    }
                }
            ]
        }

        </code></pre><p>Example request to resync:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "resync"
                }
            ]
        }

        </code></pre><p>Example request to put NE in Maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "inMaintenance"
                }
            ]
        }

        </code></pre><p>Example request to put NE out of Maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "outMaintenance"
                }
            ]
        }

        </code></pre><p>Example request to enroll a pre-enrolled NE:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "enroll"
                }
            ]
        }

        </code></pre><p>Example request to reconnect a NE:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "reconnect"
                }
            ]
        }

        </code></pre><p>Example request to provide a reason when putting an NE under maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "inMaintenance"
                    "reason" : "example_reason"
                }
            ]
        }

        </code></pre><p>Example request to provide a reason when putting an NE under maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "inMaintenance"
                    "attributes" : {
                        "associationStateQualifierReason" : "example_reason"
                    }
                }
            ]
        }

        </code></pre>
      operationId: patchOperation
      parameters:
      - name: sessionId
        in: path
        description: The id of management session to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given management session.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ManagementSessionPatchRO'
              - description: A patch request to the given management session.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /discovery/api/v3/managementSessions:
    get:
      tags:
      - managementSessions v3
      summary: getManagementSessions
      description: Retrieves a list of management sessions which represent the connections to the network elements
      operationId: getManagementSessions
      parameters:
      - name: states
        in: query
        description: '(Optional) List of comma separated discoveryStates. <p> Valid values are: <table><tr><td>PENDING</td><td> - prior to enrollment</td></tr><tr><td>AUTO_DISCOVERED</td><td> - prior to enrollment and added by the enrollment of another network element</td></tr><tr><td>VALIDATING</td><td> - attempting to communicate with the network element</td></tr><tr><td>VALIDATING_FAILED</td><td> - communication with the network element failed</td></tr><tr><td>CONNECTING</td><td> - creating a session to the network element</td></tr><tr><td>POKING</td><td> - checking available accesses to the network element</td></tr><tr><td>CONNECTED</td><td> - session established with network element</td></tr><tr><td>DISCOVERING</td><td> - retrieving session data from network element</td></tr><tr><td>COMPLETED</td><td> - management session is fully operational and connected to the network element</td></tr><tr><td>DISCOVERY_RETRY</td><td> - failed to retrieve session data from the network element</td></tr><tr><td>CHANGE_SESSION</td><td> - attempting to changing the active session to the network element</td></tr><tr><td>DEENROLLING</td><td> - disconnecting from the network element and removing the management session</td></tr></table>'
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of comma separated name values
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of management sessions
        style: form
        explode: true
        schema:
          type: string
      - name: aliasName
        in: query
        description: (Optional) Key that holds the alias name
        style: form
        explode: true
        schema:
          type: string
      - name: aliasValue
        in: query
        description: (Optional) List of alias name values
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of management sessions filtered by any provided parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval of management sessions failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - managementSessions v3
      summary: PostpostManagementSession
      description: >-
        Upon success, code 201 is returned.<p>ProfileId can be obtained from creating a profile through discovery/api/v1/neprofiles.<p>The profile can optionally be specified by name using the profileName attribute.<p>The default discoveryState is PENDING, which is a pre-enrollment state used to prepare and stage the enrollment process.<p>To trigger an immediate enrollment you can provide an initial discoverySate of CONNECTING. This starts the enrollment process as the management session object is created. Optionally you can assign one or multiple partitions to the management session.<p>Example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                "type": "managementSessions",
                "attributes": {
                    "ipAddress": "1.1.1.1",
                    "discoveryState": "CONNECTING",
                    "profile": "profileId",
                    "resourcePartitionInfo": ["Partition1"]
                }
            }
        }

        </code></pre>
      operationId: PostpostManagementSession
      parameters: []
      requestBody:
        description: managementSession to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ManagementSessionRO'
              - description: managementSession to create
        required: false
      responses:
        '201':
          description: Successfully created the management session object
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /discovery/api/v3/managementSessions/{sessionId}:
    get:
      tags:
      - managementSessions v3
      summary: getManagementSessionBySessionId
      description: Retrieves a management session by its corresponding id
      operationId: getManagementSessionBySessionId
      parameters:
      - name: sessionId
        in: path
        description: The 'id' of management session to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Unable to retrieve management session by the specified id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - managementSessions v3
      summary: DeletedeleteManagementSession
      description: Triggers the de-enrollment of a network element or deletes a pending enrollment
      operationId: DeletedeleteManagementSession
      parameters:
      - name: sessionId
        in: path
        description: identifier of Management Session to be deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: De-enrollment or deletion request was successful triggered
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '204':
          description: Management session has already been deleted
          headers: {}
          content: {}
        '403':
          description: Deenrollment of auto-discovered management session is not allowed, or insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /discovery/api/v3/managementSessions/{sessionId}/discoveryState:
    put:
      tags:
      - managementSessions v3
      summary: putEnroll
      description: Trigger the enrollment or resynchronization of a management session
      operationId: putEnroll
      parameters:
      - name: sessionId
        in: path
        description: The id of management session to be retrieved
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: 'A string value of the discoveryState.  Valid values are:<table><tr><td>CONNECTING</td><td> - this will trigger the enrollment process, if the management has not been enrolled yet</td></tr><tr><td>DISCOVERING</td><td> - triggers the resynchronization/discovery of the management session</td></tr></table>Note: Surround values with quotes within parameter body'
        content:
          application/json:
            schema:
              type: string
              description: 'A string value of the discoveryState.  Valid values are:<table><tr><td>CONNECTING</td><td> - this will trigger the enrollment process, if the management has not been enrolled yet</td></tr><tr><td>DISCOVERING</td><td> - triggers the resynchronization/discovery of the management session</td></tr></table>Note: Surround values with quotes within parameter body'
        required: false
      responses:
        '202':
          description: Request has been successfully accepted and triggered.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /discovery/api/v3/managementSessions/{sessionId}/ipAddress:
    put:
      tags:
      - managementSessions v3
      summary: putEnrollIP
      description: Update the IP address of the pending management session
      operationId: putEnrollIP
      parameters:
      - name: sessionId
        in: path
        description: The id of management session to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A string value of the IpAddress
        content:
          application/json:
            schema:
              type: string
              description: A string value of the IpAddress
        required: false
      responses:
        '202':
          description: Request has been successfully accepted and triggered.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /discovery/api/v3/managementSessions/{sessionId}/neProfile:
    put:
      tags:
      - managementSessions v3
      summary: putEnrollNeProfile
      description: Update the NE connection profile id of the pending management session
      operationId: putEnrollNeProfile
      parameters:
      - name: sessionId
        in: path
        description: The id of management session to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A string value of the NeProfile
        content:
          application/json:
            schema:
              type: string
              description: A string value of the NeProfile
        required: false
      responses:
        '202':
          description: Request has been successfully accepted and triggered.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Resource Not Found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '422':
          description: No request body was provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /discovery/api/v4/managementSessions:
    get:
      tags:
      - managementSessions v4
      summary: GetgetManagementSessions
      description: Retrieves a list of management sessions which represent the connections to the network elements
      operationId: GetgetManagementSessions
      parameters:
      - name: states
        in: query
        description: "(Optional) List of comma separated discoveryStates. <p> Valid values are: <table><tr><td>PENDING</td><td> - prior to enrollment</td></tr><tr><td>AUTO_DISCOVERED</td><td> - prior to enrollment and added by the enrollment of another network element</td></tr><tr><td>VALIDATING</td><td> - attempting to communicate with the network element</td></tr><tr><td>VALIDATING_FAILED</td><td> - communication with the network element failed</td></tr><tr><td>CONNECTING</td><td> - creating a session to the network element</td></tr><tr><td>POKING</td><td> - checking available accesses to the network element</td></tr><tr><td>CONNECTED</td><td> - session established with network element</td></tr><tr><td>DISCOVERING</td><td> - retrieving session data from network element</td></tr><tr><td>COMPLETED</td><td> - management session is fully operational and connected to the network element</td></tr><tr><td>DISCOVERY_RETRY</td><td> - failed to retrieve session data from the network element</td></tr><tr><td>CHANGE_SESSION</td><td> - attempting to changing the active session to the network element</td></tr><tr><td>DEENROLLING</td><td> - disconnecting from the network element and removing the management session</td></tr><tr><td>POKING</td><td> - obtaining information from NE's other connection addresses for reachability</td></tr></table>"
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of comma separated name values
        style: form
        explode: true
        schema:
          type: string
      - name: longName
        in: query
        description: (Optional) List of comma separated longName values
        style: form
        explode: true
        schema:
          type: string
      - name: profileName
        in: query
        description: (Optional) List of comma separated profileName values
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of management sessions
        style: form
        explode: true
        schema:
          type: string
      - name: aliasName
        in: query
        description: (Optional) Key that holds the alias name
        style: form
        explode: true
        schema:
          type: string
      - name: aliasValue
        in: query
        description: (Optional) List of alias name values
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: typeGroup
        in: query
        description: (Optional) List of the management session typeGroup
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of the management session resourceType
        style: form
        explode: true
        schema:
          type: string
      - name: shortResourceType
        in: query
        description: (Optional) List of the management session shortResourceType
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of the management session associationState. The valid values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, discoveryState, displayState, typeGroup, profileName, resourcePartitionInfo, shortResourceType'
        style: form
        explode: true
        schema:
          type: string
      - name: displayState
        in: query
        description: '(Optional) List of comma separated display states. The allowed values are: Pending, Connecting, Not connected, Connected, Failed'
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values
        style: form
        explode: true
        schema:
          type: string
      - name: displayPreferredConnectionName
        in: query
        description: (Optional) Name of preferred connection
        style: form
        explode: true
        schema:
          type: string
      - name: displayPartitions
        in: query
        description: (Optional) List of comma separated display partitions
        style: form
        explode: true
        schema:
          type: string
      - name: displayAlternativeConnectionIPs
        in: query
        description: (Optional) List of comma seperated display alternative connection IPs
        style: form
        explode: true
        schema:
          type: string
      - name: displayAlternativeConnectionNames
        in: query
        description: (Optional) List of comma seperated display alternative connection names
        style: form
        explode: true
        schema:
          type: string
      - name: profileId
        in: query
        description: (Optional) List of NE security connection profile identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifier
        in: query
        description: (Optional) List of associationStateQualifiers. The allowed values are MANUAL, NETWORK, SYSTEM
        style: form
        explode: true
        schema:
          type: string
      - name: associationStateQualifierReason
        in: query
        description: (Optional) Reason for putting a Management Session to 'inMaintenance'.
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) List of comma separated resource partitions, 'none' to search unpartitioned resource if user has sufficient privilege
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of management sessions filtered by any provided parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementSessionListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval of management sessions failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /discovery/api/v4/managementSessions/{sessionId}:
    patch:
      tags:
      - managementSessions v4
      summary: PatchpatchOperation
      description: >-
        <p>Upon request accepted, code 202 is returned and the output consists of JSON objects representing current management session resource.<p>If NE state is Pending, then the supported operations are: replace (for updating IP address and/or ne-profile and/or partition), enroll (to enroll NE), and replace + enroll (to update and enroll the NE).<p>If NE state is Connected/Failed, then the supported operations are: replace (to update or re-apply ne-profile, or to update partition), replace + reconnect (to replace IP address and reconnect), reconnect, and resync (to resynchronize the NE).<p>"reconnect" operation force reconnect NE at enrollment IP address.<p>A MCP user can force reconnect an enrolled GNE or RNE. When a GNE is force reconnected, its associated RNE is reconnected automatically. A pre-enrolled or auto discovered GNE is not able to be force reconnected.<p>If NE state is Auto_discovered, the supported operations are replace and replace + enroll.<p>Example request to change enrollment IP:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "ipAddress" : "10.1.1.1",
                        "profile" : "300-200-100" (optional)
                    }
                },
                {
                    "op" : "reconnect"
                }
            ]
        }

        </code></pre><p>Example request to change ne-profile:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "profile" : "300-200-100"
                    }
                }
            ]
        }

        </code></pre><p>Example request to change partition:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "resourcePartitionInfo" : "Partition2"
                    }
                }
            ]
        }

        </code></pre><p>Example request to resync:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "resync"
                }
            ]
        }

        </code></pre><p>Example request to put NE in Maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "inMaintenance"
                }
            ]
        }

        </code></pre><p>Example request to put NE out of Maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "outMaintenance"
                }
            ]
        }

        </code></pre><p>Example request to enroll a pre-enrolled NE:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "enroll"
                }
            ]
        }

        </code></pre><p>Example request to reconnect a NE:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "reconnect"
                }
            ]
        }

        </code></pre><p>Example request to provide a reason when putting an NE under maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "inMaintenance"
                    "reason" : "example_reason"
                }
            ]
        }

        </code></pre><p>Example request to provide a reason when putting an NE under maintenance:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "inMaintenance"
                    "attributes" : {
                        "associationStateQualifierReason" : "example_reason"
                    }
                }
            ]
        }

        </code></pre>
      operationId: PatchpatchOperation
      parameters:
      - name: sessionId
        in: path
        description: The id of management session to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given management session.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ManagementSessionPatchRO'
              - description: A patch request to the given management session.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ManagementSessionRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs:
    get:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: GetgetNetworkConstructs
      description: "<p>LATEST VERSION: V6\nDiscovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: When querying using identifiers, the supported syntax is as follows: \n   ?identifierKey=key1,key2,...&identifierValue=value1,value2,... \nFor instance, \n   ?identifierKey=subnetName&identifierValue=PV0438A---PV0428D---SUBNET<p>Only one of the following parameters can be specified:<ul><li>name<li>ipAddress<li>identifierKey + identifierValue<li>sessionId<li>networkConstructExpectations.equipmentIntent.id<li>networkConstructExpectations.serviceIntent.id<li>physicalLocationId<li>networkConstructType<li>concrete</ul>"
      operationId: GetgetNetworkConstructs
      parameters:
      - name: name
        in: query
        description: (Optional) List of device name values
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: The identifier key list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: The identifier value list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sessionId
        in: query
        description: (Optional) Management Session Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: '(Optional) Network Construct type. The allowed values are: networkElement, shelf, osrpNode, manual, branchingUnit, submarineRepeater, foreignNode'
        style: form
        explode: true
        schema:
          type: string
      - name: ssteType
        in: query
        description: '(Optional)  ssteType parameter used to filter spectrum sharing terminal network element. The allowed values are: SSTE'
        style: form
        explode: true
        schema:
          type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned, srlgs, utilization, timing'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: postNetworkConstruct
      description: >-
        Upon success, code 201 is returned and the output consists of JSON objects representing the Network Construct.<p>All the attributes other than identifiers, userData, resourcePartitionInfo, notes and networkConstructType will be ignored.</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "networkConstructs",
                "attributes": {
                    "identifiers": [
                        {
                            "siteName": "clli1",
                            "projectName": "projectName1"
                        },
                        {
                            "projectName": "projectName1"
                        }
                    ],
                    "userData": {
                        "latitudeLongitudeString": "-52.455143603762195,115.42581387725983"
                    },
                    "networkConstructType": "manual",
                    "resourcePartitionInfo": [
                        "partitiionUUID"
                    ],
                    "note": {
                             "noteMsg": "This is an manual NC note",
                             "lastUpdatedBy": "user1"
                     }
                }
            }
        }</code></pre><p>LATEST VERSION: V5<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postNetworkConstruct
      parameters: []
      requestBody:
        description: Request to create an NC provided with userData, physical location and resourcePartitionInfo
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructRO'
              - description: Request to create an NC provided with userData, physical location and resourcePartitionInfo
        required: false
      responses:
        '200':
          description: Network construct user data has been replaced on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '201':
          description: Network construct has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}:
    get:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: getNetworkConstruct
      description: '<p>LATEST VERSION: V4<p>Network Construct returned as a JSON SingleManagedElement object'
      operationId: getNetworkConstruct
      parameters:
      - name: id
        in: path
        description: identifier of Network Construct to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, childNetworkConstructs, networkConstructDiscovered, networkConstructPlanned, srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '403':
          description: Forbidden to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: deleteNCById
      description: '<p>LATEST VERSION: V3'
      operationId: deleteNCById
      parameters:
      - name: id
        in: path
        description: Identifier of Network Construct to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '204':
          description: Deleted NC successfully.
          headers: {}
          content: {}
        '400':
          description: The specified NC either has enrolled or has expectations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to delete specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete NC.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: PatchpatchOperation1
      description: >-
        <p>LATEST VERSION: V3<p>Upon request accepted, code 202 is returned and the output consists of JSON objects representing current network construct resource. The "replace" operation is used to replace the entire attribute with the new value provided. The deprecated "update" operation will update or add to the existing attribute. The "delete" operation will delete the entire attribute, or delete specific keys if a list is provided. The "add" operation will add values or update key-value pairs  to the existing attribute.<p>Example requests:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "userData" : {
                           "userDataKey" : "userDataValue"
                       }
                    }
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "add",
                    "attributes" : {
                       "userData" : {
                           "userDataKey" : "userDataValue"
                       }
                    }
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "userData"
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "userData",
                    "keys" : [ "key1", "key2" ]
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations": [
                {
                    "op": "replace",
                    "attributes": {
                        "resourcePartitionInfo": [
                            "partitionUUID"
                        ],
                        "tags": [
                            "tagName"
                        ]
                    }
                }
            ]
        }</code></pre><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "note": {
                  "noteMsg": "",
                  "lastUpdatedBy": "admin",
                  "lastUpdatedTime": "2021-06-15T14:03:37"
                }
              }
            }
          ]
        }</code></pre><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "tags": [
                  "tag2"
                ],
                "note": {
                  "noteMsg": "This is an updated message on an NC",
                  "lastUpdatedBy": "userName"
                }
              }
            }
          ]
        }</code></pre>
      operationId: PatchpatchOperation1
      parameters:
      - name: id
        in: path
        description: The id of the network construct to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given network construct.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructPatchRO'
              - description: A patch request to the given network construct.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/expectations:
    post:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: postNCExpectations
      description: "<p>LATEST VERSION: V3<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"id\":\"4312c715-32cc-4d63-8e26-9b79db379e4b::NC_EXP\",\n  \"type\":\"networkConstructExpectations\",\n  \"relationships\": {\n    \"equipmentIntent\": {\n      \"data\": { \n        \"type\": \"equipmentIntents\", \n        \"id\": \"4312c715-32cc-4d63-8e26-9b79db379e4b::EQP_INT\" \n      }\n    }\n  }\n}</code></pre> +<p>Network construct expectations support an auto-delete on de-enroll policy. To apply the policy, add it to the network construct expectation attributes. See example below:</p><pre style='font-size: smaller'><code class='json'>{\n  ...\n  \"attributes\": {\n    \"policies\": [\n      {\n        \"type\": \"lifecycle\",\n        \"policy\": \"autoDeleteOnDeEnroll\"\n      }\n    ]\n  }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: postNCExpectations
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request to create an NC expectation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructExpectationDataRO'
              - description: Request to create an NC expectation
        required: false
      responses:
        '201':
          description: Network construct expectations have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: The specified NC or expectation cannot be accessed by the user because partition conflicts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/expectations/{expId}:
    put:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: putNCExpectations
      description: "<p>LATEST VERSION: V4<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"id\":\"4312c715-32cc-4d63-8e26-9b79db379e4b::NC_EXP\",\n  \"type\":\"networkConstructExpectations\",\n  \"relationships\": {\n    \"equipmentIntent\": {\n      \"data\": { \n        \"type\": \"equipmentIntents\", \n        \"id\": \"4312c715-32cc-4d63-8e26-9b79db379e4b::EQP_INT\" \n      }\n    }\n  }\n}</code></pre> +<p>Network construct expectations support an auto-delete on de-enroll policy. To apply the policy, add it to the network construct expectation attributes. See example below:</p><pre style='font-size: smaller'><code class='json'>{\n  ...\n  \"attributes\": {\n    \"policies\": [\n      {\n        \"type\": \"lifecycle\",\n        \"policy\": \"autoDeleteOnDeEnroll\"\n      }\n    ]\n  }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: putNCExpectations
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      - name: expId
        in: path
        description: Identifier of the Network Construct expectation to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request to create an NC expectation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructExpectationDataRO'
              - description: Request to create an NC expectation
        required: false
      responses:
        '201':
          description: Network construct expectation has been created or updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: The specified NC or expectation cannot be accessed by the user because partition conflicts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/expectations/{expectationId}:
    patch:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: patchExpectation
      description: >-
        <p>LATEST VERSION: V3<p>Example requests:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "ipCommunicationDetails": {
                            "ipv4Infrastructure": {
                                "dhcpRelayAgent": {
                                    "enable" : true,
                                    "serverIp": "19.117.63.126"
                                },
                                "dhcpclient": true,
                                "stackEnabled": true,
                                "gateway": {
                                    "overRide": true,
                                    "access": "accessString",
                                    "config": "configString"
                                },
                                "ospfRouter": {
                                    "routerId": "19.117.63.126",
                                    "areaBorderRouter": "RFC2328",
                                    "areaSystemBorderRouter": "OFF",
                                    "area": "19.117.63.126"
                                }
                            },
                            "ipv6Infrastructure": {
                                "dhcpRelayAgent": {
                                    "enable" : true,
                                    "serverIp": "19.117.63.126"
                                },
                                "dhcpclient": true,
                                "stackEnabled": true,
                                "gateway": {
                                    "overRide": true,
                                    "access": "accessString",
                                    "config": "configString"
                                },
                                "ospfRouter": {
                                    "routerId": "19.117.63.126",
                                    "areaBorderRouter": "RFC2328",
                                    "area": "19.117.63.126"
                                }
                            },
                            "iisisInfrastructure": {
                                "l1priority": 15,
                                "l2priority": 17,
                                "routerLevel": "19.117.63.126",
                                "routerlevelsummarisition": "routerlevelsummarisition"
                            },
                            "interfaceDetails": [
                                {
                                    "name": "name",
                                    "ipv4": {
                                        "ip": "19.117.63.126",
                                        "prefix": "19",
                                        "defaultGateway" : "19.117.63.126",
                                        "subnetMask": "19.117.63.126",
                                        "dhcpRelayAgent": true,
                                        "ospfcircuit": [
                                            {
                                                "networkArea": "19.117.63.126",
                                                "cost": 200,
                                                "carrier": "carrier",
                                                "identifier" : "ID"
                                            }
                                        ]
                                    },
                                    "ipv6" : [
                                        {
                                            "ip": "19.117.63.126",
                                            "defaultGateway": "19.117.63.126",
                                            "prefix": "19.117.63.126",
                                            "ospfcircuit": [
                                                {
                                                    "networkArea": "19.117.63.126",
                                                    "cost": 300,
                                                    "carrier": "carrierv6",
                                                    "identifier": "identifier"
                                                }
                                            ]
                                        }
                                    ],
                                    "iisis": {
                                        "circuit": true
                                    }
                                }
                            ]
                        }
                    }
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "ipCommunicationDetails"
                }
            ]
        }

        </code></pre>

        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "srlg": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        }

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchExpectation
      parameters:
      - name: id
        in: path
        description: The id of the network construct to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: The id of the expectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given network construct.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructPatchRO'
              - description: A patch request to the given network construct.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/expectations/{networkConstructExpectationId}:
    get:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: getNCExpectationById
      description: '<p>LATEST VERSION: V3'
      operationId: getNCExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which an expectation is to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation to retrieve
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved NC Expectation successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructExpectationRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified NC Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: deleteNCExpectationById
      description: '<p>LATEST VERSION: V3'
      operationId: deleteNCExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose expectation is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted NC Expectation successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid value specified for Attribute {attribute_name} value {attribute_value}
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete NC Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/expectations/{networkConstructExpectationId}/realize:
    post:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: realizeNetworkConstruct
      description: Realize an NC Expectation given the ncId and expectationId
      operationId: realizeNetworkConstruct
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which the expectation is to be realized
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Realized NC Expectation successfully.
          headers: {}
          content: {}
        '204':
          description: Expectation was not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified NC Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/expectations/{networkConstructExpectationId}/{attributeName}:
    put:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: updateNCExpectationAttributeValue
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updateNCExpectationAttributeValue
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose expectation attribute is to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation whose attribute is to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: attributeName
        in: path
        description: Name of attribute to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired new value
        content:
          text/plain:
            schema:
              type: string
              description: The desired new value
        required: false
      responses:
        '200':
          description: Network construct expectation has been update on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: The specified NC or expectation cannot be accessed by the user because partition conflicts
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/identifiers:
    put:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: updateNCIdentifier
      description: '<p>LATEST VERSION: V4<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updateNCIdentifier
      parameters:
      - name: id
        in: path
        description: The NC id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The NC identifier JSON object
        content:
          application/json:
            schema:
              type: object
              description: The NC identifier JSON object
        required: true
      responses:
        '200':
          description: Successfully updated the NC identifier for a given NC
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '201':
          description: Successfully created a new NC identifier for the given NC
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: deleteNCIdentifier
      description: '<p>LATEST VERSION: V4'
      operationId: deleteNCIdentifier
      parameters:
      - name: id
        in: path
        description: The NC id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Successfully deleted the NC identifier
          headers: {}
          content: {}
        '400':
          description: Bad parameters were passed, please check the identifier object for errors
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC does not exist or their was error processing information
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/identifiers/{identifierKey}:
    put:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: updateNCIdentifiersByKey
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updateNCIdentifiersByKey
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which to create or update the identifier
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: identifier
        content:
          application/json:
            schema:
              type: object
              description: identifier
        required: false
      responses:
        '200':
          description: Network construct userData identifier have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: deleteNCIdentifiers
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: deleteNCIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose identifier is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '204':
          description: Deleted network construct userData - identifier successfully.
          headers: {}
          content: {}
        '404':
          description: The specified network construct or userData - identifier does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete network construct userData - identifier.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/networkConstructPlanned:
    get:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: getNetworkConstructPlan
      description: Network Construct planned returned as a JSON SingleManagedElement object
      operationId: getNetworkConstructPlan
      parameters:
      - name: id
        in: path
        description: identifier of Network Construct to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructPlannedRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve specified Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: patchPlannedNC
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current network construct resource. The "replace" operation is used to replace the L2 Node Role and Routing capabilities <p>Example requests:</p> <pre style='font-size: smaller'><code class='json'> {
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "L2Data" : [{
                           "shelf" : -1.0,
                           "eqptGrp" : -1.0,
                           "l2NodeRole" : AN,
                           "l2NodeRoutingCapabilities" : {
                           "properties" : {
                               "isBGPEnabled" : true,
                               "isMPLSEnabled" : true,
                               "isQiQEnabled" : true,
                               "isRSVPTEEnabled" : false,
                           }
                           }
                       }]
                    }
                    "relationships" : {
                            "manualSRLG : { }
                    }
                }
            ]
        }

        </code></pre>


        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre>
      operationId: patchPlannedNC
      parameters:
      - name: id
        in: path
        description: The id of the network construct to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given network construct.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructPatchRO'
              - description: A patch request to the given network construct.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/networkConstructs/{id}/physicalLocation/{physicalLocationId}:
    put:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: updateNCPhysicalLocation
      description: '<p>LATEST VERSION: V4<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updateNCPhysicalLocation
      parameters:
      - name: id
        in: path
        description: Identifier of Network Construct under which to create or update the physical location
        required: true
        style: simple
        schema:
          type: string
      - name: physicalLocationId
        in: path
        description: Id of physical location to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired physical location value
        content:
          text/plain:
            schema:
              type: string
              description: The desired physical location value
        required: false
      responses:
        '200':
          description: Network construct physical location have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to update specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    delete:
      tags:
      - 000 - nsiapinetworkConstructs
      summary: deletePhysicalLocationFromNC
      description: '<p>LATEST VERSION: V4'
      operationId: deletePhysicalLocationFromNC
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose physical location is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: physicalLocationId
        in: path
        description: physicalLocationId
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted network construct physical location successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to update specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified network construct or physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v6/networkConstructs:
    get:
      tags:
      - 994 - nsiapiv6networkConstructs
      summary: getNetworkConstructsV6
      description: "Discovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: When querying using identifiers, the supported syntax is as follows: \n   ?identifierKey=key1,key2,...&identifierValue=value1,value2,... \nFor instance, \n   ?identifierKey=subnetName&identifierValue=PV0438A---PV0428D---SUBNET<p>Only one of the following parameters can be specified:<ul><li>name<li>ipAddress<li>identifierKey + identifierValue<li>sessionId<li>networkConstructExpectations.equipmentIntent.id<li>networkConstructExpectations.serviceIntent.id<li>physicalLocationId<li>networkConstructType<li>concrete</ul>"
      operationId: getNetworkConstructsV6
      parameters:
      - name: name
        in: query
        description: (Optional) List of device name values
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: The identifier key list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: The identifier value list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sessionId
        in: query
        description: (Optional) Management Session Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: '(Optional) Network Construct type. The allowed values are: networkElement, shelf, osrpNode, manual, branchingUnit, submarineRepeater, foreignNode'
        style: form
        explode: true
        schema:
          type: string
      - name: ssteType
        in: query
        description: '(Optional)  ssteType parameter used to filter spectrum sharing terminal network element. The allowed values are: SSTE'
        style: form
        explode: true
        schema:
          type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned, utilization, timing'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v5/networkConstructs:
    get:
      tags:
      - 995 - nsiapiv5networkConstructs
      summary: getNetworkConstructsV5
      description: "Discovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: When querying using identifiers, the supported syntax is as follows: \n   ?identifierKey=key1,key2,...&identifierValue=value1,value2,... \nFor instance, \n   ?identifierKey=subnetName&identifierValue=PV0438A---PV0428D---SUBNET<p>Only one of the following parameters can be specified:<ul><li>name<li>ipAddress<li>identifierKey + identifierValue<li>sessionId<li>networkConstructExpectations.equipmentIntent.id<li>networkConstructExpectations.serviceIntent.id<li>physicalLocationId<li>networkConstructType<li>concrete</ul>"
      operationId: getNetworkConstructsV5
      parameters:
      - name: name
        in: query
        description: (Optional) List of device name values
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: The identifier key list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: The identifier value list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sessionId
        in: query
        description: (Optional) Management Session Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: '(Optional) Network Construct type. The allowed values are: networkElement, shelf, osrpNode, manual, branchingUnit, submarineRepeater'
        style: form
        explode: true
        schema:
          type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned, srlgs'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    post:
      tags:
      - 995 - nsiapiv5networkConstructs
      summary: PostpostNetworkConstruct
      description: >-
        Upon success, code 201 is returned and the output consists of JSON objects representing the Network Construct.<p>All the attributes other than identifiers, userData, resourcePartitionInfo, notes and networkConstructType will be ignored.</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
            "data": {
                "type": "networkConstructs",
                "attributes": {
                    "identifiers": [
                        {
                            "siteName": "clli1",
                            "projectName": "projectName1"
                        },
                        {
                            "projectName": "projectName1"
                        }
                    ],
                    "userData": {
                        "latitudeLongitudeString": "-52.455143603762195,115.42581387725983"
                    },
                    "networkConstructType": "manual",
                    "resourcePartitionInfo": [
                        "partitiionUUID"
                    ],
                    "note": {
                             "noteMsg": "This is an manual NC note",
                             "lastUpdatedBy": "user1"
                     }
                }
            }
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostNetworkConstruct
      parameters: []
      requestBody:
        description: Request to create an NC provided with userData, physical location and resourcePartitionInfo
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructRO'
              - description: Request to create an NC provided with userData, physical location and resourcePartitionInfo
        required: false
      responses:
        '200':
          description: Network construct user data has been replaced on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '201':
          description: Network construct has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v5/networkConstructs/{id}/expectations/{networkConstructExpectationId}/realize:
    post:
      tags:
      - 995 - nsiapiv5networkConstructs
      summary: PostrealizeNetworkConstruct
      description: Realize an NC Expectation given the ncId and expectationId
      operationId: PostrealizeNetworkConstruct
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which the expectation is to be realized
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Realized NC Expectation successfully.
          headers: {}
          content: {}
        '204':
          description: Expectation was not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified NC Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/networkConstructs:
    get:
      tags:
      - 996 - nsiapiv4networkConstructs
      summary: GetgetNetworkConstructs1
      description: "Discovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: When querying using identifiers, the supported syntax is as follows: \n   ?identifierKey=key1,key2,...&identifierValue=value1,value2,... \nFor instance, \n   ?identifierKey=subnetName&identifierValue=PV0438A---PV0428D---SUBNET"
      operationId: GetgetNetworkConstructs1
      parameters:
      - name: id
        in: query
        description: (Optional) List of networkConstruct Ids
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name)
        style: form
        explode: true
        schema:
          type: string
      - name: resourceState
        in: query
        description: '(Optional) List of networkConstruct planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: sessionId
        in: query
        description: (Optional) List of Management Session Ids
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: (Optional) List of device name values
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: (Optional) List of device displayName values
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: The identifier key list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: The identifier value list
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: '(Optional) List of Network Construct types. The allowed values are: networkElement, shelf, osrpNode'
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) List of networkConstruct resourceTypes
        style: form
        explode: true
        schema:
          type: string
      - name: associationState
        in: query
        description: '(Optional) List of networkConstruct associationStates. The allowed values are: GOA, LOA'
        style: form
        explode: true
        schema:
          type: string
      - name: syncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. The allowed values are: notSynchronized, synchronizing, synchronized, failed, aborted, deleting, deleteFailed'
        style: form
        explode: true
        schema:
          type: string
      - name: softwareVersion
        in: query
        description: (Optional) List of networkConstruct software versions
        style: form
        explode: true
        schema:
          type: string
      - name: displaySyncState
        in: query
        description: '(Optional) List of networkConstruct syncStates. The allowed values are: planned, notSynchronized, synchronizing, synchronized, failed, pending, deleting'
        style: form
        explode: true
        schema:
          type: string
      - name: subnetName
        in: query
        description: (Optional) The subnet name list
        style: form
        explode: true
        schema:
          type: string
      - name: macAddress
        in: query
        description: (Optional) macAddress parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: typeGroup
        in: query
        description: (Optional) List of networkConstruct typeGroups
        style: form
        explode: true
        schema:
          type: string
      - name: slteType
        in: query
        description: '(Optional)  slteType parameter used to filter results. The allowed values are: SLTE'
        style: form
        explode: true
        schema:
          type: string
      - name: ssteType
        in: query
        description: '(Optional)  ssteType parameter used to filter spectrum sharing terminal network element. The allowed values are: SSTE'
        style: form
        explode: true
        schema:
          type: string
      - name: resourcePartitionInfo
        in: query
        description: (Optional) List of resourcePartitionInfo
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on NC tags. This parameter accepts a list of comma separated strings
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: resourceType, associationState, syncState, networkConstructType, resourceState, softwareVersion, displaySyncState, tags'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v4/networkConstructs/{id}:
    get:
      tags:
      - 996 - nsiapiv4networkConstructs
      summary: GetgetNetworkConstruct
      description: Network Construct returned as a JSON SingleManagedElement object
      operationId: GetgetNetworkConstruct
      parameters:
      - name: id
        in: path
        description: identifier of Network Construct to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) Response filter
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, childNetworkConstructs, networkConstructDiscovered, networkConstructPlanned, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v4/networkConstructs/{id}/expectations/{expId}:
    put:
      tags:
      - 996 - nsiapiv4networkConstructs
      summary: PutputNCExpectations
      description: "<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"id\":\"4312c715-32cc-4d63-8e26-9b79db379e4b::NC_EXP\",\n  \"type\":\"networkConstructExpectations\",\n  \"relationships\": {\n    \"equipmentIntent\": {\n      \"data\": { \n        \"type\": \"equipmentIntents\", \n        \"id\": \"4312c715-32cc-4d63-8e26-9b79db379e4b::EQP_INT\" \n      }\n    }\n  }\n}</code></pre><p>Network construct expectations support an auto-delete on de-enroll policy. To apply the policy, add it to the network construct expectation attributes. See example below:</p><pre style='font-size: smaller'><code class='json'>{\n  ...\n  \"attributes\": {\n    \"policies\": [\n      {\n        \"type\": \"lifecycle\",\n        \"policy\": \"autoDeleteOnDeEnroll\"\n      }\n    ]\n  }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: PutputNCExpectations
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      - name: expId
        in: path
        description: Identifier of the Network Construct expectation to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request to create an NC expectation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructExpectationDataRO'
              - description: Request to create an NC expectation
        required: false
      responses:
        '201':
          description: Network construct expectation has been created or updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/networkConstructs/{id}/identifiers:
    put:
      tags:
      - 996 - nsiapiv4networkConstructs
      summary: PutupdateNCIdentifier
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutupdateNCIdentifier
      parameters:
      - name: id
        in: path
        description: The NC id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The NC identifier JSON object
        content:
          application/json:
            schema:
              type: object
              description: The NC identifier JSON object
        required: true
      responses:
        '200':
          description: Successfully updated the NC identifier for a given NC
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '201':
          description: Successfully created a new NC identifier for the given NC
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 996 - nsiapiv4networkConstructs
      summary: DeletedeleteNCIdentifier
      description: Deletes a REST identifier on a Network Construct
      operationId: DeletedeleteNCIdentifier
      parameters:
      - name: id
        in: path
        description: The NC id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Unsuccessfully deleted the NC identifier
          headers: {}
          content: {}
        '204':
          description: Successfully deleted the NC identifier
          headers: {}
          content: {}
        '400':
          description: Bad parameters were passed, please check the identifier object for errors
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC does not exist or their was error processing information
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/networkConstructs/{id}/physicalLocation/{physicalLocationId}:
    put:
      tags:
      - 996 - nsiapiv4networkConstructs
      summary: PutupdateNCPhysicalLocation
      description: Updates an NC physical location
      operationId: PutupdateNCPhysicalLocation
      parameters:
      - name: id
        in: path
        description: Identifier of Network Construct under which to create or update the physical location
        required: true
        style: simple
        schema:
          type: string
      - name: physicalLocationId
        in: path
        description: Id of physical location to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired physical location value
        content:
          text/plain:
            schema:
              type: string
              description: The desired physical location value
        required: false
      responses:
        '200':
          description: Network construct physical location have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to update specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    delete:
      tags:
      - 996 - nsiapiv4networkConstructs
      summary: DeletedeletePhysicalLocationFromNC
      description: Delete a physical location from a  given network construct
      operationId: DeletedeletePhysicalLocationFromNC
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose physical location is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: physicalLocationId
        in: path
        description: physicalLocationId
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted network construct physical location successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to update specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified network construct or physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/networkConstructs:
    get:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: GetgetNetworkConstructs2
      description: "Discovered Network Constructs returned as a JSON list of Network Construct objects. \nNote: When querying using identifiers, the supported syntax is as follows: \n   ?identifiers[field1+field2+...]=value1+value2+... \nFor instance, \n   ?identifiers[clli+projectId]=ABC123+XYZ "
      operationId: GetgetNetworkConstructs2
      parameters:
      - name: name
        in: query
        description: (Optional) List of device name values
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: (Optional) Ip Address of Network Construct
        style: form
        explode: true
        schema:
          type: string
      - name: aliasName
        in: query
        description: (Optional) Key that holds the subNet name
        style: form
        explode: true
        schema:
          type: string
      - name: aliasValue
        in: query
        description: (Optional) List of subNet name values
        style: form
        explode: true
        schema:
          type: string
      - name: sessionId
        in: query
        description: (Optional) Management Session Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/include1'
          - description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned'
      - name: physicalLocationId
        in: query
        description: (Optional) Physical location id
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstructType
        in: query
        description: (Optional) Network Construct type
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/networkConstructType31'
          - description: (Optional) Network Construct type
      - name: concrete
        in: query
        description: (Optional) Id of the concrete networkConstruct
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name). If provided, must also provide searchText parameter
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      responses:
        '200':
          description: List of Network Constructs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Unable to retrieve all network elements
          headers: {}
          content: {}
        '500':
          description: Retrieval of network constructs failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/networkConstructs/{id}:
    get:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: GetgetNetworkConstruct1
      description: Network Construct returned as a JSON SingleManagedElement object
      operationId: GetgetNetworkConstruct1
      parameters:
      - name: id
        in: path
        description: identifier of Network Construct to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) Response filter
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, childNetworkConstructs, networkConstructDiscovered, networkConstructPlanned, srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    delete:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: DeletedeleteNCById
      description: Deletes a specific network construct
      operationId: DeletedeleteNCById
      parameters:
      - name: id
        in: path
        description: Identifier of Network Construct to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '204':
          description: Deleted NC successfully.
          headers: {}
          content: {}
        '400':
          description: The specified NC either has enrolled or has expectations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to delete specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete NC.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: PatchpatchOperation2
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current network construct resource. The "replace" operation is used to replace the entire attribute with the new value provided. The deprecated "update" operation will update or add to the existing attribute. The "delete" operation will delete the entire attribute, or delete specific keys if a list is provided. The "add" operation will add values or update key-value pairs  to the existing attribute.<p>Example requests:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "userData" : {
                           "userDataKey" : "userDataValue"
                       }
                    }
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "add",
                    "attributes" : {
                       "userData" : {
                           "userDataKey" : "userDataValue"
                       }
                    }
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "userData"
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "userData",
                    "keys" : [ "key1", "key2" ]
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations": [
                {
                    "op": "replace",
                    "attributes": {
                        "resourcePartitionInfo": [
                            "partitionUUID"
                        ],
                        "tags": [
                            "tagName"
                        ]
                    }
                }
            ]
        }</code></pre><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "note": {
                  "noteMsg": "",
                  "lastUpdatedBy": "admin",
                  "lastUpdatedTime": "2021-06-15T14:03:37"
                }
              }
            }
          ]
        }</code></pre><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "tags": [
                  "tag2"
                ],
                "note": {
                  "noteMsg": "This is an updated message on an NC",
                  "lastUpdatedBy": "userName"
                }
              }
            }
          ]
        }</code></pre>
      operationId: PatchpatchOperation2
      parameters:
      - name: id
        in: path
        description: The id of the network construct to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given network construct.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructPatchRO'
              - description: A patch request to the given network construct.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/networkConstructs/{id}/expectations:
    post:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: PostpostNCExpectations
      description: "<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"id\":\"4312c715-32cc-4d63-8e26-9b79db379e4b::NC_EXP\",\n  \"type\":\"networkConstructExpectations\",\n  \"relationships\": {\n    \"equipmentIntent\": {\n      \"data\": { \n        \"type\": \"equipmentIntents\", \n        \"id\": \"4312c715-32cc-4d63-8e26-9b79db379e4b::EQP_INT\" \n      }\n    }\n  }\n}</code></pre><p>Network construct expectations support an auto-delete on de-enroll policy. To apply the policy, add it to the network construct expectation attributes. See example below:</p><pre style='font-size: smaller'><code class='json'>{\n  ...\n  \"attributes\": {\n    \"policies\": [\n      {\n        \"type\": \"lifecycle\",\n        \"policy\": \"autoDeleteOnDeEnroll\"\n      }\n    ]\n  }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: PostpostNCExpectations
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request to create an NC expectation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructExpectationDataRO'
              - description: Request to create an NC expectation
        required: false
      responses:
        '201':
          description: Network construct expectations have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified NC
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/networkConstructs/{id}/expectations/{expectationId}:
    patch:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: PatchpatchExpectation
      description: >-
        <p>Example requests:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                        "ipCommunicationDetails": {
                            "ipv4Infrastructure": {
                                "dhcpRelayAgent": {
                                    "enable" : true,
                                    "serverIp": "19.117.63.126"
                                },
                                "dhcpclient": true,
                                "stackEnabled": true,
                                "gateway": {
                                    "overRide": true,
                                    "access": "accessString",
                                    "config": "configString"
                                },
                                "ospfRouter": {
                                    "routerId": "19.117.63.126",
                                    "areaBorderRouter": "RFC2328",
                                    "areaSystemBorderRouter": "OFF",
                                    "area": "19.117.63.126"
                                }
                            },
                            "ipv6Infrastructure": {
                                "dhcpRelayAgent": {
                                    "enable" : true,
                                    "serverIp": "19.117.63.126"
                                },
                                "dhcpclient": true,
                                "stackEnabled": true,
                                "gateway": {
                                    "overRide": true,
                                    "access": "accessString",
                                    "config": "configString"
                                },
                                "ospfRouter": {
                                    "routerId": "19.117.63.126",
                                    "areaBorderRouter": "RFC2328",
                                    "area": "19.117.63.126"
                                }
                            },
                            "iisisInfrastructure": {
                                "l1priority": 15,
                                "l2priority": 17,
                                "routerLevel": "19.117.63.126",
                                "routerlevelsummarisition": "routerlevelsummarisition"
                            },
                            "interfaceDetails": [
                                {
                                    "name": "name",
                                    "ipv4": {
                                        "ip": "19.117.63.126",
                                        "defaultGateway" : "19.117.63.126",
                                        "subnetMask": "19.117.63.126",
                                        "dhcpRelayAgent": true,
                                        "ospfcircuit": [
                                            {
                                                "networkArea": "19.117.63.126",
                                                "cost": 200,
                                                "carrier": "carrier",
                                                "identifier" : "ID"
                                            }
                                        ]
                                    },
                                    "ipv6" : [
                                        {
                                            "ip": "19.117.63.126",
                                            "defaultGateway": "19.117.63.126",
                                            "prefix": "19.117.63.126",
                                            "ospfcircuit": [
                                                {
                                                    "networkArea": "19.117.63.126",
                                                    "cost": 300,
                                                    "carrier": "carrierv6",
                                                    "identifier": "identifier"
                                                }
                                            ]
                                        }
                                    ],
                                    "iisis": {
                                        "circuit": true
                                    }
                                }
                            ]
                        }
                    }
                }
            ]
        }

        </code></pre><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "path" : "attributes/ipcommunicationDetails/interfaceDetails/ipv4/prefix",
                    "identifier" : "loopback",
                }
            ]
        }

        </code></pre>

        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "srlg": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        }

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre>
      operationId: PatchpatchExpectation
      parameters:
      - name: id
        in: path
        description: The id of the network construct to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: The id of the expectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given network construct.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructPatchRO'
              - description: A patch request to the given network construct.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/networkConstructs/{id}/expectations/{networkConstructExpectationId}:
    get:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: GetgetNCExpectationById
      description: Retrieve an NC Expectation given the nc id and expectation id
      operationId: GetgetNCExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which an expectation is to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation to retrieve
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved NC Expectation successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructExpectationRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified NC Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: DeletedeleteNCExpectationById
      description: Delete an NC Expectation given the nc id and expectation id
      operationId: DeletedeleteNCExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose expectation is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted NC Expectation successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid value specified for Attribute {attribute_name} value {attribute_value}
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified network construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete NC Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/networkConstructs/{id}/expectations/{networkConstructExpectationId}/{attributeName}:
    put:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: PutupdateNCExpectationAttributeValue
      description: Update to an existing NC Expectation
      operationId: PutupdateNCExpectationAttributeValue
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose expectation attribute is to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: networkConstructExpectationId
        in: path
        description: Identifier of the expectation whose attribute is to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: attributeName
        in: path
        description: 'Name of attribute to update, allowable values: name, ipAddress and shelfType'
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired new value
        content:
          text/plain:
            schema:
              type: string
              description: The desired new value
        required: false
      responses:
        '200':
          description: Network construct expectation has been update on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified NC
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified NC or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/networkConstructs/{id}/identifiers/{identifierKey}:
    put:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: updateNCIdentifiers
      description: Creates or updates an NC UserData Identifier to a given network construct
      operationId: updateNCIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct under which to create or update the identifier
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: identifier
        content:
          application/json:
            schema:
              type: object
              description: identifier
        required: false
      responses:
        '200':
          description: Network construct userData identifier have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: DeletedeleteNCIdentifiers
      description: Delete an userData Identifier from a  given network construct
      operationId: DeletedeleteNCIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the Network Construct whose identifier is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted network construct userData - identifier successfully.
          headers: {}
          content: {}
        '404':
          description: The specified network construct or userData - identifier does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete network construct userData - identifier.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/networkConstructs/{id}/networkConstructPlanned:
    get:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: GetgetNetworkConstructPlan
      description: Network Construct planned returned as a JSON SingleManagedElement object
      operationId: GetgetNetworkConstructPlan
      parameters:
      - name: id
        in: path
        description: identifier of Network Construct to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructPlannedRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to retrieve specified Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve specified Managed Network Construct
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 997 - nsiapiv3networkConstructs
      summary: PatchpatchPlannedNC
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current network construct resource. The "replace" operation is used to replace the L2 Node Role and Routing capabilities <p>Example requests:</p> <pre style='font-size: smaller'><code class='json'> {
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "L2Data" : [{
                           "shelf" : -1.0,
                           "eqptGrp" : -1.0,
                           "l2NodeRole" : AN,
                           "l2NodeRoutingCapabilities" : {
                           "properties" : {
                               "isBGPEnabled" : true,
                               "isMPLSEnabled" : true,
                               "isQiQEnabled" : true,
                               "isRSVPTEEnabled" : false,
                           }
                           }
                       }]
                    }
                    "relationships" : {
                            "physicalLocation : {                        "data" : {
                                 "type" : physicalLocation,
                                 "id" : pl1
                                 }
                               }
                    }
                }
            ]
        }

        </code></pre>

        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre>
      operationId: PatchpatchPlannedNC
      parameters:
      - name: id
        in: path
        description: The id of the network construct to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given network construct.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/NetworkConstructPatchRO'
              - description: A patch request to the given network construct.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConstructRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Insufficient permission
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified network construct does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/physicalLocations:
    get:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: getPhysicalLocations
      description: '<p>LATEST VERSION: V4<p>Discovered locations returned as a JSON list of physical location objects'
      operationId: getPhysicalLocations
      parameters:
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: List of physical locations
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationListRO'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve physical location
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of physical location failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: postPhysicalLocation
      description: >-
        <p>LATEST VERSION: V3<p>Upon success, code 201 is returned and the output consists of JSON objects representing the physical location.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "1",
            "type": "physicalLocation"
          }
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postPhysicalLocation
      parameters: []
      requestBody:
        description: Request to create an physical location.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PhysicalLocationRO'
              - description: Request to create an physical location.
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '201':
          description: Physical location has been created on the server
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/physicalLocations/{id}:
    get:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: getPhysicalLocationById
      description: '<p>LATEST VERSION: V3<p>Discovered location returned as a JSON format of physical location object'
      operationId: getPhysicalLocationById
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Retrieved physical location successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified physical location
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/physicalLocations/{id}/expectations:
    post:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: postPhysicalLocationExpectations
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: postPhysicalLocationExpectations
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Physical location expectation to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PhysicalLocationExpectationDataRO'
              - description: Physical location expectation to create
        required: false
      responses:
        '201':
          description: Physical location expectations have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/physicalLocations/{id}/expectations/{expectationId}:
    get:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: getPhysicalLocationExpectationById
      description: '<p>LATEST VERSION: V3'
      operationId: getPhysicalLocationExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location under which an expectation is to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: Identifier of the expectation to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Retrieved physical locations expectation successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationExpectationRO'
        '404':
          description: The specified physical locations or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified physical locations Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: deletePhysicalLocationExpectationById
      description: '<p>LATEST VERSION: V3'
      operationId: deletePhysicalLocationExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location whose expectation is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: Identifier of the expectation to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted physical location expectation successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid value specified for Attribute {attribute_name} value {attribute_value}
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/physicalLocations/{id}/identifiers/{identifierKey}:
    put:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: updatePhysicalLocationIdentifiers
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updatePhysicalLocationIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location under which to create or update the identifier
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: identifier
        content:
          application/json:
            schema:
              type: object
              description: identifier
        required: false
      responses:
        '200':
          description: Physical location userData identifier have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: deletePhysicalLocationIdentifiers
      description: '<p>LATEST VERSION: V3'
      operationId: deletePhysicalLocationIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location whose identifier is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted physical location identifier successfully.
          headers: {}
          content: {}
        '404':
          description: The specified physical location or identifier does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location identifier.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/physicalLocations/{id}/userData/{userDataKey}:
    put:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: PutupdateUserData
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutupdateUserData
      parameters:
      - name: id
        in: path
        description: Identifier of physical location under which to create or update the UserData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: false
      responses:
        '200':
          description: Physical location userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: deletePhysicalLocationUserData
      description: '<p>LATEST VERSION: V3'
      operationId: deletePhysicalLocationUserData
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location whose UserData is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted physical location userData successfully.
          headers: {}
          content: {}
        '404':
          description: The specified physical location or userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location userData - identifier.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/physicalLocations/{physicalLocationId}:
    delete:
      tags:
      - 000 - nsiapiphysicalLocations
      summary: deletePhysicalLocationById
      description: '<p>LATEST VERSION: V3'
      operationId: deletePhysicalLocationById
      parameters:
      - name: physicalLocationId
        in: path
        description: Identifier of the physical location to delete
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Deleted physical location successfully.
          headers: {}
          content: {}
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '409':
          description: The physical location is related to networkConstruct/networkConstructExpectation, cannot delete.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location (error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/physicalLocations:
    get:
      tags:
      - 996 - nsiapiv4physicalLocations
      summary: GetgetPhysicalLocations
      description: Discovered locations returned as a JSON list of physical location objects
      operationId: GetgetPhysicalLocations
      parameters:
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: List of physical locations
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationListRO'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unable to retrieve physical location
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of physical location failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/physicalLocations:
    get:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: GetgetPhysicalLocations1
      description: Discovered locations returned as a JSON list of physical location objects
      operationId: GetgetPhysicalLocations1
      parameters:
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: List of physical locations
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationListRO'
        '400':
          description: Bad request
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve physical location
          headers: {}
          content: {}
        '500':
          description: Retrieval of physical location failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: PostpostPhysicalLocation
      description: >-
        Upon success, code 201 is returned and the output consists of JSON objects representing the physical location.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "1",
            "type": "physicalLocation"
          }
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostPhysicalLocation
      parameters: []
      requestBody:
        description: Request to create an physical location.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PhysicalLocationRO'
              - description: Request to create an physical location.
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '201':
          description: Physical location has been created on the server
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/physicalLocations/{id}:
    get:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: GetgetPhysicalLocationById
      description: Retrieve a physical location with given id
      operationId: GetgetPhysicalLocationById
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Retrieved physical location successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified physical location
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/physicalLocations/{id}/expectations:
    post:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: PostpostPhysicalLocationExpectations
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PostpostPhysicalLocationExpectations
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Physical location expectation to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PhysicalLocationExpectationDataRO'
              - description: Physical location expectation to create
        required: false
      responses:
        '201':
          description: Physical location expectations have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/physicalLocations/{id}/expectations/{expectationId}:
    get:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: GetgetPhysicalLocationExpectationById
      description: Retrieve an physical locations Expectation given the physical locations id and expectation id
      operationId: GetgetPhysicalLocationExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location under which an expectation is to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: Identifier of the expectation to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Retrieved physical locations expectation successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationExpectationRO'
        '404':
          description: The specified physical locations or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the specified physical locations Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: DeletedeletePhysicalLocationExpectationById
      description: Delete an physical location expectation given the physical location id and expectation id
      operationId: DeletedeletePhysicalLocationExpectationById
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location whose expectation is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: Identifier of the expectation to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted physical location expectation successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid value specified for Attribute {attribute_name} value {attribute_value}
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location or expectation does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/physicalLocations/{id}/identifiers/{identifierKey}:
    put:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: PutupdatePhysicalLocationIdentifiers
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutupdatePhysicalLocationIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location under which to create or update the identifier
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: identifier
        content:
          application/json:
            schema:
              type: object
              description: identifier
        required: false
      responses:
        '200':
          description: Physical location userData identifier have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: DeletedeletePhysicalLocationIdentifiers
      description: Delete an Identifier from a given physical location
      operationId: DeletedeletePhysicalLocationIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location whose identifier is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted physical location identifier successfully.
          headers: {}
          content: {}
        '404':
          description: The specified physical location or identifier does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location identifier.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/physicalLocations/{id}/userData/{userDataKey}:
    put:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: PutupdateUserData1
      description: Creates or updates an UserData to a given physical location
      operationId: PutupdateUserData1
      parameters:
      - name: id
        in: path
        description: Identifier of physical location under which to create or update the UserData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: false
      responses:
        '200':
          description: Physical location userData have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: DeletedeletePhysicalLocationUserData
      description: Delete a userData from a given physical location
      operationId: DeletedeletePhysicalLocationUserData
      parameters:
      - name: id
        in: path
        description: Identifier of the physical location whose UserData is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted physical location userData successfully.
          headers: {}
          content: {}
        '404':
          description: The specified physical location or userData does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location userData - identifier.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/physicalLocations/{physicalLocationId}:
    delete:
      tags:
      - 997 - nsiapiv3physicalLocations
      summary: DeletedeletePhysicalLocationById
      description: Delete a physical location with given id.
      operationId: DeletedeletePhysicalLocationById
      parameters:
      - name: physicalLocationId
        in: path
        description: Identifier of the physical location to delete
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Deleted physical location successfully.
          headers: {}
          content: {}
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '409':
          description: The physical location is related to networkConstruct/networkConstructExpectation, cannot delete.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location (error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/physicalLocations:
    get:
      tags:
      - 998 - nsiapiv2_0physicalLocations
      summary: GetgetPhysicalLocations2
      description: Discovered locations returned as a JSON list of physical location objects
      operationId: GetgetPhysicalLocations2
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: List of physical locations
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationListRO'
        '400':
          description: Bad request
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve physical location
          headers: {}
          content: {}
        '500':
          description: Retrieval of physical location failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    post:
      tags:
      - 998 - nsiapiv2_0physicalLocations
      summary: PostpostPhysicalLocation1
      description: >-
        Upon success, code 201 is returned and the output consists of JSON objects representing the physical location.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "1",
            "type": "physicalLocation"
          }
        }</code></pre>
      operationId: PostpostPhysicalLocation1
      parameters: []
      requestBody:
        description: Request to create an physical location.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PhysicalLocationRO'
              - description: Request to create an physical location.
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLocationRO'
        '201':
          description: Physical location has been created on the server
          headers: {}
          content: {}
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/physicalLocations/{physicalLocationId}:
    delete:
      tags:
      - 998 - nsiapiv2_0physicalLocations
      summary: DeletedeletePhysicalLocationById1
      description: Deletes a specific physical location
      operationId: DeletedeletePhysicalLocationById1
      parameters:
      - name: physicalLocationId
        in: path
        description: Identifier of the physical location to delete
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Deleted physical location successfully.
          headers: {}
          content: {}
        '404':
          description: The specified physical location does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '409':
          description: The physical location is related to networkConstruct/networkConstructExpectation, cannot delete.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete physical location (error message provided).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /timing/api/v1/timingNode/{ncId}:
    get:
      tags:
      - TimingNodeV1
      summary: getTimingNode
      description: Get all timing node data
      operationId: getTimingNode
      parameters:
      - name: ncId
        in: path
        description: The NC ID
        required: true
        style: simple
        schema:
          type: string
      - name: withLinks
        in: query
        description: True to include TimingLinks
        style: form
        explode: true
        schema:
          type: string
          default: 'true'
      - name: noCache
        in: query
        description: True to not use the cache
        style: form
        explode: true
        schema:
          type: string
          default: 'false'
      - name: preemptiveSync
        in: query
        description: Instruction to execute as background tasks pre-emptive sync of adjacent timing nodes based on port types IN, OUT or ALL (default no execution)
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/preemptiveSync1'
          - description: Instruction to execute as background tasks pre-emptive sync of adjacent timing nodes based on port types IN, OUT or ALL (default no execution)
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The TimingNode object
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TimingNodeRo'
            application/json:
              schema:
                $ref: '#/components/schemas/TimingNodeRo'
        '400':
          description: The request has invalid parameters
          headers: {}
          content: {}
        '404':
          description: The server did not find the matching resource.
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content: {}
      deprecated: false
  /era/api/v1/cards:
    get:
      tags:
      - Cards
      summary: getCards
      description: Get the cards for the current snapshot compared to a baseline
      operationId: getCards
      parameters:
      - name: currentId
        in: query
        description: currentId
        required: true
        style: form
        explode: true
        schema:
          type: string
          format: uuid
      - name: baselineId
        in: query
        description: baselineId
        style: form
        explode: true
        schema:
          type: string
          format: uuid
      - name: reportType
        in: query
        description: reportType
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned the cards
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CardsRO'
            application/json:
              schema:
                $ref: '#/components/schemas/CardsRO'
        '400':
          description: The required queryParam 'currentId' was not specified
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No snapshot with the currentId or baselineId provided
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the report
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/reports:
    get:
      tags:
      - Reporting
      summary: getDeltaReport
      description: Get a delta report by report id and baseline snapshot id
      operationId: getDeltaReport
      parameters:
      - name: report
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: baseline
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned a delta report
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReportRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ReportRO'
        '404':
          description: No report found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the report
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/reports/{reportId}:
    get:
      tags:
      - Reporting
      summary: GetgetReport
      description: Get a report by reportId
      operationId: GetgetReport
      parameters:
      - name: reportId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned a report
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReportRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ReportRO'
        '404':
          description: No report found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the report
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/sectionReport/{snapshotId}:
    get:
      tags:
      - Reporting
      summary: getSectionReport
      description: Get a section report by snapshotId in the legacy format
      operationId: getSectionReport
      parameters:
      - name: snapshotId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned a report
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SectionReportResponseRO'
            application/json:
              schema:
                $ref: '#/components/schemas/SectionReportResponseRO'
        '404':
          description: No report found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the report
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/sftp/connectivityConfig:
    post:
      tags:
      - SFTP
      - sftp
      summary: updateConfiguration
      description: Configure SFTP connectivity
      operationId: updateConfiguration
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceEnvelopeSFTPConfigurationRequest'
        required: true
      responses:
        '200':
          description: Configuration updated
          headers: {}
          content: {}
        '400':
          description: Invalid configuration
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/schedules:
    get:
      tags:
      - Scheduling
      summary: GetgetSchedules
      description: Get all current schedules
      operationId: GetgetSchedules
      parameters: []
      responses:
        '200':
          description: Successfully got all schedules
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ScheduleRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleRO'
        '500':
          description: The server encountered an error while getting the schedules
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Scheduling
      summary: PostcreateSchedule
      description: Create an extending report schedule
      operationId: PostcreateSchedule
      parameters: []
      requestBody:
        description: Schedule request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ResourceEnvelopeScheduleRO'
              - description: Schedule request
        required: true
      responses:
        '200':
          description: Successfully created schedule
          headers: {}
          content: {}
        '400':
          description: Cannot create schedule as requested
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while creating the schedule
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/schedules/{id}:
    get:
      tags:
      - Scheduling
      summary: getSchedule
      description: Get a schedule by id
      operationId: getSchedule
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned schedule
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ScheduleRO'
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleRO'
        '404':
          description: No schedule found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the schedule
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - Scheduling
      summary: editSchedule
      description: Update a schedule to match the schedule provided. If a schedule is not included only enabled will be updated.
      operationId: editSchedule
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Schedule request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ResourceEnvelopeScheduleRO'
              - description: Schedule request
        required: false
      responses:
        '200':
          description: Return updated schedule
          headers: {}
          content: {}
        '304':
          description: Enabled status not changed
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '400':
          description: Cannot update schedule to match requested schedule
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Schedule not found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while updating the schedule
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Scheduling
      summary: deleteSchedule
      description: Delete a schedule
      operationId: deleteSchedule
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Schedule successfully deleted
          headers: {}
          content: {}
        '400':
          description: UUID not acceptable
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Schedule not found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while deleting the schedule
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/snapshots:
    get:
      tags:
      - Snapshots
      summary: getSnapshots
      description: Get a list of all snapshots
      operationId: getSnapshots
      parameters:
      - name: state
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successfully returned a list of snapshots
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
        '400':
          description: An invalid snapshot state was provided
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the list of snapshots
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Snapshots
      summary: createCapture
      description: Create a snapshot
      operationId: createCapture
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceEnvelopeSnapshotRO'
        required: true
      responses:
        '200':
          description: Successfully create a snapshot
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
        '400':
          description: Invalid snapshot mode
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '406':
          description: Cannot create a scheduled capture
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Capture collection already in progress
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while creating the snapshot
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/snapshots/{snapshotId}:
    get:
      tags:
      - Snapshots
      summary: getSnapshot
      description: Get a snapshot by snapshotId
      operationId: getSnapshot
      parameters:
      - name: snapshotId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned a snapshot
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
        '404':
          description: No snapshot found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the snapshot
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Snapshots
      summary: uploadCapture
      description: Upload the capture file for an upload snapshot
      operationId: uploadCapture
      parameters:
      - name: snapshotId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  format: binary
        required: false
      responses:
        '200':
          description: Successfully uploaded a capture file
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotRO'
        '400':
          description: Capture file form data missing
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Capture file already uploaded for the given snapshotId or the maximum number of capture files has been reached
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No snapshot found with given id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while uploading the capture file
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Snapshots
      summary: deleteSnapshot
      description: Delete a snapshot by snapshotId
      operationId: deleteSnapshot
      parameters:
      - name: snapshotId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted the snapshot
          headers: {}
          content: {}
        '400':
          description: Snapshot is not in a state that allows for it to be deleted
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while deleting the snapshot
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/snapshots/{snapshotId}/download:
    get:
      tags:
      - Snapshots
      summary: downloadCapture
      description: Download the capture file by snapshotId
      operationId: downloadCapture
      parameters:
      - name: snapshotId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned the capture file
          headers: {}
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/File'
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        '404':
          description: No capture file found with given snapshotId
          headers: {}
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
            application/vnd.api+json:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        '500':
          description: The server encountered an error while downloading the capture file
          headers: {}
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
            application/vnd.api+json:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /era/api/v1/snapshots/{snapshotId}/file:
    delete:
      tags:
      - Snapshots
      summary: deleteCaptureFile
      description: Delete a capture file by snapshotId
      operationId: deleteCaptureFile
      parameters:
      - name: snapshotId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '204':
          description: Successfully deleted the capture file
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while deleting the capture file
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v1/trends/{reportName}:
    get:
      tags:
      - Trends
      summary: GetgetReport1
      description: Get the trend group corresponding to the specified report name, source, and OMS
      operationId: GetgetReport1
      parameters:
      - name: reportName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned a trend group
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TrendGroupRO'
            application/json:
              schema:
                $ref: '#/components/schemas/TrendGroupRO'
        '400':
          description: Missing required query parameter(s) identifying trend group
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unknown trend report name
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the trend group
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /era/api/v2/trends/{reportName}:
    get:
      tags:
      - Trends
      summary: GetgetReport2
      description: Get the trend group corresponding to the specified report name, source, and OMS
      operationId: GetgetReport2
      parameters:
      - name: reportName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: ENTITYNAME
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned a trend group
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TrendGroupRO'
            application/json:
              schema:
                $ref: '#/components/schemas/TrendGroupRO'
        '400':
          description: Missing required query parameter(s) identifying trend group
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Unknown trend report name
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while getting the trend group
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /otdr/api/v1/entities:
    get:
      tags:
      - OTDR entities
      summary: GetOTDRentities
      description: >
        Use this API to fetch OTDR supporting entities.


        Prerequisite: management session id.
      operationId: GetOTDRentities
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved OTDR entities.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTDRentities'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OTDRentities'
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: Retrieval of OTDR Entities failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    post:
      tags:
      - OTDR entities
      summary: Start/StoptraceonOTDRentities
      description: >
        Use this API to start/stop trace on OTDR entities.


        Prerequisite: management session id.
      operationId: Start/StoptraceonOTDRentities
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Start/Stop trace parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1EntitiesRequest'
              - description: Start/Stop trace parameters
        required: true
      responses:
        '200':
          description: Start/Stop trace successfully initiated.
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
        '404':
          description: Not found request. Invalid parameters could not find session_id parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: Start/Stop trace failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    patch:
      tags:
      - OTDR entities
      summary: EditanOTDRentity
      description: >
        Use this API to edit an underlying OTDR entity.


        Prerequisite: management session id and entity id.
      operationId: EditanOTDRentity
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: trace_id
        in: query
        description: OTDR entity id
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: OTDR entity parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1EntitiesRequest1'
              - description: OTDR entity parameters
        required: true
      responses:
        '200':
          description: Edit successful on OTDR entity.
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
        '404':
          description: Not found request. Invalid parameters could not find session_id parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: OTDR Entity edit failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
  /otdr/api/v1/tracelist:
    get:
      tags:
      - OTDR SOR tracelist
      summary: GetSORtracelist
      description: >
        Use this API to fetch SOR tracelist associated with an OTDR entity.


        Prerequisite: management session id and entity id.
      operationId: GetSORtracelist
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: trace_id
        in: query
        description: OTDR entity id
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved SOR tracelist.
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: Retrieval of OTDR SOR tracelist failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
  /otdr/api/v1/spanlength:
    get:
      tags:
      - OTDR spanlength
      summary: GetOTDRSpanlength
      description: >
        Use this API to fetch the length of the span associated with an OTDR entity.


        Prerequisite: management session id and entity id.
      operationId: GetOTDRSpanlength
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: trace_id
        in: query
        description: OTDR entity id
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved OTDR spanlength.
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: Retrieval of OTDR spanlength failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
  /otdr/api/v1/sordownload:
    post:
      tags:
      - OTDR SOR download v1
      summary: SFTPsorfile
      description: >
        Use this API to sftp a SOR file.


        Prerequisite: management session id.
      operationId: SFTPsorfile
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: profile_name
        in: query
        description: Profile name of SOR download profile
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: SOR download parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1SordownloadRequest'
              - description: SOR download parameters
        required: true
      responses:
        '200':
          description: SOR file successfully downloaded.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '404':
          description: Not found request. Invalid parameter, could not find session_id parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: SFTP of SOR file failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
  /otdr/api/v2/sordownload:
    post:
      tags:
      - OTDR SOR download v2
      summary: PostSFTPsorfile
      description: >
        Use this API to sftp a SOR file.


        Prerequisite: management session id.
      operationId: PostSFTPsorfile
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: profile_name
        in: query
        description: Profile name of SOR download profile
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: SOR download parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV2SordownloadRequest'
              - description: SOR download parameters
        required: true
      responses:
        '200':
          description: SOR file successfully downloaded.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: SFTP of SOR file failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
  /otdr/api/v1/profile:
    get:
      tags:
      - SOR download profiles
      summary: GetSORdownloadprofiles
      description: >
        Use this API to retrieve SOR download profiles.
      operationId: GetSORdownloadprofiles
      parameters: []
      responses:
        '200':
          description: Successfully retrieved SOR download profiles.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SORdownloadprofiles'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/SORdownloadprofiles'
        '500':
          description: Retrieval of SOR download profiles failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    post:
      tags:
      - SOR download profiles
      summary: CreatesaSORdownloadprofile
      description: >
        Use this API to create an SOR download profile.
      operationId: CreatesaSORdownloadprofile
      parameters: []
      requestBody:
        description: SOR download profile parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1ProfileRequest'
              - description: SOR download profile parameters
        required: true
      responses:
        '200':
          description: SOR download profile created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '500':
          description: SOR download profile creation failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    patch:
      tags:
      - SOR download profiles
      summary: EditaSORdownloadprofile
      description: >
        Use this API to edit an existing SOR download profile.


        Prerequisite: profile id.
      operationId: EditaSORdownloadprofile
      parameters:
      - name: id
        in: query
        description: Profile id of the profile to be edited
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: SOR download profile parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1ProfileRequest'
              - description: SOR download profile parameters
        required: true
      responses:
        '200':
          description: SOR download profile updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '500':
          description: SOR download profile updation failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    delete:
      tags:
      - SOR download profiles
      summary: DeleteaSORdownloadprofile
      description: >
        Use this API to delete an existing SOR download profile.


        Prerequisite: profile id.
      operationId: DeleteaSORdownloadprofile
      parameters:
      - name: id
        in: query
        description: Profile id of the profile to be edited
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: SOR download profile deleted successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '500':
          description: SOR download profile deletion failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
  /otdr/api/v1/traceprofiles:
    get:
      tags:
      - OTDR trace profiles
      summary: GetOTDRtraceprofiles
      description: >
        Use this API to retrieve OTDR trace profiles.


        Prerequisite: management session id.
      operationId: GetOTDRtraceprofiles
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved OTDR trace profiles.
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: Retrieval of OTDR trace profiles failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    post:
      tags:
      - OTDR trace profiles
      summary: CreateanOTDRtraceprofile
      description: >
        Use this API to create an OTDR trace profile.


        Prerequisite: management session id.
      operationId: CreateanOTDRtraceprofile
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: profile_id
        in: query
        description: OTDR trace profile id
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: OTDR trace profile parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1TraceprofilesRequest'
              - description: OTDR trace profile parameters
        required: true
      responses:
        '200':
          description: OTDR trace profile created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: OTDR trace profile creation failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    patch:
      tags:
      - OTDR trace profiles
      summary: EditanOTDRtraceprofile
      description: >
        Use this API to edit an existing OTDR trace profile.


        Prerequisite: management session id and trace profile id.
      operationId: EditanOTDRtraceprofile
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: profile_id
        in: query
        description: OTDR trace profile id
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: OTDR trace profile parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1TraceprofilesRequest'
              - description: OTDR trace profile parameters
        required: true
      responses:
        '200':
          description: OTDR Trace Profile updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: OTDR trace profile updation failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    delete:
      tags:
      - OTDR trace profiles
      summary: DeleteanOTDRtraceprofile
      description: >
        Use this API to delete an existing OTDR trace profile.


        Prerequisite: management session id and trace profile id.
      operationId: DeleteanOTDRtraceprofile
      parameters:
      - name: session_id
        in: query
        description: Management session id of enrolled NE
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: profile_id
        in: query
        description: OTDR trace profile id
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OTDR Trace Profile deleted successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest1'
        '404':
          description: Not found request. Invalid parameters, could not find session_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound1'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotFound1'
        '500':
          description: OTDR trace profile deletion failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
  /otdr/api/v1/sortraces:
    get:
      tags:
      - OTDR Saved SOR traces
      summary: GetSavedSORtraces
      description: >
        Use this API to fetch SOR traces saved in MCP.


        Prerequisite: FRE Id.
      operationId: GetSavedSORtraces
      parameters:
      - name: fre_id
        in: query
        description: Identifier of the FRE
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved saved SOR traces from MCP.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTDRSORtraces'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OTDRSORtraces'
        '400':
          description: Bad request. Invalid parameters, could not find fre_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Retrieval of saved SOR traces failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
      deprecated: false
    post:
      tags:
      - OTDR Saved SOR traces
      summary: RetrieveSORtraces
      description: >
        Use this API to retrieve the SOR traces for the fiber endpoints.


        Prerequisite: FRE Id.
      operationId: RetrieveSORtraces
      parameters:
      - name: fre_id
        in: query
        description: Identifier of the FRE
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved SOR traces for the fiber endpoints.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters, could not find fre_id parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Failed to retrieve the SOR traces for the fiber endpoints, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
      deprecated: false
    patch:
      tags:
      - OTDR Saved SOR traces
      summary: EditSavedSORtracelabel
      description: >
        Use this API to edit SOR trace label.


        Prerequisite: Network Construct Id, Trace Id, File name.
      operationId: EditSavedSORtracelabel
      parameters: []
      requestBody:
        description: OTDR Saved SOR trace parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1SortracesRequest'
              - description: OTDR Saved SOR trace parameters
        required: true
      responses:
        '200':
          description: Saved SOR trace label updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters, could not find sor trace record.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Updation of saved SOR trace label failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
      deprecated: false
    delete:
      tags:
      - OTDR Saved SOR traces
      summary: DeleteaSavedSORtracefile
      description: >
        Use this API to delete a SOR trace file saved in MCP.


        Prerequisite: Network Construct Id, Trace Id, File name.
      operationId: DeleteaSavedSORtracefile
      parameters: []
      responses:
        '200':
          description: Saved SOR trace file deleted successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTDRSORtraces3'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OTDRSORtraces3'
        '207':
          description: Saved SOR trace file Multi-Status response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTDRSORtraces3'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OTDRSORtraces3'
        '400':
          description: Bad request. Invalid parameters, could not find sor trace record.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Deletion of saved SOR trace file failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
      deprecated: false
  /otdr/api/v1/sor/parse:
    post:
      tags:
      - OTDR Parse SOR traces
      summary: RetrieveparsedSORtraces
      description: >
        Use this API to retrieve the parsed SOR trace files saved in MCP.


        Prerequisite: File Name.
      operationId: RetrieveparsedSORtraces
      parameters: []
      requestBody:
        description: OTDR Parse SOR trace files parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrApiV1SorParseRequest'
              - description: OTDR Parse SOR trace files parameters
        required: true
      responses:
        '200':
          description: Successfully retrieved parsed SOR trace files saved in MCP.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTDRParseSORtraces'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OTDRParseSORtraces'
        '207':
          description: Parsed SOR trace files Multi-Status response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTDRParseSORtraces'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OTDRParseSORtraces'
        '400':
          description: Bad request. Invalid parameters, could not find file(s) in MCP.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Failed to retrieve the parsed SOR trace files, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
      deprecated: false
  /perfg/api/channelmargins:
    get:
      tags:
      - cmgapi
      summary: getChanMargins
      description: '<p>LATEST VERSION: V2<p>Get list of services and their margins'
      operationId: getChanMargins
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: List of Channel Margins
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChanList'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Retrieval of Channel Margins failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/channelmargins/{freid}:
    get:
      tags:
      - cmgapi
      summary: getChanMargin
      description: '<p>LATEST VERSION: V2<p>Get detailed channel margin data for a specific service'
      operationId: getChanMargin
      parameters:
      - name: freid
        in: path
        description: identifier of OTSi service to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: dir
        in: query
        description: 'Tx or Rx termination end of the OTSi service. The allowed values are: Tx, Rx'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dir1'
          - description: 'Tx or Rx termination end of the OTSi service. The allowed values are: Tx, Rx'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MarginDetails'
                description: ''
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve specified OTSi service and its margin
          headers: {}
          content: {}
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/configs:
    get:
      tags:
      - cmgapi
      summary: getConfigs
      description: '<p>LATEST VERSION: V2<p>Get list of configuration settings that Performance Gauge uses'
      operationId: getConfigs
      parameters: []
      responses:
        '200':
          description: List of configuration settings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationAttributesRO'
        '500':
          description: Retrieval of Configurations failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
    post:
      tags:
      - cmgapi
      summary: postConfigs
      description: '<p>LATEST VERSION: V2<p>Modify one or more configuration settings of Performance Gauge'
      operationId: postConfigs
      parameters: []
      requestBody:
        description: create or change SafetyFactor and ValidFactor for the Channel Margin app.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ConfigurationAttributesRO'
              - description: create or change SafetyFactor and ValidFactor for the Channel Margin app.
        required: false
      responses:
        '200':
          description: Configuration settings of Performance Gauge is changed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationAttributesRO'
        '400':
          description: Invalid configuration settings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/marginsummary:
    get:
      tags:
      - cmgapi
      summary: getMarginSummary
      description: '<p>LATEST VERSION: V2<p>Dashboard API for channel margin'
      operationId: getMarginSummary
      parameters:
      - name: resourcePartitionIDs
        in: query
        description: (Optional) List of comma separated resource Partition IDs
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Channel Margin Summary
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarginSummary'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Retrieval of Channel Margin Summary failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/channelmargin:
    get:
      tags:
      - cmgapiV1
      summary: get-chanmarg
      description: Get list of services and their margins
      operationId: get-chanmarg
      parameters: []
      responses:
        '200':
          description: Whatever we tried worked
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChanListV1'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: true
  /perfg/api/v1/channelmargin/{freid}/{dir}:
    get:
      tags:
      - cmgapiV1
      summary: get-chanidmarg
      description: Get detailed channel margin data for a specific servicep
      operationId: get-chanidmarg
      parameters:
      - name: freid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: dir
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Found requested service
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarginDetailsV1'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: true
  /perfg/api/v1/marginsummary:
    get:
      tags:
      - cmgapiV1
      summary: getMarginSummaryV1
      description: '<p>VERSION: V1<p>Dashboard API for channel margin'
      operationId: getMarginSummaryV1
      parameters: []
      responses:
        '200':
          description: Channel Margin Summary
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarginSummary'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Retrieval of Channel Margin Summary failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: true
  /perfg/api/v1/safety:
    get:
      tags:
      - cmgapiV1
      summary: get-safety
      description: How much greater than upgrade does minmargin need to be in order for it to be flagged as upgradeable - in dB
      operationId: get-safety
      parameters: []
      responses:
        '200':
          description: Safety factor has been gotten
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Safety'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/safety/{factor}:
    put:
      tags:
      - cmgapiV1
      summary: put-safety
      description: How much greater than upgrade does minmargin need to be in order for it to be flagged as upgradeable - in dB
      operationId: put-safety
      parameters:
      - name: factor
        in: path
        description: Safety Factor
        required: true
        style: simple
        schema:
          maximum: 10
          type: number
          format: double
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type67'
      responses:
        '200':
          description: Safety factor has been set
          headers: {}
          content: {}
        '400':
          description: Safety factor must be a floating point number from 0.0 to 10.0
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/validity:
    get:
      tags:
      - cmgapiV1
      summary: get-validity
      description: How many 15 minute PM bins are required before a margin calculation is considered valid
      operationId: get-validity
      parameters: []
      responses:
        '200':
          description: Validity factor has been gotten
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Validity'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/validity/{factor}:
    put:
      tags:
      - cmgapiV1
      summary: put-validity
      description: How many 15 minute PM bins are required before a margin calculation is considered valid
      operationId: put-validity
      parameters:
      - name: factor
        in: path
        description: Validity Factor
        required: true
        style: simple
        schema:
          maximum: 35040
          minimum: 1
          type: integer
          format: int32
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type67'
      responses:
        '200':
          description: Validity factor has been set
          headers: {}
          content: {}
        '400':
          description: Validity factor must be an integer number from 1 to 35040
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v2/channelmargins:
    get:
      tags:
      - cmgapiV2
      summary: getChanMarginsV2
      description: '<p>LATEST VERSION: V2<p>Get list of services and their margins'
      operationId: getChanMarginsV2
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: List of Channel Margins
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChanList'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Retrieval of Channel Margins failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v2/channelmargins/{freid}:
    get:
      tags:
      - cmgapiV2
      summary: getChanMarginV2
      description: '<p>LATEST VERSION: V2<p>Get detailed channel margin data for a specific service'
      operationId: getChanMarginV2
      parameters:
      - name: freid
        in: path
        description: identifier of OTSi service to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: dir
        in: query
        description: 'Tx or Rx termination end of the OTSi service. The allowed values are: Tx, Rx'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dir1'
          - description: 'Tx or Rx termination end of the OTSi service. The allowed values are: Tx, Rx'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MarginDetails'
                description: ''
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve specified OTSi service and its margin
          headers: {}
          content: {}
        '500':
          description: Retrieval failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v2/configs:
    get:
      tags:
      - cmgapiV2
      summary: getConfigsV2
      description: '<p>LATEST VERSION: V2<p>Get list of configuration settings that Performance Gauge uses'
      operationId: getConfigsV2
      parameters: []
      responses:
        '200':
          description: List of configuration settings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationAttributesRO'
        '500':
          description: Retrieval of Configurations failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
    post:
      tags:
      - cmgapiV2
      summary: postConfigsV2
      description: '<p>LATEST VERSION: V2<p>Modify one or more configuration settings of Performance Gauge'
      operationId: postConfigsV2
      parameters: []
      requestBody:
        description: create or change SafetyFactor and ValidFactor for the Channel Margin app.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ConfigurationAttributesRO'
              - description: create or change SafetyFactor and ValidFactor for the Channel Margin app.
        required: false
      responses:
        '200':
          description: Configuration settings of Performance Gauge is changed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationAttributesRO'
        '400':
          description: Invalid configuration settings
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v2/marginsummary:
    get:
      tags:
      - cmgapiV2
      summary: getMarginSummaryV2
      description: '<p>LATEST VERSION: V2<p>Dashboard API for channel margin'
      operationId: getMarginSummaryV2
      parameters:
      - name: resourcePartitionIDs
        in: query
        description: (Optional) List of comma separated resource Partition IDs
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Channel Margin Summary
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarginSummary'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Retrieval of Channel Margin Summary failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/fiberloss:
    get:
      tags:
      - fiberloss
      summary: getFiberLoss
      description: '<p>LATEST VERSION: V3<p>Get list of fibers and their losses'
      operationId: getFiberLoss
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: List of fiber losses
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberList'
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/fiberloss/{freid}:
    get:
      tags:
      - fiberloss
      summary: getFiberidLoss
      description: '<p>LATEST VERSION: V2<p>Get specified fiber and its losses'
      operationId: getFiberidLoss
      parameters:
      - name: freid
        in: path
        description: Fiber identifier to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Found requested fiber
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberLoss'
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
    patch:
      tags:
      - fiberloss
      summary: patchFiberidLoss
      description: '<p>LATEST VERSION: V1<p>Patch fiber planned loss'
      operationId: patchFiberidLoss
      parameters:
      - name: freid
        in: path
        description: Fiber identifier to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Fiber Data to Update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FiberData'
              - description: Fiber Data to Update
        required: false
      responses:
        '200':
          description: Updated planned fiber loss
          headers: {}
          content: {}
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/fiberloss/{freid}:
    get:
      tags:
      - fiberlossV1
      summary: get-fiberidloss
      description: Get specified fiber and its losses
      operationId: get-fiberidloss
      parameters:
      - name: freid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Found requested fiber
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberLossv1'
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: true
    patch:
      tags:
      - fiberlossV1
      summary: patch-fiberidloss
      description: Patch fiber planned loss
      operationId: patch-fiberidloss
      parameters:
      - name: freid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Fiber Data to Update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FiberData'
              - description: Fiber Data to Update
        required: false
      responses:
        '200':
          description: Updated planned fiber loss
          headers: {}
          content: {}
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v2/fiberloss:
    get:
      tags:
      - fiberlossV2
      summary: getFiberLossV2
      description: '<p>LATEST VERSION: V2<p>Get list of fibers and their losses'
      operationId: getFiberLossV2
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: List of fiber losses
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberListv1'
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: true
  /perfg/api/v2/fiberloss/{freid}:
    get:
      tags:
      - fiberlossV2
      summary: getFiberidLossV2
      description: Get specified fiber and its losses
      operationId: getFiberidLossV2
      parameters:
      - name: freid
        in: path
        description: Fiber identifier to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Found requested fiber
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberLoss'
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v3/fiberloss:
    get:
      tags:
      - fiberlossV3
      summary: getFiberLossV3
      description: Get list of fibers and their losses
      operationId: getFiberLossV3
      parameters:
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: List of fiber losses
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberList'
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/photonicdata/mediaparams:
    get:
      tags:
      - ppgapi
      summary: getPhotonicMediaParams
      description: '<p>LATEST VERSION: V1<p>Get list of photonic services and their measured values'
      operationId: getPhotonicMediaParams
      parameters:
      - name: freID(s)
        in: query
        description: List of comma srparated FRE IDs of the span/section
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: successful operation List of photonic data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ppgMediaParamsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve specified photonic service data
          headers: {}
          content: {}
        '500':
          description: Retrieval of photonic data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/photonicdata/snrdetails:
    get:
      tags:
      - ppgapi
      summary: getPhotonicMarginData
      description: '<p>LATEST VERSION: V1<p>Get list of photonic services and their measured values'
      operationId: getPhotonicMarginData
      parameters:
      - name: freid
        in: query
        description: the FRE ID of the span/section
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: type of SNR
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/filter21'
          - description: type of SNR
      - name: units
        in: query
        description: units of SNR
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/units1'
          - description: units of SNR
      - name: fill ratio
        in: query
        description: Fill Ratio
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/fillratio1'
          - description: Fill Ratio
      responses:
        '200':
          description: successful operation List of photonic data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ppgSnrDetailsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve specified photonic service data
          headers: {}
          content: {}
        '500':
          description: Retrieval of photonic data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/photonicdata/snrsummary:
    get:
      tags:
      - ppgapi
      summary: getPhotonicSummaryData
      description: '<p>LATEST VERSION: V1<p>Get summary of photonic services and their measured values'
      operationId: getPhotonicSummaryData
      parameters:
      - name: resourcePartitionIDs
        in: query
        description: (Optional) List of comma separated resource Partition IDs
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation summary of photonic data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PpgMarginSummary'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Retrieval of photonic data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/photonicdata/mediaparams:
    get:
      tags:
      - ppgapiV1
      summary: getPhotonicMediaParamsV1
      description: '<p>LATEST VERSION: V1<p>Get list of photonic services and their measured values'
      operationId: getPhotonicMediaParamsV1
      parameters:
      - name: freID(s)
        in: query
        description: List of comma srparated FRE IDs of the span/section
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: successful operation List of photonic data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ppgMediaParamsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve specified photonic service data
          headers: {}
          content: {}
        '500':
          description: Retrieval of photonic data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/photonicdata/snrdetails:
    get:
      tags:
      - ppgapiV1
      summary: getPhotonicMarginDataV1
      description: '<p>LATEST VERSION: V1<p>Get list of photonic services and their measured values'
      operationId: getPhotonicMarginDataV1
      parameters:
      - name: freid
        in: query
        description: the FRE ID of the span/section
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: type of SNR
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/filter21'
          - description: type of SNR
      - name: units
        in: query
        description: units of SNR
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/units1'
          - description: units of SNR
      - name: fill ratio
        in: query
        description: Fill Ratio
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/fillratio1'
          - description: Fill Ratio
      responses:
        '200':
          description: successful operation List of photonic data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ppgSnrDetailsList'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '404':
          description: Unable to retrieve specified photonic service data
          headers: {}
          content: {}
        '500':
          description: Retrieval of photonic data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/photonicdata/snrsummary:
    get:
      tags:
      - ppgapiV1
      summary: getPhotonicSummaryDataV1
      description: '<p>LATEST VERSION: V1<p>Get summary of photonic services and their measured values'
      operationId: getPhotonicSummaryDataV1
      parameters:
      - name: resourcePartitionIDs
        in: query
        description: (Optional) List of comma separated resource Partition IDs
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation summary of photonic data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PpgMarginSummary'
        '403':
          description: API Not Licensed
          headers: {}
          content: {}
        '500':
          description: Retrieval of photonic data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/resetchannelmargin:
    put:
      tags:
      - resetchannelmarginV1
      summary: resetchannelmargindata
      description: <p>Resets the channel margin data for the given freid. If no fre id is provided, resets the channel margin data for all.
      operationId: resetchannelmargindata
      parameters:
      - name: freid
        in: query
        description: (Optional) Reset the Channel Margin data for the given freid
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: Successful reset of data
          headers: {}
          content: {}
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Reset of channel margin data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /perfg/api/v1/resetppgdata:
    put:
      tags:
      - resetppgdataV1
      summary: resetppgdata
      description: <p>Resets the photonic performance data for the given freid. If no fre id is provided, resets the photonic performance guage data for all.
      operationId: resetppgdata
      parameters:
      - name: freid
        in: query
        description: (Optional) Reset Photonic performance guage data for the given freid
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: Successful reset of data
          headers: {}
          content: {}
        '404':
          description: freid not found
          headers: {}
          content: {}
        '500':
          description: Reset of Photonic performance guage data failed (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /pm/api/v1/facilities:
    post:
      tags:
      - Facilities
      summary: initReg
      description: Interactions with facilities such as INIT-REG
      operationId: initReg
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/initRegisterRequest'
        required: true
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/initRegisterResponse'
                - description: INIT-REG response
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
      deprecated: false
  /pm/api/v1/queries:
    post:
      tags:
      - Real-Time
      summary: getRPM
      description: Retrieves real-time performance metrics. Multiple measurement points can be defined. All measurement points are queried concurrently. This call blocks until all results are returned or times out. In case of a timeout of individual measurement point queries, all successful queries are still returned
      operationId: getRPM
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rpmRequest'
        required: true
      responses:
        '201':
          description: Returns the metrics collected from each measurement point or an error if metrics collection failed for a given measurement point
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queryResponse'
        '400':
          description: Bad request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '404':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '408':
          description: Time-out. None of the defined measurement points could be retrieved in time
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '504':
          description: The NE for the RPM request is LOA
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
      deprecated: false
  /pm/api/v1/query/metrics:
    post:
      tags:
      - Historical_v1
      summary: getHPM
      description: Retrieves historical performance metrics. Callers can choose an absolute or relative time frame and filter the results based on multiple criteria
      operationId: getHPM
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hpmRequest'
        required: true
      responses:
        '201':
          description: Returns all metrics available for the provided time frame that match the specified criteria
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queryResponse'
        '400':
          description: Bad Request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Heroic did not respond as expected
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
      deprecated: true
  /pm/api/v2/query/metrics:
    post:
      tags:
      - Historical_v2
      summary: Retrieveshistoricalperformancemetrics
      description: Retrieves historical performance metrics. Callers can choose an absolute or relative time frame and filter the results based on multiple criteria
      operationId: Retrieveshistoricalperformancemetrics
      parameters:
      - name: ts
        in: query
        description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ts1'
          - description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
      - name: start
        in: query
        description: Unix timestamp representing the absolute start time of the query. Used for paging through datapoints. A user triggered request must specify a RFC3339 formatted 'startTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Unix timestamp representing the absolute end time of the query. Used for paging through datapoints. A user triggered request must specify a RFC3339 formatted 'endTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: Page number
        style: form
        explode: true
        schema:
          type: number
          format: double
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hpmRequestV2'
        required: true
      responses:
        '201':
          description: Returns all metrics available for the provided time frame that match the specified criteria
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hpmResponseV2'
        '400':
          description: Bad Request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v2/query/tags:
    get:
      tags:
      - Historical_v2
      summary: Returnsacollectionofexistingvaluesfortheprovidedtag
      description: Returns a collection of existing values for the provided tag
      operationId: Returnsacollectionofexistingvaluesfortheprovidedtag
      parameters:
      - name: tag
        in: query
        description: The name of the tag for which a collection of values is returned
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: search
        in: query
        description: A filter for the returned tag values. Any value which CONTAINS the provided search text is returned
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of returned values
        required: true
        style: form
        explode: true
        schema:
          type: number
          format: double
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Returns a limited set of values for the specified tag. If no values are found, an empty array is returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagResponse'
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v3/query/metrics:
    post:
      tags:
      - Historical_v3
      summary: PostRetrieveshistoricalperformancemetrics
      description: Retrieves historical performance metrics. Callers can choose an absolute or relative time frame and filter the results based on multiple criteria
      operationId: PostRetrieveshistoricalperformancemetrics
      parameters:
      - name: ts
        in: query
        description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ts1'
          - description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
      - name: start
        in: query
        description: Unix timestamp representing the absolute start time of the query. Used for paging through datapoints. A user triggered request must specify a RFC3339 formatted 'startTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Unix timestamp representing the absolute end time of the query. Used for paging through datapoints. A user triggered request must specify a RFC3339 formatted 'endTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: Starting point for returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: backwards
        in: query
        description: Search backwards from the cursor, instead of forwards
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hpmRequestV2'
        required: true
      responses:
        '201':
          description: Returns all metrics available for the provided time frame that match the specified criteria
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hpmResponseV3'
        '400':
          description: Bad Request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v1/query/ossMetrics:
    post:
      tags:
      - OssQuery_v1
      summary: Retrieveshistoricalperformancemetricsforosssystem
      description: Retrieves historical performance metrics for oss system. Callers can choose an absolute or relative time frame and filter the results based on multiple criteria
      operationId: Retrieveshistoricalperformancemetricsforosssystem
      parameters:
      - name: ts
        in: query
        description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ts1'
          - description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
      - name: start
        in: query
        description: Unix timestamp representing the absolute start time of the query. Used for paging through datapoints. A user triggered request must specify a RFC3339 formatted 'startTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Unix timestamp representing the absolute end time of the query. Used for paging through datapoints. A user triggered request must specify a RFC3339 formatted 'endTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: Starting point for returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: backwards
        in: query
        description: Search backwards from the cursor, instead of forwards
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hpmRequestV2'
        required: true
      responses:
        '201':
          description: Returns all metrics available for the provided time frame that match the specified criteria
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hpmResponseV3'
        '400':
          description: Bad Request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v1/query/metrics/correlated:
    post:
      tags:
      - Correlated_v1
      summary: Retrieveshistoricalperformancemetricscorrelatedbyfacility(usedforSDMON,CHMONandOPMqueriesonly)
      description: Retrieves historical performance metrics correlated by facility (used for SDMON, CHMON and OPM queries only). Callers can choose an absolute or relative time frame and filter the results based on either a map of network elements to lists of facilities, or a list of network elements.
      operationId: Retrieveshistoricalperformancemetricscorrelatedbyfacility(usedforSDMON,CHMONandOPMqueriesonly)
      parameters:
      - name: ts
        in: query
        description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ts1'
          - description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
      - name: start
        in: query
        description: Unix timestamp representing the absolute start time of the query. Used for paging through results. A user triggered request must specify a RFC3339 formatted 'startTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Unix timestamp representing the absolute end time of the query. Used for paging through results. A user triggered request must specify a RFC3339 formatted 'endTime' in the request body. If both are defined, the URL parameter takes precedence.
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: Starting point for the returned page.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/correlatedRequestV1'
              - example:
                  data:
                    attributes:
                      filter:
                        networkElementsAndFacilities:
                          P8250A:
                          - SDMON-1-6-5
                          - SDMON-1-6-7
                          P8250B:
                          - SDMON-1-6-5
                          - SDMON-1-6-7
                      range:
                        endTime: 2020-07-01T18:00:00.000Z
                        startTime: 2020-07-01T12:00:00.000Z
                        type: absolute
                      tags:
                      - networkElementName
                      - parameterNative
                      - facilityNameNative
            example:
              data:
                attributes:
                  filter:
                    networkElementsAndFacilities:
                      P8250A:
                      - SDMON-1-6-5
                      - SDMON-1-6-7
                      P8250B:
                      - SDMON-1-6-5
                      - SDMON-1-6-7
                  range:
                    endTime: 2020-07-01T18:00:00.000Z
                    startTime: 2020-07-01T12:00:00.000Z
                    type: absolute
                  tags:
                  - networkElementName
                  - parameterNative
                  - facilityNameNative
        required: true
      responses:
        '201':
          description: Returns all metrics available for the provided time frame that match the specified criteria, correlated by facility
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/correlatedResponseV1'
        '400':
          description: Bad Request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v1/query/metrics/rollupCalculation:
    post:
      tags:
      - RollupCalculation_v1
      summary: Searchandfilterhistoricalperformancemetrics,dorollupcalculationusingthe15minutesbinbasedonthestartandendtime.
      description: Search and filter historical performance metrics, do rollup calculation using the 15 minutes bin based on the start and end time.
      operationId: Searchandfilterhistoricalperformancemetrics,dorollupcalculationusingthe15minutesbinbasedonthestartandendtime.
      parameters:
      - name: calculation
        in: query
        description: Type of rollup calculation
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/calculation1'
          - description: Type of rollup calculation
      - name: granularity
        in: query
        description: Calculation granularity
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/granularity51'
          - description: Calculation granularity
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rollupCalcRequestV1'
        required: true
      responses:
        '201':
          description: Returns the calculated rollup result for the provided time frame that match the specified criteria
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rollupCalcResponseV1'
        '400':
          description: Bad Request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v2/query/meta:
    post:
      tags:
      - Meta_v2
      summary: Retrievesmetadataaccordingtothespecifiedcriteria
      description: Retrieves meta data and contextual aggregations corresponding to the specified criteria
      operationId: Retrievesmetadataaccordingtothespecifiedcriteria
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/metaRequest'
        required: true
      responses:
        '201':
          description: Returns all metrics available for the provided time frame that match the specified criteria
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/metaResponse'
        '400':
          description: Bad Request format
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '429':
          description: The max concurrent requests limit has been reached.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmError'
                - description: An error that occurred during PM collection
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v2/collections:
    patch:
      tags:
      - Collections_v2
      summary: Bulkupdatecollectionconfigurationformultiplenetworkelements
      description: Bulk update collection configuration for multiple network elements. Network elements can be specified by name or type
      operationId: Bulkupdatecollectionconfigurationformultiplenetworkelements
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/collectionsBulkRequest'
              - example:
                  data:
                  - attributes:
                      applyForNeNames:
                      - PV0045
                      - PV0046
                      configName: 15_MINUTES
                      enabled: true
                      pollingInterval:
                        unit: HOURS
                        value: 3
                      resolution:
                        unit: MINUTES
                        value: 15
                    type: config
            example:
              data:
              - attributes:
                  applyForNeNames:
                  - PV0045
                  - PV0046
                  configName: 15_MINUTES
                  enabled: true
                  pollingInterval:
                    unit: HOURS
                    value: 3
                  resolution:
                    unit: MINUTES
                    value: 15
                type: config
        required: true
      responses:
        '200':
          description: Successful update
          headers: {}
          content: {}
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v2/collections/networkelements/intervals/{type}:
    get:
      tags:
      - Collections_v2
      summary: Getthepollinginterval(s)ofthe15minuteor24hourbinforallnetworkelementsofgiventype
      description: Get the polling interval(s) of the 15 minute or 24 hour bin for all network elements of given type
      operationId: Getthepollinginterval(s)ofthe15minuteor24hourbinforallnetworkelementsofgiventype
      parameters:
      - name: type
        in: path
        description: 'Network Element Type (e.g: 6500)'
        required: true
        style: simple
        schema:
          type: string
      - name: configuration
        in: query
        description: The name of the configuration, representing the desired metric bin (i.e. 15_MINUTES or 24_HOURS)
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/configuration1'
          - description: The name of the configuration, representing the desired metric bin (i.e. 15_MINUTES or 24_HOURS)
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intervalsGetData'
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v2/collections/networkelements/types/{type}:
    patch:
      tags:
      - Collections_v2
      summary: Updatecollectionconfigurationofallnetworkelementsofgiventype
      description: Update collection configuration of all network elements of given type
      operationId: Updatecollectionconfigurationofallnetworkelementsofgiventype
      parameters:
      - name: type
        in: path
        description: 'Network Element Type (i.e: 6500)'
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/collectionsPatch'
              - example:
                  data:
                  - attributes:
                      configName: 15_MINUTES
                      enabled: true
                      pollingInterval:
                        unit: HOURS
                        value: 3
                      resolution:
                        unit: MINUTES
                        value: 15
                    id: PV0445A
                    type: config
            example:
              data:
              - attributes:
                  configName: 15_MINUTES
                  enabled: true
                  pollingInterval:
                    unit: HOURS
                    value: 3
                  resolution:
                    unit: MINUTES
                    value: 15
                id: PV0445A
                type: config
        required: true
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v2/collections/networkelements/{networkElementName}:
    get:
      tags:
      - Collections_v2
      summary: Returncollectionconfigurationofthegivennetworkelement
      description: Return collection configuration of the given network element, identified by its name
      operationId: Returncollectionconfigurationofthegivennetworkelement
      parameters:
      - name: networkElementName
        in: path
        description: Network Element Name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collectionsGet'
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: true
    post:
      tags:
      - Collections_v2
      summary: Triggerimmediatecollectionforthespecifiednetworkelementandresolution
      description: Triggers PM collection for the specified network element
      operationId: Triggerimmediatecollectionforthespecifiednetworkelementandresolution
      parameters:
      - name: networkElementName
        in: path
        description: Network Element Name
        required: true
        style: simple
        schema:
          type: string
      - name: configuration
        in: query
        description: The name of the configuration, representing the desired resolution (15_MINUTES, 24_HOURS)
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: true
    patch:
      tags:
      - Collections_v2
      summary: Updatecollectionconfigurationofthegivennetworkelement
      description: Update collection configuration of the given network element, identified by its name
      operationId: Updatecollectionconfigurationofthegivennetworkelement
      parameters:
      - name: networkElementName
        in: path
        description: Network Element Name
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/collectionsPatch'
              - example:
                  data:
                  - attributes:
                      configName: 15_MINUTES
                      enabled: true
                      pollingInterval:
                        unit: HOURS
                        value: 3
                      resolution:
                        unit: MINUTES
                        value: 15
                    id: PV0445A
                    type: config
            example:
              data:
              - attributes:
                  configName: 15_MINUTES
                  enabled: true
                  pollingInterval:
                    unit: HOURS
                    value: 3
                  resolution:
                    unit: MINUTES
                    value: 15
                id: PV0445A
                type: config
        required: true
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: true
  /pm/api/v3/collections:
    get:
      tags:
      - Collections_v3
      summary: GetReturncollectionconfigurationofthegivennetworkelement
      description: Return collection configuration of the given network element, identified by its name
      operationId: GetReturncollectionconfigurationofthegivennetworkelement
      parameters:
      - name: networkElementName
        in: query
        description: Network Element Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collectionsGet'
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
    post:
      tags:
      - Collections_v3
      summary: PostTriggerimmediatecollectionforthespecifiednetworkelementandresolution
      description: Triggers PM collection for the specified network element
      operationId: PostTriggerimmediatecollectionforthespecifiednetworkelementandresolution
      parameters:
      - name: networkElementName
        in: query
        description: Network Element Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: configuration
        in: query
        description: The name of the configuration, representing the desired resolution (15_MINUTES, 24_HOURS)
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
    patch:
      tags:
      - Collections_v3
      summary: PatchUpdatecollectionconfigurationofthegivennetworkelement
      description: Update collection configuration of the given network element, identified by its name
      operationId: PatchUpdatecollectionconfigurationofthegivennetworkelement
      parameters:
      - name: networkElementName
        in: query
        description: Network Element Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/collectionsPatch'
              - example:
                  data:
                  - attributes:
                      configName: 15_MINUTES
                      enabled: true
                      pollingInterval:
                        unit: HOURS
                        value: 3
                      resolution:
                        unit: MINUTES
                        value: 15
                    id: PV0445A
                    type: config
            example:
              data:
              - attributes:
                  configName: 15_MINUTES
                  enabled: true
                  pollingInterval:
                    unit: HOURS
                    value: 3
                  resolution:
                    unit: MINUTES
                    value: 15
                id: PV0445A
                type: config
        required: true
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v3/collections/collectioncount:
    get:
      tags:
      - Collections_v3
      summary: Getthecollectionsummaryof15_MINUTESor24_HOURSbinforgiventimedurationandnetworkelementtype
      description: Get successful and failed/delayed collection detail like NE name, last collection time, number of NEs in LOA state for 15_MINUTES or 24_HOURS bin in given time duration and network element type.
      operationId: Getthecollectionsummaryof15_MINUTESor24_HOURSbinforgiventimedurationandnetworkelementtype
      parameters:
      - name: type
        in: query
        description: 'Network Element Type (e.g: 6500)'
        style: form
        explode: true
        schema:
          type: string
      - name: configuration
        in: query
        description: The name of the configuration, representing the desired metric bin (i.e. 15_MINUTES or 24_HOURS)
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/configuration1'
          - description: The name of the configuration, representing the desired metric bin (i.e. 15_MINUTES or 24_HOURS)
      - name: duration
        in: query
        description: The interval for which count need to fetch. For 24_HOURS configuration, only 24 Hour and 48 Hour duration supported
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/duration11'
          - description: The interval for which count need to fetch. For 24_HOURS configuration, only 24 Hour and 48 Hour duration supported
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collectionCountGetData'
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v3/collections/networkelements/intervals/{type}:
    get:
      tags:
      - Collections_v3
      summary: Getthepollinginterval(s)ofthe15minuteor24hourbinforallnetworkelementsofgiventype1
      description: Get the polling interval(s) of the 15 minute or 24 hour bin for all network elements of given type
      operationId: Getthepollinginterval(s)ofthe15minuteor24hourbinforallnetworkelementsofgiventype1
      parameters:
      - name: type
        in: path
        description: 'Network Element Type (e.g: 6500)'
        required: true
        style: simple
        schema:
          type: string
      - name: typegroup
        in: query
        description: 'Network Element Type Group(i.e.: Ciena6500, PN8x, PN6x)'
        style: form
        explode: true
        schema:
          type: string
      - name: configuration
        in: query
        description: The name of the configuration, representing the desired metric bin (i.e. 15_MINUTES or 24_HOURS)
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/configuration1'
          - description: The name of the configuration, representing the desired metric bin (i.e. 15_MINUTES or 24_HOURS)
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intervalsGetData'
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v3/collections/networkelements/types/{type}:
    patch:
      tags:
      - Collections_v3
      summary: PatchUpdatecollectionconfigurationofallnetworkelementsofgiventype
      description: Update collection configuration entries like polling interval or resolution of all network elements of given type
      operationId: PatchUpdatecollectionconfigurationofallnetworkelementsofgiventype
      parameters:
      - name: type
        in: path
        description: 'Network Element Type (i.e: 6500)'
        required: true
        style: simple
        schema:
          type: string
      - name: typegroup
        in: query
        description: 'Network Element Type Group(i.e.: Ciena6500, PN8x, PN6x)'
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/collectionsPatch'
              - example:
                  data:
                  - attributes:
                      configName: 15_MINUTES
                      enabled: true
                      pollingInterval:
                        unit: HOURS
                        value: 3
                      resolution:
                        unit: MINUTES
                        value: 15
                    id: PV0445A
                    type: config
            example:
              data:
              - attributes:
                  configName: 15_MINUTES
                  enabled: true
                  pollingInterval:
                    unit: HOURS
                    value: 3
                  resolution:
                    unit: MINUTES
                    value: 15
                id: PV0445A
                type: config
        required: true
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '207':
          description: Partial success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Not found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '409':
          description: Conflict. Server constraint violated
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v1/autocomplete/{tag}:
    get:
      tags:
      - Auto-Complete
      summary: Findasubsetofpossiblevaluesforatagmatchingafilter
      description: Returns a subset of all possible values for a tag that match a filter string, with an optional max limit
      operationId: Findasubsetofpossiblevaluesforatagmatchingafilter
      parameters:
      - name: tag
        in: path
        description: The tag we are trying to auto-complete
        required: true
        style: simple
        schema:
          type: string
      - name: filter
        in: query
        description: The value being matched against
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of values
        style: form
        explode: true
        schema:
          type: number
          format: double
          default: 50
      responses:
        '200':
          description: Returns all the possible tag values that match the filter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/autoCompleteResponse'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '404':
          description: Auto-complete is not supported for the specified tag
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pm/api/v1/locations:
    get:
      tags:
      - Locations
      summary: Getallpossiblelocationfieldsforperformancemetrics
      description: Returns all possible location fields that can be used to search for historical performance metrics
      operationId: Getallpossiblelocationfieldsforperformancemetrics
      parameters: []
      responses:
        '200':
          description: Returns all the searchable location fields
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/locationsResponse'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
        '500':
          description: Unexpected error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pmErrorV2'
                - description: Errors that occurred
      deprecated: false
  /pinpoint/api/v1/activetraces:
    get:
      tags:
      - pinpointapiv1activetraces
      summary: getAllTraces
      description: Retrieve all the active otdr traces
      operationId: getAllTraces
      parameters: []
      responses:
        '200':
          description: Successfully retrieved the list of active traces.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveTraceListRO'
        '500':
          description: Retrieval of active traces failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/fiberpaths:
    get:
      tags:
      - pinpointapiv1fiberpaths
      summary: get
      description: Get list of all fiberpaths
      operationId: get
      parameters:
      - name: include
        in: query
        description: (Optional) Type of resource to be side-loaded. The allowed value is links
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of all fiberpaths.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberPathListRO'
        '400':
          description: Invalid value specified for a query parameter or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of fiberpath data failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - pinpointapiv1fiberpaths
      summary: post
      description: >-
        Upon success, code 201 is returned and the output consists of JSON objects representing the identifier of a created fiberpath.<p>Here is a sample request body:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                 "type": "fiberpath",
                 "attributes": {
                    "name": "test",
                    "items": [
                        {
                            "id": "0d37c949-382d-4f30-8637-828869fb4164",
                            "type": "placemark"
                        },
                        {
                            "id": "0d37c949-382d-4f30-8637-828869fb4164",
                            "type": "placemark",
                            "start-lag": 10,
                            "end-lag": 10
                        },
                        {
                            "id": "0d37c949-382d-4f30-8637-828869fb4164"
                            "type": "placemark"
                        }
                    ]
                }
            }
        }

        </code></pre><p>LATEST VERSION: V1
      operationId: post
      parameters: []
      requestBody:
        description: Fiberpath to be created
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FiberPathRO'
              - description: Fiberpath to be created
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberPathRO'
        '201':
          description: Fiberpath created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberPathRO'
        '400':
          description: Input validation error. Invalid value specified for parameters.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create fiberpath, internal server error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/fiberpaths/{id}:
    get:
      tags:
      - pinpointapiv1fiberpaths
      summary: getById
      description: Retrieve a fiberpath with a given identifier
      operationId: getById
      parameters:
      - name: id
        in: path
        description: Identifier of the fiberpath data to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved fiberpath data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberPathRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the specified fiberpath data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - pinpointapiv1fiberpaths
      summary: delete
      description: Deletes fiberpath by the given identifier
      operationId: delete
      parameters:
      - name: id
        in: path
        description: Identifier of fiberpath to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: The specified fiberpath deleted successfully.
          headers: {}
          content: {}
        '404':
          description: The specified fiberpath does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete specified fiberpath.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/fiberpaths/{id}/links:
    get:
      tags:
      - pinpointapiv1fiberpaths
      summary: getLinks
      description: Retrieve the links associated with the given fiberpath identifier
      operationId: getLinks
      parameters:
      - name: id
        in: path
        description: Identifier of the fiberpath for which link is to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved links data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkListRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to retrieve the links
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the links of the given fiberpath data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/fiberpaths/{id}/startNode/{ncid}/distances:
    post:
      tags:
      - pinpointapiv1fiberpaths
      summary: getCoordinatesOfDistances
      description: Retrieve list of coordinates for distances on fiberpath
      operationId: getCoordinatesOfDistances
      parameters:
      - name: id
        in: path
        description: Identifier of the fiberpath
        required: true
        style: simple
        schema:
          type: string
      - name: ncid
        in: path
        description: Identifier of the start node from where trace is run
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request to get the geo coordinates of the input distances. All input distances are in meters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DistanceCoordinateListRO'
              - description: Request to get the geo coordinates of the input distances. All input distances are in meters
        required: false
      responses:
        '200':
          description: Retrieved coordinates successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistanceCoordinateListRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the coordinates of specified distance on fiberpath
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/files:
    get:
      tags:
      - pinpointapiv1kml
      summary: getAllKmlFiles
      description: Get info of all the uploaded kml files
      operationId: getAllKmlFiles
      parameters: []
      responses:
        '200':
          description: Successfully retrieved the list of kml elements.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KmlFileListRO'
        '500':
          description: Retrieval of kml file failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/files/{id}:
    delete:
      tags:
      - pinpointapiv1kml
      summary: deleteByFileId
      description: Deletes all the file elements
      operationId: deleteByFileId
      parameters:
      - name: id
        in: path
        description: Kml file id to be deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted file and all kml elements successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified file id does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete kml elements.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/files/{id}/placemarks:
    get:
      tags:
      - pinpointapiv1kml
      summary: getPlacemarksByFileId
      description: Get all placemarks of the given file identifier
      operationId: getPlacemarksByFileId
      parameters:
      - name: id
        in: path
        description: Identifier of the kml file
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved kml data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlacemarkListRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the specified kml data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/placemarks:
    get:
      tags:
      - pinpointapiv1kml
      summary: Getget
      description: Get list of the kml elements
      operationId: Getget
      parameters:
      - name: ids
        in: query
        description: (Optional) Comma separated list of kml elements identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for current index of data to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of kml elements.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlacemarkListRO'
        '400':
          description: Invalid value specified for a query parameter or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of kml data failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/placemarks/{id}:
    get:
      tags:
      - pinpointapiv1kml
      summary: GetgetById
      description: Retrieve a kml element with the given identifier
      operationId: GetgetById
      parameters:
      - name: id
        in: path
        description: Identifier of the kml data to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded.The allowed values are: fiberpaths, ne, waypoint, spool'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved kml data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlacemarkRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the specified kml data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - pinpointapiv1kml
      summary: put
      description: >-
        Upon success, code 200 is returned and the output consists of JSON objects representing the updated kml element.<p>Here is a sample request:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                "id": "0d37c949-382d-4f30-8637-828869fb4164",
                 "type": "placemark",
                 "attributes": {
                     "name": "test",
                     "description": "desc to be updated",
                     "style": {
                         "color": "#0000ff",
                         "width": 5
                      }
                }
            }
        }

        </code></pre><p>LATEST VERSION: V1
      operationId: put
      parameters:
      - name: id
        in: path
        description: Identifier of the kml data to be updated.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Updated kml element.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlacemarkRO'
              - description: Updated kml element.
        required: false
      responses:
        '200':
          description: Kml element has been updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlacemarkRO'
        '400':
          description: Bad request. Input invalid.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update kml placemark.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - pinpointapiv1kml
      summary: Deletedelete
      description: Deletes the specific kml element and all its association if any
      operationId: Deletedelete
      parameters:
      - name: id
        in: path
        description: Identifier of kml element to be deleted
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted placemark successfully.
          headers: {}
          content: {}
        '404':
          description: The specified placemark does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete specified placemark.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/placemarks/{id}/ne:
    put:
      tags:
      - pinpointapiv1kml
      summary: associateNe
      description: >-
        Upon success, code 204 is returned<p>Here is a sample request:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                "id": "0d37c949-382d-4f30-8637-828869fb4164",
                 "type": "placemark",
                 "relationships": {
                      "ne": {
                           "data": {
                                "type": "ne",
                                "id": "1"
                         }
                     }
                }
            }
        }

        </code></pre><p>LATEST VERSION: V1
      operationId: associateNe
      parameters:
      - name: id
        in: path
        description: Kml element identifier.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Kml element data with ne relationship
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlacemarkRO'
              - description: Kml element data with ne relationship
        required: false
      responses:
        '204':
          description: Relationship created between kml element and managed element successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid input data to create association.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create association
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/placemarks/{id}/{resource_type}/{related_id}:
    delete:
      tags:
      - pinpointapiv1kml
      summary: deleteAssociation
      description: Deletes association given the kml element and related idenitifer
      operationId: deleteAssociation
      parameters:
      - name: id
        in: path
        description: Identifier of placemark to be unassociated
        required: true
        style: simple
        schema:
          type: string
      - name: resource_type
        in: path
        description: 'Resource type with which placemark is to be unassociated. The allowed values are: ne, waypoint, spool'
        required: true
        style: simple
        schema:
          type: string
      - name: related_id
        in: path
        description: Identifier of related entity to be unassociated
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted association successfully.
          headers: {}
          content: {}
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete specified association.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/kml/upload:
    post:
      tags:
      - pinpointapiv1kml
      summary: uploadFile
      description: Uploads the kml file
      operationId: uploadFile
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: The input stream of the kml file to be uploaded.
                  format: binary
        required: false
      responses:
        '200':
          description: Upload of kml was successful!
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid input file extension.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Upload failed, internal server error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/nes:
    get:
      tags:
      - pinpointapiv1nes
      summary: getAllUnassociatedNes
      description: Get list of unassociated network elements
      operationId: getAllUnassociatedNes
      parameters:
      - name: lat
        in: query
        description: (Optional) Latitude of center point
        style: form
        explode: true
        schema:
          type: string
      - name: long
        in: query
        description: (Optional) Longitude of center point
        style: form
        explode: true
        schema:
          type: string
      - name: distance
        in: query
        description: (Optional) Radius in meter to search for
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      - name: offset
        in: query
        description: (Optional) Offset for the next page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of network elements data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkElementListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of network elements data failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/nes/{ncid}/otdr/{aid}:
    get:
      tags:
      - pinpointapiv1nes
      summary: getOtdrConfigDataById
      description: Retrieve otdr facility config data with the given network element ncid and facility aid
      operationId: getOtdrConfigDataById
      parameters:
      - name: ncid
        in: path
        description: Network construct identifier
        required: true
        style: simple
        schema:
          type: string
      - name: aid
        in: path
        description: Otdr facility identifier for which config to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved otdr config data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtdrRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the otdr config data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/nes/{ncid}/otdr/{aid}/setbaseline:
    post:
      tags:
      - pinpointapiv1nes
      summary: setBaseline
      description: >-
        Upon success, code 204 is returned with no content in the output.<p>Here is a sample request:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                 "type": "sor",
                 "attributes": {
                   "aid": "OTDRCFG-1-1-8",
                   "traceType": "Short"
                }
            }
        }

        </code></pre><p>LATEST VERSION: V1
      operationId: setBaseline
      parameters:
      - name: ncid
        in: path
        description: Network construct identifier
        required: true
        style: simple
        schema:
          type: string
      - name: aid
        in: path
        description: Otdr facility identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Sor data to be set as baseline
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SorRO'
              - description: Sor data to be set as baseline
        required: false
      responses:
        '204':
          description: Current trace set to baseline successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to set the current trace to baseline on specified otdr facility
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/nes/{ncid}/otdr/{aid}/sorfiles:
    get:
      tags:
      - pinpointapiv1nes
      summary: getSorFiles
      description: Retrieve the sor files associated with the given network element and otdr aid identifier
      operationId: getSorFiles
      parameters:
      - name: ncid
        in: path
        description: Network construct identifier
        required: true
        style: simple
        schema:
          type: string
      - name: aid
        in: path
        description: Otdr facility identifier
        required: true
        style: simple
        schema:
          type: string
      - name: traceType
        in: query
        description: (Optional) Trace-type for sor listing
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved sor files data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SorListRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the sor files of the given network element and otdrcfg aid identifier
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/nes/{ncid}/otdr/{aid}/starttrace:
    post:
      tags:
      - pinpointapiv1nes
      summary: startTrace
      description: >-
        Upon success, code 204 is returned with no content in the output.<p>Here is a sample request:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                "id": "OTDRCFG-1-1-8",
                 "type": "otdr",
                 "attributes": {
                     "maximum-acquisition-time-sec": 67,
                     "short-pulse-nsec": "1000",
                     "short-distance-mtr": "20000",
                     "long-pulse-nsec": "10000",
                     "long-distance-mtr": "640000",
                     "office-pulse-nsec": "100",
                     "office-distance-mtr": "8000",
                     "event-range-mtr": 100,
                     "trace-type": "long"
                }
            }
        }

        </code></pre><p>LATEST VERSION: V1
      operationId: startTrace
      parameters:
      - name: ncid
        in: path
        description: Network construct identifier
        required: true
        style: simple
        schema:
          type: string
      - name: aid
        in: path
        description: Otdr facility identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Otdr config data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OtdrRO'
              - description: Otdr config data
        required: false
      responses:
        '204':
          description: Trace edit/started successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to edit/start the trace on specified otdr facility
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/nes/{ncid}/otdr/{aid}/stoptrace:
    post:
      tags:
      - pinpointapiv1nes
      summary: stopTrace
      description: Stop the already running OTDR trace
      operationId: stopTrace
      parameters:
      - name: ncid
        in: path
        description: Network construct identifier
        required: true
        style: simple
        schema:
          type: string
      - name: aid
        in: path
        description: Otdr facility identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Trace stopped successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to stop the trace on specified otdr facility
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/nes/{ncid}/otdr/{aid}/tracestatus:
    get:
      tags:
      - pinpointapiv1nes
      summary: getTraceStatus
      description: Retrieve the active trace
      operationId: getTraceStatus
      parameters:
      - name: ncid
        in: path
        description: Network construct identifier
        required: true
        style: simple
        schema:
          type: string
      - name: aid
        in: path
        description: Otdr facility identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved trace status data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveTraceRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the trace status of the given network element ncid and otdr facility identifier
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/others/{type}:
    post:
      tags:
      - pinpointapiv1others
      summary: Postpost
      description: >-
        Upon success, code 201 is returned and the output consists of JSON objects representing the identifier of a created spool or waypoint.<p>Here is a sample request:</p><pre style='font-size: smaller'><code class='json'>{
            "data" : {
                 "type": "spool or waypoint",
                 "attributes": {
                     "label": "test",
                      "length": 100
                },
                  "relationships": {
                      "placemark":  {
                          "data":{
                              "type": "placemark",
                              "id":"11"
                          }
                      }
                 }
            }
        }

        </code></pre><p>LATEST VERSION: V1
      operationId: Postpost
      parameters:
      - name: type
        in: path
        description: 'Type of entity to be created. The allowed values are: spool or waypoint'
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Spool/Waypoint to be created
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SpoolWaypointRO'
              - description: Spool/Waypoint to be created
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpoolWaypointRO'
        '201':
          description: Spool/Waypoint created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpoolWaypointRO'
        '400':
          description: Bad request. Invalid input data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create, internal server error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pinpoint/api/v1/sor/{id}:
    get:
      tags:
      - pinpointapiv1sor
      summary: GetgetById1
      description: Retrieve a sor trace with the given identifier
      operationId: GetgetById1
      parameters:
      - name: id
        in: path
        description: Identifier of the sor trace to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Retrieved sor trace data successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SorRO'
        '400':
          description: Bad request. Invalid input.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified data does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the specified sor trace data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /pmprocessor/api/v1/calculationcontexts:
    get:
      tags:
      - Derived Metrics
      summary: queryCalculationContext
      description: Queries active CalculationContext instances for debugging purposes
      operationId: queryCalculationContext
      parameters:
      - name: rootfreid
        in: query
        description: Only return CalculationContext instances, associated with the given root FRE ID
        style: form
        explode: true
        schema:
          type: string
      - name: calculation
        in: query
        description: Only return CalculationContext instances, created by the given Calculation
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calculationContexts'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
  /pmprocessor/api/v1/thresholds:
    get:
      tags:
      - Thresholds
      summary: getAllThresholds
      description: Retrieve all persisted thresholds
      operationId: getAllThresholds
      parameters: []
      responses:
        '200':
          description: Successfully retrieved all thresholds
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/thresholds'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    put:
      tags:
      - Thresholds
      summary: updateThreshold
      description: Update threshold(s)
      operationId: updateThreshold
      parameters: []
      requestBody:
        description: The new threshold(s)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/thresholds'
              - description: The new threshold(s)
                example:
                  data:
                  - attributes:
                      action:
                        alarmAlert:
                          severity: MINOR
                      maxValue:
                        value: 10.5
                      name: My threshold
                      pmParameter: fiberloss
                      tags:
                        granularityNative: 15-MIN
                      thresholdType: max
                    id: 0911c8ff-07e7-43dd-96f2-b2bdb3f987ad
                    type: threshold
            example:
              data:
              - attributes:
                  action:
                    alarmAlert:
                      severity: MINOR
                  maxValue:
                    value: 10.5
                  name: My threshold
                  pmParameter: fiberloss
                  tags:
                    granularityNative: 15-MIN
                  thresholdType: max
                id: 0911c8ff-07e7-43dd-96f2-b2bdb3f987ad
                type: threshold
        required: true
      responses:
        '202':
          description: Threshold update request accepted with primary validation successful
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    post:
      tags:
      - Thresholds
      summary: createThreshold
      description: Create a PM threshold and define an alarm for when threshold is violated. All thresholds must be valid for the creation to occur
      operationId: createThreshold
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/thresholdsNoID'
              - example:
                  data:
                  - attributes:
                      action:
                        alarmAlert:
                          severity: MINOR
                      maxValue:
                        value: 10.5
                      name: My threshold
                      pmParameter: fiberloss
                      tags:
                        granularityNative: 15-MIN
                      thresholdType: max
                    type: threshold
            example:
              data:
              - attributes:
                  action:
                    alarmAlert:
                      severity: MINOR
                  maxValue:
                    value: 10.5
                  name: My threshold
                  pmParameter: fiberloss
                  tags:
                    granularityNative: 15-MIN
                  thresholdType: max
                type: threshold
        required: true
      responses:
        '202':
          description: Threshold creation request accepted with primary validation successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/thresholds'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
  /pmprocessor/api/v1/thresholds/{thresholdId}:
    get:
      tags:
      - Thresholds
      summary: getThresholdById
      description: Retrieve a specfic threshold by ID
      operationId: getThresholdById
      parameters:
      - name: thresholdId
        in: path
        description: ID of the threshold to retrieve
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved specified threshold
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/threshold'
        '404':
          description: Threshold not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    put:
      tags:
      - Thresholds
      summary: updateThresholdById
      description: Update a specific threshold by ID
      operationId: updateThresholdById
      parameters:
      - name: thresholdId
        in: path
        description: ID of the threshold to retrieve
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new threshold
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/threshold'
              - description: The new threshold
                example:
                  data:
                    attributes:
                      action:
                        alarmAlert:
                          severity: MINOR
                      maxValue:
                        value: 10.5
                      name: My threshold
                      pmParameter: fiberloss
                      tags:
                        granularityNative: 15-MIN
                      thresholdType: max
                    id: 0911c8ff-07e7-43dd-96f2-b2bdb3f987ad
                    type: threshold
            example:
              data:
                attributes:
                  action:
                    alarmAlert:
                      severity: MINOR
                  maxValue:
                    value: 10.5
                  name: My threshold
                  pmParameter: fiberloss
                  tags:
                    granularityNative: 15-MIN
                  thresholdType: max
                id: 0911c8ff-07e7-43dd-96f2-b2bdb3f987ad
                type: threshold
        required: true
      responses:
        '202':
          description: Threshold update request accepted with primary validation successful
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '409':
          description: Conflicting IDs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    delete:
      tags:
      - Thresholds
      summary: deleteThresholdById
      description: Delete a specific threshold, the deleted threshold is removed from all threshold groups.
      operationId: deleteThresholdById
      parameters:
      - name: thresholdId
        in: path
        description: ID of the threshold to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: Threshold delete request accepted with primary validation successful
          headers: {}
          content: {}
        '404':
          description: Threshold not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
  /pmprocessor/api/v1/threshold_groups:
    get:
      tags:
      - Threshold Groups
      summary: getAllThresholdGroups
      description: Retrieve all persisted threshold groups
      operationId: getAllThresholdGroups
      parameters: []
      responses:
        '200':
          description: Successfully retrieved all threshold groups
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/thresholdGroups'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    put:
      tags:
      - Threshold Groups
      summary: updateThresholdGroup
      description: Update one or more threshold groups
      operationId: updateThresholdGroup
      parameters: []
      requestBody:
        description: The new threshold group(s)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/thresholdGroups'
              - description: The new threshold group(s)
                example:
                  data:
                  - attributes:
                      thresholdId:
                      - threshold_id_1
                      - threshold_id_2
                    id: Troubleshoot
                    type: thresholdGroup
            example:
              data:
              - attributes:
                  thresholdId:
                  - threshold_id_1
                  - threshold_id_2
                id: Troubleshoot
                type: thresholdGroup
        required: true
      responses:
        '202':
          description: Threshold group(s) update request accepted with primary validation successful
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold group not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    post:
      tags:
      - Threshold Groups
      summary: createThresholdGroup
      description: Create a PM threshold group with one or more pre-existing thresholds for association with a resource profile
      operationId: createThresholdGroup
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/thresholdGroups'
              - example:
                  data:
                  - attributes:
                      thresholdId:
                      - threshold_id_1
                      - threshold_id_2
                    id: Troubleshoot
                    type: thresholdGroup
            example:
              data:
              - attributes:
                  thresholdId:
                  - threshold_id_1
                  - threshold_id_2
                id: Troubleshoot
                type: thresholdGroup
        required: true
      responses:
        '202':
          description: Threshold group(s) create request accepted with primary validation successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/thresholdGroups'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold for group not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '409':
          description: Threshold group already exists
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
  /pmprocessor/api/v1/threshold_groups/{thresholdGroupId}:
    get:
      tags:
      - Threshold Groups
      summary: getThresholdGroupById
      description: Retrieve a specfic threshold group by ID
      operationId: getThresholdGroupById
      parameters:
      - name: thresholdGroupId
        in: path
        description: ID of the threshold group to retrieve
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved specified threshold group
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/thresholdGroup'
        '404':
          description: Threshold group not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    put:
      tags:
      - Threshold Groups
      summary: updateThresholdGroupById
      description: Update a specific threshold group by ID
      operationId: updateThresholdGroupById
      parameters:
      - name: thresholdGroupId
        in: path
        description: ID of the threshold group to retrieve
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new threshold group
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/thresholdGroup'
              - description: The new threshold group
                example:
                  data:
                    attributes:
                      thresholdId:
                      - threshold_id_1
                      - threshold_id_2
                    id: Troubleshoot
                    type: thresholdGroup
            example:
              data:
                attributes:
                  thresholdId:
                  - threshold_id_1
                  - threshold_id_2
                id: Troubleshoot
                type: thresholdGroup
        required: true
      responses:
        '202':
          description: Threshold group update request accepted with primary validation successful
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold group not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '409':
          description: Conflicting IDs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    delete:
      tags:
      - Threshold Groups
      summary: deleteThresholdGroupById
      description: Delete a threshold group by ID
      operationId: deleteThresholdGroupById
      parameters:
      - name: thresholdGroupId
        in: path
        description: ID of the threshold group to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: Threshold group delete request accepted with primary validation successful
          headers: {}
          content: {}
        '404':
          description: Threshold group not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
  /pmprocessor/api/v1/resource_profiles:
    get:
      tags:
      - Resource Profiles
      summary: getAllResourceProfiles
      description: Retrieve all resource profiles
      operationId: getAllResourceProfiles
      parameters: []
      responses:
        '200':
          description: Successfully retrieved all resource profiles
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/resourceProfiles'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    put:
      tags:
      - Resource Profiles
      summary: updateResourceProfile
      description: Update one or more resource profiles
      operationId: updateResourceProfile
      parameters: []
      requestBody:
        description: The new resource profile
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/resourceProfiles'
              - description: The new resource profile
        required: true
      responses:
        '202':
          description: Resource profile(s) update request accepted with primary validation successful
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold group not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    post:
      tags:
      - Resource Profiles
      summary: createResourceProfile
      description: Create a resource profile with one or more resources for association with one or more pre-existing threshold groups
      operationId: createResourceProfile
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resourceProfiles'
        required: true
      responses:
        '202':
          description: Resource profile create request accepted with primary validation successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/resourceProfiles'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold group for profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '409':
          description: Resource profile already exists
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
  /pmprocessor/api/v1/resource_profiles/{resourceProfileId}:
    get:
      tags:
      - Resource Profiles
      summary: getResourceProfileById
      description: Retrieve a specfic resource profile by ID
      operationId: getResourceProfileById
      parameters:
      - name: resourceProfileId
        in: path
        description: ID of the resource profile to retrieve
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved specified resource profile
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/resourceProfile'
        '404':
          description: Resource profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    put:
      tags:
      - Resource Profiles
      summary: updateResourceProfileById
      description: Update a specific resource profile by ID
      operationId: updateResourceProfileById
      parameters:
      - name: resourceProfileId
        in: path
        description: ID of the resource profile to retrieve
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new resource profile
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/resourceProfile'
              - description: The new resource profile
        required: true
      responses:
        '202':
          description: Resource profile update request accepted with primary validation successful
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '404':
          description: Threshold group not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '409':
          description: Conflicting IDs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
    delete:
      tags:
      - Resource Profiles
      summary: deleteResourceProfileById
      description: Delete a resource profile by ID
      operationId: deleteResourceProfileById
      parameters:
      - name: resourceProfileId
        in: path
        description: ID of the resource profile to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: Resource profile delete request accepted with primary validation successful
          headers: {}
          content: {}
        '404':
          description: Resource profile not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/pmProcessorError'
      deprecated: false
  /bpocore/policies/api/v1/conditions/{conditionId}:
    get:
      tags:
      - conditions
      summary: GetCondition
      description: Get a condition by condition id
      operationId: GetCondition
      parameters:
      - name: conditionId
        in: path
        description: Identifier of the condition
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Condition'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Condition'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - conditions
      summary: DeleteCondition
      description: Delete a condition from the policies database
      operationId: DeleteCondition
      parameters:
      - name: conditionId
        in: path
        description: Identifier of the condition to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/conditions:
    get:
      tags:
      - conditions
      summary: ListConditions
      description: List all of the conditions defined in the Policy Manager
      operationId: ListConditions
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply26'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply26'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - conditions
      summary: CreateCondition
      description: Create a new condition that may be used in policies
      operationId: CreateCondition
      parameters: []
      requestBody:
        description: Specification defining a condition
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocorePoliciesApiV1ConditionsRequest'
              - description: Specification defining a condition
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Condition'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Condition'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/conditions/count:
    get:
      tags:
      - conditions
      summary: CountConditions
      description: Count conditions defined in the Policy Manager
      operationId: CountConditions
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/conditions/tenants/{tenantId}/conditions:
    get:
      tags:
      - conditions
      summary: ListConditionsByTenantId
      description: List all of the conditions defined for a specific tenant
      operationId: ListConditionsByTenantId
      parameters:
      - name: tenantId
        in: path
        description: Identifier of the tenant
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply26'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply26'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/conditions/tenants/{tenantId}/conditions/count:
    get:
      tags:
      - conditions
      summary: CountConditionsByTenantId
      description: Count the conditions defined for a specific tenant
      operationId: CountConditionsByTenantId
      parameters:
      - name: tenantId
        in: path
        description: Identifier of the tenant
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/policies:
    get:
      tags:
      - policies
      summary: ListPolicies
      description: List all of the policies defined in the Policy Manager
      operationId: ListPolicies
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply25'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply25'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - policies
      summary: CreatePolicy
      description: Create a policy in the policies
      operationId: CreatePolicy
      parameters: []
      requestBody:
        description: Specification defining a policy
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocorePoliciesApiV1PoliciesRequest'
              - description: Specification defining a policy
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Policy2'
                - description: A description of a single policy
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Policy2'
                - description: A description of a single policy
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/policies/tenants/{tenantId}/policies/count:
    get:
      tags:
      - policies
      summary: CountPoliciesByTenantId
      description: Count the policies defined for a specific tenant
      operationId: CountPoliciesByTenantId
      parameters:
      - name: tenantId
        in: path
        description: Identifier of the tenant
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/policies/{policyId}:
    get:
      tags:
      - policies
      summary: GetPolicy
      description: Get a policy by policy id
      operationId: GetPolicy
      parameters:
      - name: policyId
        in: path
        description: Identifier of the policy
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Policy2'
                - description: A description of a single policy
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Policy2'
                - description: A description of a single policy
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - policies
      summary: DeletePolicy
      description: Delete a policy from the policies
      operationId: DeletePolicy
      parameters:
      - name: policyId
        in: path
        description: Identifier of the policy to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/policies/count:
    get:
      tags:
      - policies
      summary: CountPolicies
      description: Count policies defined in the Policy Manager
      operationId: CountPolicies
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/policies/tenants/{tenantId}/policies:
    get:
      tags:
      - policies
      summary: ListPoliciesByTenantId
      description: List all of the policies defined for a specific tenant
      operationId: ListPoliciesByTenantId
      parameters:
      - name: tenantId
        in: path
        description: Identifier of the tenant
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply25'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply25'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/realms:
    get:
      tags:
      - realms
      summary: ListRealms
      description: List all of the realms defined in the Policy Manager
      operationId: ListRealms
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Requested offset within the total result set to be the first element in the paged response
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: The maximum number of elements to return in a single paged request
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1000
      - name: pageToken
        in: query
        description: >-
          String pagination token returned from a previous query that encodes query information in order to optimize a

          subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or

          both can be included to override the encoded values
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReply27'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ListReply27'
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - realms
      summary: CreateRealm
      description: Create a realm in the policies database
      operationId: CreateRealm
      parameters: []
      requestBody:
        description: Specification defining a realm (name is used as the identification for this realm)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BpocorePoliciesApiV1RealmsRequest'
              - description: Specification defining a realm (name is used as the identification for this realm)
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuthRealm'
                - description: A description of a single authorization realm
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuthRealm'
                - description: A description of a single authorization realm
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '409':
          description: Conflict
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/realms/count:
    get:
      tags:
      - realms
      summary: CountRealms
      description: Count realms defined in the Policy Manager
      operationId: CountRealms
      parameters:
      - name: q
        in: query
        description: Optional query parameter to define a query filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: p
        in: query
        description: Optional query parameter to define a partial string match filter using property:value syntax
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Optional parameter indicating maximum number to count. If the actual number is greater than the specified limit, the result will be shown as bounded.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Count'
                - description: Information describing count result
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /bpocore/policies/api/v1/realms/{realmName}:
    get:
      tags:
      - realms
      summary: GetRealm
      description: Get a realm by realm name
      operationId: GetRealm
      parameters:
      - name: realmName
        in: path
        description: Name of the Realm
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuthRealm'
                - description: A description of a single authorization realm
            application/yang-data+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AuthRealm'
                - description: A description of a single authorization realm
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - realms
      summary: DeleteRealm
      description: Delete a realm from the policies database
      operationId: DeleteRealm
      parameters:
      - name: realmName
        in: path
        description: Identifier(name) of the realm to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
        '503':
          description: Service Unavailable
          headers: {}
          content: {}
      deprecated: false
  /nsi/api/tpes:
    get:
      tags:
      - 000 - nsiapitpes
      summary: getTpes
      description: '<p>LATEST VERSION: V6<p>Only one of the following parameters must be specified:<ul><li>networkConstruct.id<li>tpeExpectations.equipmentIntent.id<li>tpeExpectations.serviceIntent.id<li>equipmentId<li>id<li>concrete</ul>'
      operationId: getTpes
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of TPE identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: location
        in: query
        description: (Optional) TPE location - shelf-slot-port or slot-port or port. Only applied when Network Construct identifier is provided.
        style: form
        explode: true
        schema:
          type: string
      - name: locationFormat
        in: query
        description: (Optional) Format for the given location; when not given, assume location is [[shelf-]slot-]port. Only applied when Network Construct identifier is provided.
        style: form
        explode: true
        schema:
          type: string
      - name: structureType
        in: query
        description: (Optional) TPE structure type. Only applied when Network Construct identifier is provided.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentId
        in: query
        description: (Optional) Equipment identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete tpe
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.intent.id
        in: query
        description: (Optional) The intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: content
        in: query
        description: (Optional) The TPE content level
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content1'
          - description: (Optional) The TPE content level
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 TPEs at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, tpePlanned, tpeDiscovered, concrete, srlgs'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 000 - nsiapitpes
      summary: postTpe
      description: >-
        <p>LATEST VERSION: V6<p>This REST API is intended to be used by service provisioning micro-service IFD only to create a TPE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>structureType<li>location - management protocol used to retrieve the information and the location of the TPE such as its shelf, slot and port<li>network construct id relationship<li>equipment id relationship if available<li>a list of TPE expectation id relationship<li>the TPE expectation content - specified in the included section<ul><li>layerTerminations, stackDirection, etc.<li>validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "tpeId",
            "type": "tpes",
            "attributes": {
              "structureType": "PTP",
              "locations": [
                {
                  "managementType": "tl1",
                  "shelf": "12",
                  "slot": "11",
                  "port": "1"
                }
              ],
              "userData": {
                "userDataLocation": "Ottawa"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "nodalId": "nodalId"        }
              ]
            },
            "relationships": {
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                }
              },
              "equipment": {
                "data": {
                  "type": "equipment",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11"
                }
              },
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "tpeExpId"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "tpeExpId",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional",
                "validateParameters": {
                  "include": "stackDirection"
                },
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postTpe
      parameters: []
      requestBody:
        description: TPE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: TPE to create or update
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created the TPEResource. The response only contains the identifiers of the created TPEResource
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/trailtrace:
    post:
      tags:
      - 000 - nsiapitpes
      summary: postTpeTti
      description: >-
        This REST API is intended to be used by TAPI to get TTI snapshot from RA. <p>The following attributes should be specified in the post request:<ul><li>resourceId - TPE ID<li>trailTraceType <p>The response will have resource ID and TTI attributes.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "resourceId": "fe623a1a-d15f-3f5a-a216-be4137b6e9f6::TPE_fe623a1a-d15f-3f5a-a216-be4137b6e9f6::EQPT_8_5_1-PTP",
            "trailTraceType": "section"
        }

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postTpeTti
      parameters: []
      requestBody:
        description: TPE resourceId to get TTI snapshot
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeTtiPostDataRO'
              - description: TPE resourceId to get TTI snapshot
        required: false
      responses:
        '200':
          description: Successfully got the TTI Snapshot. The response contains the resourceId of the requested TPE and TTI snapshot
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeTtiSnapshotRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{id}/identifiers:
    put:
      tags:
      - 000 - nsiapitpes
      summary: updateTpeIdentifier
      description: >-
        <p>LATEST VERSION: V4<p>This REST API is used to update/create an identifier on a TPE<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
           "key1": "value1",
           "key2": "value2"
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: updateTpeIdentifier
      parameters:
      - name: id
        in: path
        description: The TPE id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The identifier JSON object
        content:
          application/json:
            schema:
              type: object
              description: The identifier JSON object
        required: true
      responses:
        '200':
          description: Successfully updated the TPE identifier for a given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created a new TPE identifier for the given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapitpes
      summary: deleteTpeIdentifier
      description: '<p>LATEST VERSION: V4'
      operationId: deleteTpeIdentifier
      parameters:
      - name: id
        in: path
        description: The TPE id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Successfully updated the TPE identifier for a given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created a new TPE identifier for the given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}:
    get:
      tags:
      - 000 - nsiapitpes
      summary: getTpe
      description: '<p>LATEST VERSION: V4'
      operationId: getTpe
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded.  The allowed values are: expectations, tpePlanned, tpeDiscovered,srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - 000 - nsiapitpes
      summary: putTpeById
      description: >-
        <p>LATEST VERSION: V5<p>This REST end point is used to either create the TPE object if it doesn't exist already,<p>or updates the TPE object if it exists.<br><p>There are some attributes that cannot be changed, but can be given in a rest call<p>as long as they match the what is in the database. These attributes are:<ul><li>id<li>networkConstruct.id<li>equipment.id<li>location<li>structureType</ul><p>The response holds the new TPE with the new attributes<p>Here is an example TPE that can be in a request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
            "type": "tpes",
            "attributes": {
              "userData": {
                "userDataLocation": "Ottawa"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "nodalId": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"        }
              ],
              "cardType": "cardType",
              "state": "IS",
              "userLabel": "my-tpe",    },
            "relationships": {
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: putTpeById
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new TPE data.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: The new TPE data.
        required: true
      responses:
        '200':
          description: TPE has been successfully updated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: TPE has been successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to update TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapitpes
      summary: deleteTpeById
      description: 'This operation is allowed for a root or actual TPEResource entity.<p>LATEST VERSION: V3'
      operationId: deleteTpeById
      parameters:
      - name: tpeId
        in: path
        description: TPEResource identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The de-provisioning request was sent or TPEResource is deleted successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '204':
          description: TPEResource does not exist.
          headers: {}
          content: {}
        '400':
          description: The specified TPEResource has expectations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPEResource
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete TPEResource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/expectations:
    post:
      tags:
      - 000 - nsiapitpes
      summary: PostpostExpectation1
      description: '<p>LATEST VERSION: V4<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PostpostExpectation1
      parameters:
      - name: tpeId
        in: path
        description: TPEResource identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: TPEExpectation to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeExpectationRO'
              - description: TPEExpectation to create or update
        required: false
      responses:
        '200':
          description: An existing TPE expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '201':
          description: TPE expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPEResource
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified TPE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/expectations/{expectationId}/realize:
    post:
      tags:
      - 000 - nsiapitpes
      summary: provisionOperations
      description: >-
        <p>LATEST VERSION: V3

        If TPE is not realized, it will trigger a create provisioning operation, otherwise it will trigger a update provisioning operation to change the current discovered data.
      operationId: provisionOperations
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: TpeExpectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Request to provision was sent successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Provisioning request failed against TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/expectations/{tpeExpectationId}:
    patch:
      tags:
      - 000 - nsiapitpes
      summary: patchTpeExpectation
      description: >-
        <p>LATEST VERSION: V3</p>

        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "srlg": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        }

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchTpeExpectation
      parameters:
      - name: tpeId
        in: path
        description: The id of the Tpe to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: tpeExpectationId
        in: path
        description: The id of the tpeExpectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Tpe.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpePatchRO'
              - description: A patch request to the given Tpe.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/suppressionPort:
    put:
      tags:
      - 000 - nsiapitpes
      summary: putTpeSuppressionPort
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putTpeSuppressionPort
      parameters:
      - name: tpeId
        in: path
        description: Identifier of TPE under which to set the alarm suppression value
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired port suppression value
        content:
          text/plain:
            schema:
              type: string
              description: The desired port suppression value
        required: true
      responses:
        '200':
          description: TPE alarm suppression has been updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: TPE alarm suppression has been created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The TPE with that id doesn't exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/tpeExpectations:
    get:
      tags:
      - 000 - nsiapitpes
      summary: getTpeExpectations
      description: '<p>LATEST VERSION: V2_0'
      operationId: getTpeExpectations
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationListRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested TPE can't be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve TPE expectations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/tpeExpectations/{tpeExpectationId}:
    get:
      tags:
      - 000 - nsiapitpes
      summary: getTpeExpectation
      description: '<p>LATEST VERSION: V2_0'
      operationId: getTpeExpectation
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: tpeExpectationId
        in: path
        description: TPE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the TPE expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the TPE expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapitpes
      summary: deleteTpeExpectation
      description: '<p>LATEST VERSION: V3'
      operationId: deleteTpeExpectation
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: tpeExpectationId
        in: path
        description: TPE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Delete TPE Expectations with given id successfully.
          headers: {}
          content: {}
        '204':
          description: TPE Expectation does not exist.
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: TPE does not exist.
          headers: {}
          content: {}
        '500':
          description: Failed to delete TPE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/tpePlanned:
    get:
      tags:
      - 000 - nsiapitpes
      summary: getTpePlanned
      description: '<p>LATEST VERSION: V3'
      operationId: getTpePlanned
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE Planned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpePlannedRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    put:
      tags:
      - 000 - nsiapitpes
      summary: putTpePlanned
      description: '<p>LATEST VERSION: V3'
      operationId: putTpePlanned
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Planned TPE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpePlannedRO'
              - description: Planned TPE to create or update
        required: false
      responses:
        '200':
          description: Planned TPE has been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '201':
          description: Planned TPE has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified TPE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 000 - nsiapitpes
      summary: patchPlannedTpe
      description: >-
        <p>LATEST VERSION: V4</p>

        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchPlannedTpe
      parameters:
      - name: tpeId
        in: path
        description: The id of the TPE to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given TPE.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpePatchRO'
              - description: A patch request to the given TPE.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpePlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/tpes/{tpeId}/userData/{userDataKey}:
    put:
      tags:
      - 000 - nsiapitpes
      summary: putTpeUserData
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putTpeUserData
      parameters:
      - name: tpeId
        in: path
        description: Identifier of TPE under which to create or update the UserData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: true
      responses:
        '200':
          description: TPE user data has been updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: TPE user data has been created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The TPE with that id doesn't exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapitpes
      summary: deleteTpeUserData
      description: '<p>LATEST VERSION: V3'
      operationId: deleteTpeUserData
      parameters:
      - name: tpeId
        in: path
        description: Identifier to TPE under which to create or update the userData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: The userData key that will be used to delete the potential value
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted the userData with the given id
          headers: {}
          content: {}
        '204':
          description: The specified TPE userData does not exist
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Could not find the TPE with the specified id, or could not find the userData key
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v6/tpes:
    get:
      tags:
      - 994 - nsiapiv6tpes
      summary: getTpesV6
      description: <p>Only one of the following parameters must be specified:<ul><li>networkConstruct.id<li>tpeExpectations.equipmentIntent.id<li>tpeExpectations.serviceIntent.id<li>equipmentId<li>id<li>concrete</ul>
      operationId: getTpesV6
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of TPE identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: location
        in: query
        description: (Optional) TPE location - shelf-slot-port or slot-port or port. Only applied when Network Construct identifier is provided.
        style: form
        explode: true
        schema:
          type: string
      - name: locationFormat
        in: query
        description: (Optional) Format for the given location; when not given, assume location is [[shelf-]slot-]port. Only applied when Network Construct identifier is provided.
        style: form
        explode: true
        schema:
          type: string
      - name: structureType
        in: query
        description: (Optional) TPE structure type. Only applied when Network Construct identifier is provided.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentId
        in: query
        description: (Optional) Equipment identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete tpe
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.intent.id
        in: query
        description: (Optional) The intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: content
        in: query
        description: (Optional) The TPE content level
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content1'
          - description: (Optional) The TPE content level
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted to return 30 TPEs at once.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, tpePlanned, tpeDiscovered, concrete'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 994 - nsiapiv6tpes
      summary: PostpostTpe
      description: >-
        This REST API is intended to be used by service provisioning micro-service IFD only to create a TPE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>structureType<li>location - management protocol used to retrieve the information and the location of the TPE such as its shelf, slot and port<li>network construct id relationship<li>equipment id relationship if available<li>a list of TPE expectation id relationship<li>the TPE expectation content - specified in the included section<ul><li>layerTerminations, stackDirection, etc.<li>validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
            "type": "tpes",
            "attributes": {
              "userData": {
                "userDataLocation": "Ottawa"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "nodalId": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"        }
              ]
            },
            "relationships": {
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                  }
                ]
              }
            },
            "tpePlanned": {
                "data": {
                  "type": "tpePlanned",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                }
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            },
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
              "type": "tpePlanned",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                },
                "networkConstruct": {
                  "data": {
                    "type": "networkConstructs",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostTpe
      parameters: []
      requestBody:
        description: TPE to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: TPE to create
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created the TPE. The response only contains the identifiers of the created TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v6/tpes/trailtrace:
    post:
      tags:
      - 994 - nsiapiv6tpes
      summary: PostpostTpeTti
      description: >-
        This REST API is intended to be used by TAPI to get TTI snapshot from RA. <p>The following attributes should be specified in the post request:<ul><li>resourceId - TPE ID<li>trailTraceType <p>The response will have resource ID and TTI attributes.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "resourceId": "fe623a1a-d15f-3f5a-a216-be4137b6e9f6::TPE_fe623a1a-d15f-3f5a-a216-be4137b6e9f6::EQPT_8_5_1-PTP",
            "trailTraceType": "section"
        }

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostTpeTti
      parameters: []
      requestBody:
        description: TPE resourceId to get TTI snapshot
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeTtiPostDataRO'
              - description: TPE resourceId to get TTI snapshot
        required: false
      responses:
        '200':
          description: Successfully got the TTI Snapshot. The response contains the resourceId of the requested TPE and TTI snapshot
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeTtiSnapshotRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v6/tpes/{tpeId}/suppressionPort:
    put:
      tags:
      - 994 - nsiapiv6tpes
      summary: PutputTpeSuppressionPort
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutputTpeSuppressionPort
      parameters:
      - name: tpeId
        in: path
        description: Identifier of TPE under which to set the alarm suppression value
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired alarm suppression value
        content:
          text/plain:
            schema:
              type: string
              description: The desired alarm suppression value
        required: true
      responses:
        '200':
          description: TPE alarm suppression has been updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: TPE alarm suppression has been created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The TPE with that id doesn't exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v5/tpes:
    get:
      tags:
      - 995 - nsiapiv5tpes
      summary: getTpesV5
      description: <p>Only one of the following parameters must be specified:<ul><li>networkConstruct.id<li>tpeExpectations.equipmentIntent.id<li>tpeExpectations.serviceIntent.id<li>equipmentId<li>id<li>concrete</ul>
      operationId: getTpesV5
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of TPE identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentId
        in: query
        description: (Optional) Equipment identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete tpe
        style: form
        explode: true
        schema:
          type: string
      - name: content
        in: query
        description: (Optional) The TPE content level
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content1'
          - description: (Optional) The TPE content level
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted ALL to return all TPEs at once.
        style: form
        explode: true
        schema:
          type: string
          default: ALL
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, tpePlanned, tpeDiscovered, concrete, srlgs'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    post:
      tags:
      - 995 - nsiapiv5tpes
      summary: PostpostTpe1
      description: >-
        This REST API is intended to be used by service provisioning micro-service IFD only to create a TPE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>structureType<li>location - management protocol used to retrieve the information and the location of the TPE such as its shelf, slot and port<li>network construct id relationship<li>equipment id relationship if available<li>a list of TPE expectation id relationship<li>the TPE expectation content - specified in the included section<ul><li>layerTerminations, stackDirection, etc.<li>validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
            "type": "tpes",
            "attributes": {
              "userData": {
                "ossLabel": "ossLabel"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "ossLabel": "ossLabel"        }
              ]
            },
            "relationships": {
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                  }
                ]
              }
            },
            "tpePlanned": {
                "data": {
                  "type": "tpePlanned",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                }
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            },
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
              "type": "tpePlanned",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                },
                "networkConstruct": {
                  "data": {
                    "type": "networkConstructs",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostTpe1
      parameters: []
      requestBody:
        description: TPE to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: TPE to create
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created the TPE. The response only contains the identifiers of the created TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v5/tpes/{tpeId}:
    put:
      tags:
      - 995 - nsiapiv5tpes
      summary: PutputTpeById
      description: >-
        This REST end point is used to either create the TPE object if it doesn't exist already,<p>or updates the TPE object if it exists.<br><p>There are some attributes that cannot be changed, but can be given in a rest call<p>as long as they match the what is in the database. These attributes are:<ul><li>id<li>networkConstruct.id<li>equipment.id<li>location<li>structureType</ul><p>The response holds the new TPE with the new attributes<p>Here is an example TPE that can be in a request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
            "type": "tpes",
            "attributes": {
              "userData": {
                "userDataLocation": "Ottawa"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "nodalId": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"        }
              ]
            },
            "relationships": {
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                  }
                ]
              }
            },
            "tpePlanned": {
                "data": {
                  "type": "tpePlanned",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                }
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            },
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
              "type": "tpePlanned",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                },
                "networkConstruct": {
                  "data": {
                    "type": "networkConstructs",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PutputTpeById
      parameters:
      - name: tpeId
        in: path
        description: The TPE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The TpeRO object to be used to update the DB object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: The TpeRO object to be used to update the DB object
        required: false
      responses:
        '200':
          description: TPE has been successfully updated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: TPE has been successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
      deprecated: false
  /nsi/api/v4/tpes:
    get:
      tags:
      - 996 - nsiapiv4tpes
      summary: GetgetTpes
      description: '<p>The following search paths are not supported for the searchFields query parameter:<ul><li>data.attributes.tpeSpec<li>data.attributes.tpeGroupSpecs<li>data.attributes.locations.loc_oid<li>data.attributes.capacityReservations.*<li>data.attributes.syncScopes.*<li>data.relationships.networkConstructAssociation.data.id</ul><p>Specifying a path for the searchFields parameter of an attribute in the following objects will search the parent object for the value specified in searchText: adjacencyPackage, powerPackage, photonicSpectrumPackage, and signalIndex.<p>To specify an expectation path for the searchFields parameter use the prefix "data.relationships.tpeExpectations.data.*"'
      operationId: GetgetTpes
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of TPE identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search on. If none are specified, all supported fields are implied. Fields require full path (e.g. data.attributes.name) Fields not supported under this filter are `data.attributes.layerTerminations.layerProtocol.*`
        style: form
        explode: true
        schema:
          type: string
      - name: resourceState
        in: query
        description: '(Optional) List of networkConstruct planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: portsL2AvailableAll, portsL2ApplicableEPLUni, portsL2ApplicableEVPLUni, portsL2ApplicableEnni, portsL2ApplicableEPLUniWithMcLag, portsL2ApplicableEVPLUniWithMcLag, portsL2ApplicableEnniWithMcLag, portsTunnelsL2ApplicableAll, portsTDMCEApplicableAll'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: (Optional) The comma separated identifier key set
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: (Optional) The comma separated identifier value set
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete tpe
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: bookingData.lockout
        in: query
        description: (Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/bookingData.lockout1'
          - description: (Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed
      - name: active
        in: query
        description: (Optional) The active state of the resource
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/active1'
          - description: (Optional) The active state of the resource
      - name: content
        in: query
        description: (Optional) The TPE content level
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content1'
          - description: (Optional) The TPE content level
      - name: location
        in: query
        description: (Optional) TPE location delimited by dashes
        style: form
        explode: true
        schema:
          type: string
      - name: locationFormat
        in: query
        description: (Optional) Format for the given location; when not given, assume location is [[shelf-]slot-]port
        style: form
        explode: true
        schema:
          type: string
      - name: structureType
        in: query
        description: (Optional) Comma separated list of TPE structure types
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentId
        in: query
        description: (Optional) Equipment identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: gneSubnetName
        in: query
        description: (Optional) GNE Subnet name of the TPE
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: metaDataFields
        in: query
        description: '(Optional) List of meta data to be included. The allowed values are: stackDirection, layerRate, state, cardType, structureType, structureSubType, resourceState'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, concrete, networkConstructs'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 996 - nsiapiv4tpes
      summary: PostpostTpe2
      description: >-
        This REST API is intended to be used by service provisioning micro-service IFD only to create a TPE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>structureType<li>location - management protocol used to retrieve the information and the location of the TPE such as its shelf, slot and port<li>network construct id relationship<li>equipment id relationship if available<li>a list of TPE expectation id relationship<li>the TPE expectation content - specified in the included section<ul><li>layerTerminations, stackDirection, etc.<li>validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "tpeId",
            "type": "tpes",
            "attributes": {
              "structureType": "PTP",
              "locations": [
                {
                  "managementType": "tl1",
                  "shelf": "12",
                  "slot": "11",
                  "port": "1"
                }
              ],
              "userData": {
                "ossLabel": "ossLabel"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "ossLabel": "ossLabel"        }
              ]
            },
            "relationships": {
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                }
              },
              "equipment": {
                "data": {
                  "type": "equipment",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11"
                }
              },
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "tpeExpId"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "tpeExpId",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional",
                "validateParameters": {
                  "include": "stackDirection"
                },
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostTpe2
      parameters: []
      requestBody:
        description: TPE to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: TPE to create
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created the TPE. The response only contains the identifiers of the created TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v4/tpes/{id}/identifiers:
    put:
      tags:
      - 996 - nsiapiv4tpes
      summary: PutupdateTpeIdentifier
      description: >-
        This REST API is used to update/create an identifier on a TPE<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
           "key1": "value1",
           "key2": "value2"
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PutupdateTpeIdentifier
      parameters:
      - name: id
        in: path
        description: The TPE id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The identifier JSON object
        content:
          application/json:
            schema:
              type: object
              description: The identifier JSON object
        required: true
      responses:
        '200':
          description: Successfully updated the TPE identifier for a given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created a new TPE identifier for the given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 996 - nsiapiv4tpes
      summary: DeletedeleteTpeIdentifier
      description: Deletes a REST identifier on a TPE
      operationId: DeletedeleteTpeIdentifier
      parameters:
      - name: id
        in: path
        description: The TPE id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Successfully updated the TPE identifier for a given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created a new TPE identifier for the given TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/tpes/{tpeId}:
    get:
      tags:
      - 996 - nsiapiv4tpes
      summary: GetgetTpe
      description: Retrieves a specific TPE
      operationId: GetgetTpe
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded.  The allowed values are: expectations, tpePlanned, tpeDiscovered, srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - 996 - nsiapiv4tpes
      summary: PutputTpeById1
      description: >-
        This REST end point is used to either create the TPE object if it doesn't exist already,<p>or updates the TPE object if it exists.<br><p>There are some attributes that cannot be changed, but can be given in a rest call<p>as long as they match the what is in the database. These attributes are:<ul><li>id<li>networkConstruct.id<li>equipment.id<li>location<li>structureType</ul><p>The response holds the new TPE with the new attributes<p>Here is an example TPE that can be in a request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
            "type": "tpes",
            "attributes": {
              "userData": {
                "ossLabel": "ossLabel"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "ossLabel": "ossLabel"        }
              ]
            },
            "relationships": {
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                  }
                ]
              }
            },
            "tpePlanned": {
                "data": {
                  "type": "tpePlanned",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                }
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            },
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
              "type": "tpePlanned",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                },
                "networkConstruct": {
                  "data": {
                    "type": "networkConstructs",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PutputTpeById1
      parameters:
      - name: tpeId
        in: path
        description: The TPE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The TpeRO object to be used to update the DB object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: The TpeRO object to be used to update the DB object
        required: false
      responses:
        '200':
          description: TPE has been successfully updated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: TPE has been successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
      deprecated: true
  /nsi/api/v4/tpes/{tpeId}/expectations:
    post:
      tags:
      - 996 - nsiapiv4tpes
      summary: PostpostExpectation2
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PostpostExpectation2
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: TPEExpectation to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeExpectationRO'
              - description: TPEExpectation to create or update
        required: false
      responses:
        '200':
          description: An existing TPE expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '201':
          description: TPE expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified TPE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/tpes/{tpeId}/tpePlanned:
    patch:
      tags:
      - 996 - nsiapiv4tpes
      summary: PatchpatchPlannedTpe
      description: >-
        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchPlannedTpe
      parameters:
      - name: tpeId
        in: path
        description: The id of the TPE to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given TPE.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpePatchRO'
              - description: A patch request to the given TPE.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpePlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/tpes:
    get:
      tags:
      - 997 - nsiapiv3tpes
      summary: GetgetTpes1
      description: <p>At least one of the following parameters must be specified:<ul><li>networkConstruct.id<li>tpeExpectations.equipmentIntent.id<li>tpeExpectations.serviceIntent.id<li>equipmentId<li>id</ul>
      operationId: GetgetTpes1
      parameters:
      - name: networkConstruct.id
        in: query
        description: (Optional) Network Construct identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: (Optional) Comma separated list of TPE identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: location
        in: query
        description: (Optional) TPE location - shelf-slot-port or slot-port or port
        style: form
        explode: true
        schema:
          type: string
      - name: structureType
        in: query
        description: (Optional) TPE structure type
        style: form
        explode: true
        schema:
          type: string
      - name: equipmentId
        in: query
        description: (Optional) Equipment identifier. In case of usage with limit parameter, paging will be enabled.
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: tpeExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: concrete
        in: query
        description: (Optional) Id of the concrete tpe
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, tpePlanned, tpeDiscovered, concrete'
        style: form
        explode: true
        schema:
          type: string
      - name: content
        in: query
        description: (Optional) The TPE content level
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/content1'
          - description: (Optional) The TPE content level
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. Defaulted ALL to return all TPEs at once.
        style: form
        explode: true
        schema:
          type: string
          default: ALL
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested TPEs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 997 - nsiapiv3tpes
      summary: PostpostTpe3
      description: >-
        This REST API is intended to be used by service provisioning micro-service IFD only to create a TPE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>structureType<li>location - management protocol used to retrieve the information and the location of the TPE such as its shelf, slot and port<li>network construct id relationship<li>equipment id relationship if available<li>a list of TPE expectation id relationship<li>the TPE expectation content - specified in the included section<ul><li>layerTerminations, stackDirection, etc.<li>equipment or service intent id relationship</ul></ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP",
            "type": "tpes",
            "attributes": {
              "structureType": "PTP",
              "locations": [
                {
                  "managementType": "tl1",
                  "shelf": "12",
                  "slot": "11",
                  "port": "1"
                }
              ],
              "userData": {
                "ossLabel": "ossLabel"
              },
              "identifiers": [
                {
                  "ncId": "aca92325-0c37-45b4-815d-df8c2c4e7da8",
                  "ossLabel": "ossLabel"        }
              ]
            },
            "relationships": {
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8"
                }
              },
              "equipment": {
                "data": {
                  "type": "equipment",
                  "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11"
                }
              },
              "tpeExpectations": {
                "data": [
                  {
                    "type": "tpeExpectations",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP::6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9",
              "type": "tpeExpectations",
              "attributes": {
                "layerTerminations": [
                  {
                    "layerRate": "OTU4",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "DSR",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "additionalAttributes": {
                      "MODULATION": "QPSK100G"
                    }
                  },
                  {
                    "layerRate": "OTSi",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OMS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "OTS",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated"
                  },
                  {
                    "layerRate": "PHY",
                    "structureType": "full layer fixed",
                    "terminationState": "layer termination permanently terminated",
                    "adjacencyPackage": {
                      "adjacencyType": "TXRX",
                      "localTag": "PV0428A-12-11-1",
                      "provisionedRemoteTag": "PV0428A-11-21-7",
                      "remoteTag": "PV0428A-11-21-7",
                      "topologySourceTag": "DISCOVERED"
                    }
                  }
                ],
                "stackDirection": "bidirectional"
              },
              "relationships": {
                "equipmentIntent": {
                  "data": {
                    "type": "equipmentIntents",
                    "id": "6825fda4-1e9f-4c5c-9e48-d5acb4d5b6b9"
                  }
                }
              }
            }
          ]
        }</code></pre>
      operationId: PostpostTpe3
      parameters: []
      requestBody:
        description: TPE to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeRO'
              - description: TPE to create
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: Successfully created the TPE. The response only contains the identifiers of the created TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/tpes/{tpeId}:
    get:
      tags:
      - 997 - nsiapiv3tpes
      summary: GetgetTpe1
      description: Retrieves a specific TPE
      operationId: GetgetTpe1
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded.  The allowed values are: expectations, tpePlanned, tpeDiscovered,srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    delete:
      tags:
      - 997 - nsiapiv3tpes
      summary: DeletedeleteTpeById
      description: This operation is allowed for a root or actual TPE entity.
      operationId: DeletedeleteTpeById
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The de-provisioning request was sent or TPE is deleted successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '204':
          description: TPE does not exist.
          headers: {}
          content: {}
        '400':
          description: The specified TPE has expectations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/tpes/{tpeId}/expectations:
    post:
      tags:
      - 997 - nsiapiv3tpes
      summary: PostpostExpectation3
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PostpostExpectation3
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: TPEExpectation to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpeExpectationRO'
              - description: TPEExpectation to create or update
        required: false
      responses:
        '200':
          description: An existing FRE expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '201':
          description: FRE expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/tpes/{tpeId}/expectations/{expectationId}/realize:
    post:
      tags:
      - 997 - nsiapiv3tpes
      summary: PostprovisionOperations
      description: If TPE is not realized, it will trigger a create provisioning operation, otherwise it will trigger a update provisioning operation to change the current discovered data.
      operationId: PostprovisionOperations
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: TpeExpectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Request to provision was sent successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Provisioning request failed against TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/tpes/{tpeId}/expectations/{tpeExpectationId}:
    patch:
      tags:
      - 997 - nsiapiv3tpes
      summary: PatchpatchTpeExpectation
      description: >-
        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "srlg": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        },

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchTpeExpectation
      parameters:
      - name: tpeId
        in: path
        description: The id of the Tpe to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: tpeExpectationId
        in: path
        description: The id of the tpeExpectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given Tpe.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpePatchRO'
              - description: A patch request to the given Tpe.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/tpes/{tpeId}/tpeExpectations/{tpeExpectationId}:
    delete:
      tags:
      - 997 - nsiapiv3tpes
      summary: DeletedeleteTpeExpectation
      description: Delete TPE Expectation given tpeId and expectationId
      operationId: DeletedeleteTpeExpectation
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: tpeExpectationId
        in: path
        description: TPE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Delete TPE Expectations with given id successfully.
          headers: {}
          content: {}
        '204':
          description: TPE Expectation does not exist.
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: TPE does not exist.
          headers: {}
          content: {}
        '500':
          description: Failed to delete TPE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/tpes/{tpeId}/tpePlanned:
    get:
      tags:
      - 997 - nsiapiv3tpes
      summary: GetgetTpePlanned
      description: Retrieves a specific TPE
      operationId: GetgetTpePlanned
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpePlannedRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested TPE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    put:
      tags:
      - 997 - nsiapiv3tpes
      summary: PutputTpePlanned
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutputTpePlanned
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Planned TPE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpePlannedRO'
              - description: Planned TPE to create or update
        required: false
      responses:
        '200':
          description: Planned TPE has been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '201':
          description: Planned TPE has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified TPE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 997 - nsiapiv3tpes
      summary: PatchpatchPlannedTpe1
      description: >-
        <p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchPlannedTpe1
      parameters:
      - name: tpeId
        in: path
        description: The id of the TPE to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given TPE.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TpePatchRO'
              - description: A patch request to the given TPE.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpePlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/tpes/{tpeId}/userData/{userDataKey}:
    put:
      tags:
      - 997 - nsiapiv3tpes
      summary: PutputTpeUserData
      description: Puts a new key value pair into the user data
      operationId: PutputTpeUserData
      parameters:
      - name: tpeId
        in: path
        description: Identifier of TPE under which to create or update the UserData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of the UserData to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: true
      responses:
        '200':
          description: TPE user data has been updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '201':
          description: TPE user data has been created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The TPE with that id doesn't exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3tpes
      summary: DeletedeleteTpeUserData
      description: Delete a TPEs userData key and value
      operationId: DeletedeleteTpeUserData
      parameters:
      - name: tpeId
        in: path
        description: Identifier to TPE under which to create or update the userData
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: The userData key that will be used to delete the potential value
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted the userData with the given id
          headers: {}
          content: {}
        '204':
          description: The specified TPE userData does not exist
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Could not find the TPE with the specified id, or could not find the userData key
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/tpes/{tpeId}/tpeExpectations:
    get:
      tags:
      - 998 - nsiapiv2_0tpes
      summary: GetgetTpeExpectations
      description: Retrieves the expectations of the parent TPE
      operationId: GetgetTpeExpectations
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE expectation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationListRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The requested TPE can't be found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve TPE expectations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/tpes/{tpeId}/tpeExpectations/{tpeExpectationId}:
    get:
      tags:
      - 998 - nsiapiv2_0tpes
      summary: GetgetTpeExpectation
      description: Retrieves a specific TPE expectation
      operationId: GetgetTpeExpectation
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: tpeExpectationId
        in: path
        description: TPE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the TPE expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TpeExpectationRO'
        '403':
          description: Forbidden to access specified TPE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the TPE expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the TPE expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0tpes
      summary: DeletedeleteTpeExpectation1
      description: Delete TPE Expectation given tpeId and expectationId
      operationId: DeletedeleteTpeExpectation1
      parameters:
      - name: tpeId
        in: path
        description: TPE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: tpeExpectationId
        in: path
        description: TPE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Delete TPE Expectations with given id successfully.
          headers: {}
          content: {}
        '500':
          description: Failed to delete TPE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /ats/api/v1/problems:
    post:
      tags:
      - Problems
      summary: getProblems
      description: Get all problems matching the search filters, or all problems if no search filters provided
      operationId: getProblems
      parameters: []
      requestBody:
        description: ''
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ProblemRequest'
        required: true
      responses:
        '200':
          description: Successfully returned the problems
          headers: {}
          content: {}
        '400':
          description: Invalid value provided for one of the attributes
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while getting the problems
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ats/api/v1/problems/{id}:
    get:
      tags:
      - Problems
      summary: getProblem
      description: Get a problem by its ID, optionally include the related alarm resources
      operationId: getProblem
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully returned the problem
          headers: {}
          content: {}
        '404':
          description: A problem does not exist with the provided ID
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while getting the problems
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - Problems
      summary: patchProblem
      description: Patch a problem by ID
      operationId: patchProblem
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProblemPatch'
        required: true
      responses:
        '204':
          description: Successfully patched the problem
          headers: {}
          content: {}
        '400':
          description: Invalid value provided for one of the attributes of the problem
          headers: {}
          content: {}
        '403':
          description: The current user does not have access to the problem's partition(s)
          headers: {}
          content: {}
        '404':
          description: A problem does not exist with the provided ID
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while getting the problems
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v1/report:
    post:
      tags:
      - 000 - reportingapiv1report
      summary: getOnDemandReport
      description: >-
        This API generates an on demand report of specific report type provided by user.

        <p>Prerequisite: The following attributes should be specified in the post request:<ul><li>reportType - Type of report user wants to generate </ul>
      operationId: getOnDemandReport
      parameters: []
      requestBody:
        description: Provide report type to generate a report.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OnDemandReportRequestModel'
              - description: Provide report type to generate a report.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportMetaDataModel'
        '201':
          description: On demand report generated successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportMetaDataModel'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Report generation failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/report/delete:
    delete:
      tags:
      - 000 - reportingapiv1report
      summary: deleteReports
      description: This API deletes reports as per parameter values provided by user.
      operationId: deleteReports
      parameters:
      - name: fromDate
        in: query
        description: "Start date required for delete reports starting from From_Date. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: toDate
        in: query
        description: "End date required for deleting reports up to end date. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: reportType
        in: query
        description: Type of report user interested to delete.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Reports deleted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Reports deletion failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/report/delete/{resourceId}:
    delete:
      tags:
      - 000 - reportingapiv1report
      summary: deleteReportForResourceId
      description: This API helps to delete a specific report, which is associated with resource id provided by user.
      operationId: deleteReportForResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required to delete a specific report
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Report deleted successfully for user provided resource id
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Deletion of report failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/report/reportinfo/{resourceId}:
    get:
      tags:
      - 000 - reportingapiv1report
      summary: getReportDetailsOnResourceId
      description: This API fetch report's meta data information against the user provided resource id.
      operationId: getReportDetailsOnResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required for fetching a specific report meta data information
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Report's meta data information fetched successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportMetaDataModel'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No record found for resource id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of report meta data information failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/report/reportsinfo:
    get:
      tags:
      - 000 - reportingapiv1report
      summary: getReportDetails
      description: This API fetch report's meta data for mutiple reports on the basis of parameter values provided by user.
      operationId: getReportDetails
      parameters:
      - name: fromDate
        in: query
        description: "Start date to query reports meta data. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        style: form
        explode: true
        schema:
          type: string
      - name: toDate
        in: query
        description: "End date to query reports meta data. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        style: form
        explode: true
        schema:
          type: string
      - name: reportType
        in: query
        description: Type of report user interested to see meta data for.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Report on resource id
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AllReportMetaDataModelRO'
                description: ''
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of reports info failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/report/{resourceId}:
    get:
      tags:
      - 000 - reportingapiv1report
      summary: getReportForResourceId
      description: This API is used to fetch report data using resource id which is uniquely associated with a report.
      operationId: getReportForResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required for fetching a specific report data
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Report on resource id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            text/plain:
              schema:
                $ref: '#/components/schemas/Response'
        '203':
          description: Report generation in progress for resource id
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            text/plain:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No record found for resource id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            text/plain:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of report failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            text/plain:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/schedule:
    get:
      tags:
      - 000 - reportingapiv1schedule
      summary: getReportScheduleForReportType
      description: This API is used to fetch schedules associated with a single or multiple report types. Report types will be provided in comma separated values
      operationId: getReportScheduleForReportType
      parameters:
      - name: reportType
        in: query
        description: Report type is required to fetch all schedules associated with report type
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Report's schedule fetched successfully for a report type
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QueryAllReportsScheduleROV1'
                description: ''
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of report schedules failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/schedule/create:
    post:
      tags:
      - 000 - reportingapiv1schedule
      summary: createReportSchedule
      description: >-
        This QPI is used to create a new report schedule for a report type.

        <p>Prerequiste: The following attributes should be specified in the post request:<ul><li>startTime - Start time represents start time of report generation. Required format [yyyy-MM-ddTHH:mm:ss.SSSZ] <li>reportType - Type of report user wants to create schedule for </ul>
      operationId: createReportSchedule
      parameters: []
      requestBody:
        description: Request to create a report schedule provided with userData.Date format [yyyy-MM-ddTHH:mm:ss.SSSZ]
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateAndUpdateReportScheduleModelV1'
              - description: Request to create a report schedule provided with userData.Date format [yyyy-MM-ddTHH:mm:ss.SSSZ]
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryReportScheduleROV1'
        '201':
          description: Report's schedule successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryReportScheduleROV1'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Creation of report's schedule failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/schedule/delete/{resourceId}:
    delete:
      tags:
      - 000 - reportingapiv1schedule
      summary: deleteReportScheduleForResourceId
      description: This API is used to delete a report's schedule uniquely assigned to a resource id.
      operationId: deleteReportScheduleForResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id used for deleting a specific report's schedule
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Report's schedule deleted successfully for resource id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Deletion of report's schedule failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v1/schedule/{resourceId}:
    get:
      tags:
      - 000 - reportingapiv1schedule
      summary: getReportScheduleOnResourceId
      description: This API is used to fetch a schedule associated with a report on resource id basis.
      operationId: getReportScheduleOnResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required for fetching a report's schedule associated with resource id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Schedule fetched successfully for a resource id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryReportScheduleROV1'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of report schedule failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /reporting/api/v2/report:
    post:
      tags:
      - 000 - reportingapiv2report
      summary: PostgetOnDemandReport
      description: >-
        This API generates an on demand report of specific report type provided by user.

        <p>Prerequisite: The following attributes should be specified in the post request:<ul><li>reportType - Type of report user wants to generate </ul>
      operationId: PostgetOnDemandReport
      parameters: []
      requestBody:
        description: Provide report type to generate a report.
        content:
          application/vnd.api+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OnDemandReportRequestPayloadV2'
              - description: Provide report type to generate a report.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/OnDemandReportMetaDataResponseModelV2'
        '201':
          description: On demand report generated successfully
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/OnDemandReportMetaDataResponseModelV2'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Report generation failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/createreporttype:
    post:
      tags:
      - 000 - reportingapiv2report
      summary: PostuploadFile
      description: creates user-defined custom report-type
      operationId: PostuploadFile
      parameters:
      - name: reportType
        in: query
        description: Type of report user interested to create.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Description
        in: query
        description: Description of new report type.
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - uploadWorkflow
              type: object
              properties:
                uploadWorkflow:
                  type: string
                  description: workflow for Report in XML Format
                  format: binary
                joltFile:
                  type: string
                  description: (Deprecated) JOLT spec for JSON transformation
                  format: binary
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CreateReportTypeResponseModel'
        '201':
          description: New Report-type created successfully
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CreateReportTypeResponseModel'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: New Report-type creation failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/delete:
    delete:
      tags:
      - 000 - reportingapiv2report
      summary: DeletedeleteReports
      description: This API deletes reports as per parameter values provided by user.
      operationId: DeletedeleteReports
      parameters:
      - name: fromDate
        in: query
        description: "Start date required for deleting reports starting from From_Date. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: toDate
        in: query
        description: "End date required for deleting reports up to end date. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: reportType
        in: query
        description: Type of report user interested to delete.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '204':
          description: Reports deleted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Reports deletion failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/delete/reporttype/{reportType}:
    delete:
      tags:
      - 000 - reportingapiv2report
      summary: deleteReportType
      description: This API helps to delete a specific user created report type.
      operationId: deleteReportType
      parameters:
      - name: reportType
        in: path
        description: Report Type is required to delete a specific report type
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '204':
          description: User created report type deleted successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No record found for report type
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Deletion of report type failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/delete/{resourceId}:
    delete:
      tags:
      - 000 - reportingapiv2report
      summary: DeletedeleteReportForResourceId
      description: This API helps to delete a specific report, which is associated with resource id provided by user.
      operationId: DeletedeleteReportForResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required to delete a specific report
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '204':
          description: Report deleted successfully for user provided resource id
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No record found for resource id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Deletion of report failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/insertCircleTypeForLldpLinks:
    post:
      tags:
      - 000 - reportingapiv2report
      summary: insertCircleTypeForRingName
      description: This API helps to Add/Update circle, type, ring type corresponding to a Ring Name defined in  LLDP Links Report.
      operationId: insertCircleTypeForRingName
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - uploadPropertyFile
              type: object
              properties:
                uploadPropertyFile:
                  type: string
                  format: binary
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                type: string
        '201':
          description: Addition/updation done successfully
          headers: {}
          content: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Addition/Updation failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/onetouch:
    post:
      tags:
      - 000 - reportingapiv2report
      summary: getOneTouchReport
      description: "This API generates and fetches report of specific type and format provided by user in a single operation. The data is encoded as zip octet-stream.\n<p>Prerequisite: The following attributes should be specified in the post request:<ul><li>reportFormat - Format of report user wants to generate. Values can be JSON or CSV <li>reportType - Type of report user wants to generate <li>utcOffset - Timezone offset e.g. 'GMT-5:00'(for Eastern Time) or 'GMT+5:30'(for IST). \nThis offset will be used in report's meta-information to show times in the provided timezone. Default value is <i>GMT+0:00</i></ul>"
      operationId: getOneTouchReport
      parameters: []
      requestBody:
        description: Provide report format and type to generate a report.
        content:
          application/vnd.api+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OneTouchReportRequestPayloadV2'
              - description: Provide report format and type to generate a report.
        required: true
      responses:
        '200':
          description: Successfully generated and fetched report data associated with resource id. Encoded as zip octet-stream.
          headers: {}
          content:
            application/zip:
              schema: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/zip:
              schema: {}
        '404':
          description: No record found for resource id
          headers: {}
          content:
            application/zip:
              schema: {}
        '500':
          description: Retrieval of report data failed.
          headers: {}
          content:
            application/zip:
              schema: {}
      deprecated: false
  /reporting/api/v2/report/reportinfo/{resourceId}:
    get:
      tags:
      - 000 - reportingapiv2report
      summary: GetgetReportDetailsOnResourceId
      description: This API fetch report's meta data information against the user provided resource id.
      operationId: GetgetReportDetailsOnResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required for fetching a specific report meta data information
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '200':
          description: Report's meta data information fetched successfully.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReportMetaDataResponseModelV2'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of report meta data information failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/reportsinfo:
    get:
      tags:
      - 000 - reportingapiv2report
      summary: getReportsMetaInfo
      description: This API fetch report's meta data for multiple reports on the basis of parameter values provided by user.
      operationId: getReportsMetaInfo
      parameters:
      - name: fromDate
        in: query
        description: "Start date to query reports meta data. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        style: form
        explode: true
        schema:
          type: string
      - name: toDate
        in: query
        description: "End date to query reports meta data. Format required: [yyyy-MM-dd'T'HH:mm:ss.SSS'Z]"
        style: form
        explode: true
        schema:
          type: string
      - name: reportType
        in: query
        description: Type of report user interested to see meta data for.
        style: form
        explode: true
        schema:
          type: string
      - name: reportStatus
        in: query
        description: 'Status of report, used for filtering report meta data.Valid values are : Requested,Processing,Success,Failed'
        style: form
        explode: true
        schema:
          type: string
      - name: reportGenerationMode
        in: query
        description: 'Report generation mode, used for filtering report meta data.Valid values are : On demand,Scheduled'
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: 'Sort output data.Valid values are : reportGenerationMode,-reportGenerationMode,reportStatus,-reportStatus,reportType,-reportType,reportGenerationTime,-reportGenerationTime'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '200':
          description: Report on resource id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/OnDemandReportMetaDataResponseModelV2'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of reports info failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/supported/reporttype:
    get:
      tags:
      - 000 - reportingapiv2report
      summary: getAllSupportedReportTypes
      description: This API is used to fetch list of all report types supported by reporting feature
      operationId: getAllSupportedReportTypes
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '200':
          description: List of supported report types
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SupportedReportTypesV2'
        '500':
          description: Retrieval of supported report types failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/report/{resourceId}:
    get:
      tags:
      - 000 - reportingapiv2report
      summary: GetgetReportForResourceId
      description: This API is used to fetch report data using resource id which is uniquely associated with a report.
      operationId: GetgetReportForResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required for fetching a specific report data.
        required: true
        style: simple
        schema:
          type: string
      - name: reportFormat
        in: query
        description: Report format i.e. JSON or CSV.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: utcOffset
        in: query
        description: <p>Timezone offset e.g. 'GMT-5:00'(for Eastern Time) or 'GMT+5:30'(for IST).<p> This offset will be used in report's meta-information to show times in the provided timezone.
        style: form
        explode: true
        schema:
          type: string
          default: GMT+0:00
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '200':
          description: Successfully fetched report data associated with resource id. Encoded as zip octet-stream.
          headers: {}
          content:
            application/zip:
              schema: {}
        '400':
          description: Invalid request
          headers: {}
          content:
            application/zip:
              schema: {}
        '404':
          description: No record found for resource id
          headers: {}
          content:
            application/zip:
              schema: {}
        '500':
          description: Retrieval of report data failed.
          headers: {}
          content:
            application/zip:
              schema: {}
      deprecated: false
  /reporting/api/v2/schedule:
    get:
      tags:
      - 000 - reportingapiv2schedule
      summary: GetgetReportScheduleForReportType
      description: This API is used to fetch schedules associated with a single or multiple report types. Report types will be provided in comma separated values
      operationId: GetgetReportScheduleForReportType
      parameters:
      - name: reportType
        in: query
        description: Report type is required to fetch all schedules associated with report type
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '200':
          description: Report's schedule fetched successfully for a report type
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryAllReportsScheduleROV2'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of report schedules failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/schedule/create:
    post:
      tags:
      - 000 - reportingapiv2schedule
      summary: PostcreateReportSchedule
      description: >-
        This API is used to create a new report schedule for a report type.

        <p>Prerequisite: The following attributes should be specified in the post request:<ul><li>cronExpression - cron expression  Example: "00 00 19 23 May ? 2018" (at 19:00:00 at 23rd day at May month at 2018 year)<li>cronExpressionFormat - cron expression format i.e. QUARTZ or UNIX<li>reportType - Type of report user wants to create schedule for </ul>
      operationId: PostcreateReportSchedule
      parameters: []
      requestBody:
        description: JSON request to create a report schedule.
        content:
          application/vnd.api+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ReportsScheduleRequestPayloadV2'
              - description: JSON request to create a report schedule.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryReportsScheduleROV2'
        '201':
          description: Report's schedule successfully created
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryReportsScheduleROV2'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Creation of report's schedule failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/schedule/delete/{resourceId}:
    delete:
      tags:
      - 000 - reportingapiv2schedule
      summary: DeletedeleteReportScheduleForResourceId
      description: This API is used to delete a report's schedule uniquely assigned to a resource id.
      operationId: DeletedeleteReportScheduleForResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id used for deleting a specific report's schedule
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '204':
          description: Report's schedule deleted successfully for resource id.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Response'
        '404':
          description: No record found for resource id.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Deletion of report's schedule failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /reporting/api/v2/schedule/{resourceId}:
    get:
      tags:
      - 000 - reportingapiv2schedule
      summary: GetgetReportScheduleOnResourceId
      description: This API is used to fetch a schedule associated with a report on resource id basis.
      operationId: GetgetReportScheduleOnResourceId
      parameters:
      - name: resourceId
        in: path
        description: Resource id is required for fetching a report's schedule associated with resource id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type65'
      responses:
        '200':
          description: Schedule fetched successfully for a resource id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryReportsScheduleROV2'
        '400':
          description: Invalid request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: No record found for resource id
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Retrieval of report schedule failed.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/controllers:
    get:
      tags:
      - 000 - nsiapicontrollers
      summary: getControllers
      description: Retrieve a list of controllers provided with the satisfying parameters
      operationId: getControllers
      parameters:
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, controllerPlanned, controllerDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested controllers.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    post:
      tags:
      - 000 - nsiapicontrollers
      summary: postController
      description: Creates a controller
      operationId: postController
      parameters: []
      requestBody:
        description: Controller to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ControllerRO'
              - description: Controller to create or update
        required: true
      responses:
        '201':
          description: Successfully created the controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create the controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/controllers/{controllerId}:
    get:
      tags:
      - 000 - nsiapicontrollers
      summary: getController
      description: Retrieves a specific controller
      operationId: getController
      parameters:
      - name: controllerId
        in: path
        description: Identifier of the Controller to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, controllerPlanned, controllerDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Controller does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested controllers.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapicontrollers
      summary: deleteControllerById
      description: This operation is allowed for a root or actual Controller entity.
      operationId: deleteControllerById
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The Controller is deleted successfully.
          headers: {}
          content: {}
        '204':
          description: Controller does not exist.
          headers: {}
          content: {}
        '400':
          description: Bad request, input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to delete specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/controllers/{controllerId}/controllerExpectations:
    get:
      tags:
      - 000 - nsiapicontrollers
      summary: getControllerExpectationsById
      description: Retrieves the expectations from Controller with specific ID
      operationId: getControllerExpectationsById
      parameters:
      - name: controllerId
        in: path
        description: Identifier of the Controller to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerExpectationRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/controllers/{controllerId}/controllerExpectations/{controllerExpectationId}:
    delete:
      tags:
      - 000 - nsiapicontrollers
      summary: deleteControllerExpectation
      description: Delete Controller Expectation given controllerId and expectationId
      operationId: deleteControllerExpectation
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      - name: controllerExpectationId
        in: path
        description: Controller expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Delete Controller Expectations with given id successfully.
          headers: {}
          content: {}
        '204':
          description: Controller Expectation does not exist.
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Controller does not exist.
          headers: {}
          content: {}
        '500':
          description: Failed to delete Controller Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/controllers/{controllerId}/controllerPlanned:
    get:
      tags:
      - 000 - nsiapicontrollers
      summary: getControllerPlannedById
      description: Retrieves the planned Controller by specific Controller ID
      operationId: getControllerPlannedById
      parameters:
      - name: controllerId
        in: path
        description: Identifier of the Controller Planned to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerPlannedDataRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/controllers/{controllerId}/expectations:
    post:
      tags:
      - 000 - nsiapicontrollers
      summary: PostpostExpectation4
      description: Create an Controller expectation given the Controller id
      operationId: PostpostExpectation4
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ControllerExpectation to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ControllerExpectationRO'
              - description: ControllerExpectation to create or update
        required: false
      responses:
        '200':
          description: An existing Controller expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '201':
          description: Controller expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Controller does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/controllers/{controllerId}/expectations/{controllerExpectationId}/realize:
    post:
      tags:
      - 000 - nsiapicontrollers
      summary: PostprovisionOperations1
      description: >
        <p>LATEST VERSION: V1
      operationId: PostprovisionOperations1
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      - name: controllerExpectationId
        in: path
        description: ControllerExpectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Request to provision was sent successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Provisioning request failed against Controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/controllers/{controllerId}/operation/{operation}:
    put:
      tags:
      - 000 - nsiapicontrollers
      summary: putControllerOperations
      description: Perform a Controller Operation on NE
      operationId: putControllerOperations
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      - name: operation
        in: path
        description: Controller operation
        required: true
        style: simple
        schema:
          allOf:
          - $ref: '#/components/schemas/operation21'
          - description: Controller operation
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The Controller Operation was executed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Controller does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2/controllers:
    get:
      tags:
      - 995 - nsiapiv2controllers
      summary: GetgetControllers
      description: Retrieve a list of controllers provided with the satisfying parameters
      operationId: GetgetControllers
      parameters:
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30.
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, controllerPlanned, controllerDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested controllers.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v2/controllers/{controllerId}:
    get:
      tags:
      - 995 - nsiapiv2controllers
      summary: GetgetController
      description: Retrieves a specific controller
      operationId: GetgetController
      parameters:
      - name: controllerId
        in: path
        description: Identifier of the Controller to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, controllerPlanned, controllerDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Controller does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested controllers.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/controllers:
    get:
      tags:
      - 996 - nsiapiv1controllers
      summary: GetgetControllers1
      description: Retrieve a list of controllers provided with the satisfying parameters
      operationId: GetgetControllers1
      parameters:
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '20'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, controllerPlanned, controllerDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerListRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested controllers.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 996 - nsiapiv1controllers
      summary: PostpostController
      description: Creates a controller
      operationId: PostpostController
      parameters: []
      requestBody:
        description: Controller to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ControllerRO'
              - description: Controller to create or update
        required: true
      responses:
        '201':
          description: Successfully created the controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '400':
          description: Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create the controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/controllers/{controllerId}:
    get:
      tags:
      - 996 - nsiapiv1controllers
      summary: GetgetController1
      description: Retrieves a specific controller
      operationId: GetgetController1
      parameters:
      - name: controllerId
        in: path
        description: Identifier of the Controller to retrieve
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, controllerPlanned, controllerDiscovered'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '400':
          description: Invalid value specified for a query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested controllers.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    delete:
      tags:
      - 996 - nsiapiv1controllers
      summary: DeletedeleteControllerById
      description: This operation is allowed for a root or actual Controller entity.
      operationId: DeletedeleteControllerById
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The Controller is deleted successfully.
          headers: {}
          content: {}
        '204':
          description: Controller does not exist.
          headers: {}
          content: {}
        '400':
          description: Bad request, input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to delete specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/controllers/{controllerId}/controllerExpectations:
    get:
      tags:
      - 996 - nsiapiv1controllers
      summary: getControllerExpectations
      description: Retrieves the expectations from Controller with specific ID
      operationId: getControllerExpectations
      parameters:
      - name: controllerId
        in: path
        description: Identifier of the Controller to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerExpectationRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/controllers/{controllerId}/controllerExpectations/{controllerExpectationId}:
    delete:
      tags:
      - 996 - nsiapiv1controllers
      summary: DeletedeleteControllerExpectation
      description: Delete Controller Expectation given controllerId and expectationId
      operationId: DeletedeleteControllerExpectation
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      - name: controllerExpectationId
        in: path
        description: Controller expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Delete Controller Expectations with given id successfully.
          headers: {}
          content: {}
        '204':
          description: Controller Expectation does not exist.
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Controller does not exist.
          headers: {}
          content: {}
        '500':
          description: Failed to delete Controller Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/controllers/{controllerId}/controllerPlanned:
    get:
      tags:
      - 996 - nsiapiv1controllers
      summary: GetgetControllerPlannedById
      description: Retrieves the planned Controller by specific Controller ID
      operationId: GetgetControllerPlannedById
      parameters:
      - name: controllerId
        in: path
        description: Identifier of the Controller Planned to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerPlannedDataRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve Controller with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v1/controllers/{controllerId}/expectations:
    post:
      tags:
      - 996 - nsiapiv1controllers
      summary: PostpostExpectation5
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PostpostExpectation5
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ControllerExpectation to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ControllerExpectationRO'
              - description: ControllerExpectation to create or update
        required: false
      responses:
        '200':
          description: An existing Controller expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '201':
          description: Controller expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Controller does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/controllers/{controllerId}/expectations/{controllerExpectationId}/realize:
    post:
      tags:
      - 996 - nsiapiv1controllers
      summary: PostprovisionOperations2
      description: >
        <p>LATEST VERSION: V1
      operationId: PostprovisionOperations2
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      - name: controllerExpectationId
        in: path
        description: ControllerExpectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Request to provision was sent successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Provisioning request failed against Controller.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/controllers/{controllerId}/operation/{operation}:
    put:
      tags:
      - 996 - nsiapiv1controllers
      summary: PutputControllerOperations
      description: Perform a Controller Operation on NE
      operationId: PutputControllerOperations
      parameters:
      - name: controllerId
        in: path
        description: Controller identifier
        required: true
        style: simple
        schema:
          type: string
      - name: operation
        in: path
        description: Controller operation
        required: true
        style: simple
        schema:
          allOf:
          - $ref: '#/components/schemas/operation21'
          - description: Controller operation
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The Controller Operation was executed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Controller
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified Controller does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /ractrl/api/v1/jsonSchemas:
    get:
      tags:
      - RaController V1
      summary: getAllJsonSchemas
      description: Retrieves a list of JSON Schemas provided by the RA instances currently under management.
      operationId: getAllJsonSchemas
      parameters: []
      responses:
        '200':
          description: List of JSON schemas
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
      deprecated: false
  /ractrl/api/v1/jsonSchemas/{title}:
    get:
      tags:
      - RaController V1
      summary: getJsonSchemaByTitle
      description: Retrieve information for the JSON Schema identified.
      operationId: getJsonSchemaByTitle
      parameters:
      - name: title
        in: path
        description: Title for the json schema
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: List with the referenced JSON Schema
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not found, no schema with the supplied title.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ractrl/api/v1/ras:
    get:
      tags:
      - RaController V1
      summary: getAllRas
      description: Retrieves raInfo, resourceTypes, resourceProviders, jsonSchemas, sessions, typeGroups, uri and id for each RA managed by discovery.
      operationId: getAllRas
      parameters: []
      responses:
        '200':
          description: List of RA information
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
      deprecated: false
  /ractrl/api/v1/ras/{raId}:
    get:
      tags:
      - RaController V1
      summary: getRaById
      description: Retrieves raInfo, resourceTypes, resourceProviders, jsonSchemas, sessions, typeGroups, uri and id for one RA managed by discovery.
      operationId: getRaById
      parameters:
      - name: raId
        in: path
        description: Id for the RA
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: List of RA information
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not found, no RA with the supplied ID.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ractrl/api/v1/rebalanceSessions:
    post:
      tags:
      - RaController V1
      summary: rebalanceSessionsPost
      description: Rebalance sessions across all RA instances.
      operationId: rebalanceSessionsPost
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '102':
          description: A rebalancing operation is already in progress.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '201':
          description: A rebalancing operation has been initiated.
          headers: {}
          content: {}
      deprecated: false
  /ractrl/api/v1/resourceTypes:
    get:
      tags:
      - RaController V1
      summary: getAllResourceTypes
      description: Retrieves a list of resourceTypes provided by the managed RAs.
      operationId: getAllResourceTypes
      parameters: []
      responses:
        '200':
          description: List of resourceTypes.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
      deprecated: false
  /ractrl/api/v1/resourceTypes/{resourceTypeId}:
    get:
      tags:
      - RaController V1
      summary: getResourceTypeById
      description: Retrieves a list containing information for one resourceType.
      operationId: getResourceTypeById
      parameters:
      - name: resourceTypeId
        in: path
        description: Id for the ResourceType
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: List with resourceType information.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not found, no resourceType with the supplied resourceTypeId.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ractrl/api/v1/sessions:
    get:
      tags:
      - RaController V1
      summary: getAllSessions
      description: Retrieves a list of sessions present on the managed RA instances.
      operationId: getAllSessions
      parameters: []
      responses:
        '200':
          description: List of RA sessions.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
      deprecated: false
  /ractrl/api/v1/sessions/{sessionId}:
    get:
      tags:
      - RaController V1
      summary: getSessionById
      description: Retrieves a list with information for one RA session.
      operationId: getSessionById
      parameters:
      - name: sessionId
        in: path
        description: Id for the Session
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: List with RA session information.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not found, no RA session with the supplied sessionId.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ractrl/api/v1/typeGroups:
    get:
      tags:
      - RaController V1
      summary: getAllTypeGroups
      description: Retrieves a list of typeGroups provided by the managed RAs.
      operationId: getAllTypeGroups
      parameters: []
      responses:
        '200':
          description: List of typeGroups.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
      deprecated: false
  /ractrl/api/v1/typeGroups/{typeGroupId}:
    get:
      tags:
      - RaController V1
      summary: getTypeGroupById
      description: Retrieves a list containing information for one typeGroup.
      operationId: getTypeGroupById
      parameters:
      - name: typeGroupId
        in: path
        description: Id for the typeGroup
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: List with typeGroup information.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaCtrlListRO'
        '400':
          description: Bad request, usually caused by invalid values provided for a parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not found, no typeGroup with the supplied typeGroupId.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /smo/api/v1/smoProjects:
    get:
      tags:
      - smoapiv1smoProjects
      summary: getProjects
      description: List of SMO Projects returned in JSON format.
      operationId: getProjects
      parameters:
      - name: srcFre
        in: query
        description: (Optional) Comma separated list of src FRE identifiers referencing the desired SMO Projects
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested SMO projects.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested projects.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - smoapiv1smoProjects
      summary: createProject
      description: >-
        <p>This REST API is intended to be used to create an SMO Project..<p>The following attributes and relationships should be specified in the post request:<ul><li>srcFre an array of FRE identifiers representing the contextual fibre links</ul><p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "type": "smoProjects",
            "id": "1",
            "relationships": {
              "srcFre": {
                "data": [
                  {
                    "type": "fres",
                    "id": "-1014191875716228335"
                  }
                ]
              }
            }
          }
        }</code></pre>
      operationId: createProject
      parameters: []
      requestBody:
        description: Project to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProjectRO'
              - description: Project to create
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectRO'
        '201':
          description: Project created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create the SMO Project.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /smo/api/v1/smoProjects/{projectId}:
    get:
      tags:
      - smoapiv1smoProjects
      summary: getSpecificProject
      description: '<p>LATEST VERSION: V1'
      operationId: getSpecificProject
      parameters:
      - name: projectId
        in: path
        description: Identifier of the SMO project
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: srcFre, smoServices'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved project by ID
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the project with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve project with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - smoapiv1smoProjects
      summary: deleteById
      description: Deletes a specific SMO project
      operationId: deleteById
      parameters:
      - name: projectId
        in: path
        description: Identifier of SMO Project to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted NC successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to delete specified SMO project
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified project does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete the project.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /smo/api/v1/smoProjects/{projectId}/smoServices:
    patch:
      tags:
      - smoapiv1smoProjects
      summary: invokeServiceOperations
      description: >-
        Upon request accepted, code 202 is returned and the updated project returned<p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "path": "/data/attributes/status",
              "op": "replace",
              "value": "Restore",
              "ids": [
                "2034023754902357252905",
                "130-21482358043-5834588",
                "5409687504970978404590"
              ]
            },
            {
              "path": "/data/attributes/onHomePath",
              "op": "replace",
              "value": "true",
              "ids": [
                "2034023754902357252905"
              ]
            }
          ]
        }</code></pre>
      operationId: invokeServiceOperations
      parameters:
      - name: projectId
        in: path
        description: Identifier of the SMO project
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to services contained in the given project.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ServicePatchRO'
              - description: A patch request to services contained in the given project.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content: {}
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified project
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /smo/api/v1/smoServices/{serviceId}:
    get:
      tags:
      - smoapiv1smoServices
      summary: getSpecificService
      description: Retrieves a specific SMO Service
      operationId: getSpecificService
      parameters:
      - name: serviceId
        in: path
        description: Identifier of the SMO service
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: servicePath'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved service by ID
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the service with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve service with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/serviceIntents:
    get:
      tags:
      - Service Intents
      summary: getAllIntents
      description: 'Gets all Service Intents currently stored in the database.<p>Prerequisite: At least one Service Intent must exist.</p>'
      operationId: getAllIntents
      parameters:
      - name: label
        in: query
        description: (Optional) Retrieve service intents with the specified service user label
        style: form
        explode: true
        schema:
          type: string
      - name: layerRates
        in: query
        description: (Optional) Retrieve service intents that operate at the given layer rate(s)
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roadmLineName
        in: query
        description: (Optional) Retrieve service intents that utilize the named ROADM Line
        style: form
        explode: true
        schema:
          type: string
      - name: supportingServiceName
        in: query
        description: (Optional) Retrieve all client service intents for the specified supporting (infrastructure) service name
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Intents retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponseArray'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Service Intents
      summary: createIntent
      description: 'This API validates intent attributes, computes a path and schedules intent realization for deployment.<p>Prerequisite: The entered Service Intent is valid.</p>'
      operationId: createIntent
      parameters: []
      requestBody:
        description: Intent as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ServiceIntentRequest'
              - description: Intent as a JSON Profile wrapper object
        required: false
      responses:
        '201':
          description: Intent is created, realized and scheduled
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/serviceIntents/deleteIntent/{id}:
    delete:
      tags:
      - Service Intents
      summary: deleteServiceIntent
      description: 'This API deletes service Intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: deleteServiceIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Intent deleted
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/serviceIntents/{id}:
    get:
      tags:
      - Service Intents
      summary: getIntent
      description: 'This API retrieves an Intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: getIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Intent retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Service Intents
      summary: deleteIntent
      description: 'This API deletes an Intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: deleteIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Intent deleted
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/serviceIntents/{id}/deploy:
    post:
      tags:
      - Service Intents
      summary: deployIntent
      description: 'This API deploys a created service intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: deployIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/serviceIntents/{id}/forceFailState:
    post:
      tags:
      - Service Intents
      summary: forceState
      description: 'This API switches the service intent to FAILED_ACTIVATING/FAILED_DEACTIVATING from ACTIVATING/DEACTIVATING respectively based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: forceState
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/serviceIntents/{id}/realignState:
    post:
      tags:
      - Service Intents
      summary: realignState
      description: 'This API will realign service intent state to its resource trackers states in case where service intent is in ACTIVATING state but all intent resource trackers are ACTIVATED.Similarly, intent state is in DEACTIVATING state but all intent resource trackers are DEACTIVATED.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: realignState
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/serviceIntents/{id}/resourceTrackers:
    get:
      tags:
      - Service Intents
      summary: getServiceResourceTrackers
      description: 'This API retrieves all resource trackers based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: getServiceResourceTrackers
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: ServiceIntent ResourceTrackers retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentRoutes'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/serviceIntents/{id}/route:
    get:
      tags:
      - Service Intents
      summary: getServiceRoute
      description: 'This API retrieves a Route based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: getServiceRoute
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Route retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentRoutes'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Route id not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/serviceIntents/{id}/undeploy:
    post:
      tags:
      - Service Intents
      summary: undeployIntent
      description: 'This API undeploys a service based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: undeployIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: ignoreClientServiceDependencies
        in: query
        description: (Optional. Demo Only - not officially supported) Bypasses service provisioning client service validation if set to true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '202':
          description: Intent found and undeployment will begin
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '412':
          description: Intent not in correct state
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/serviceIntents/{id}/update:
    put:
      tags:
      - Service Intents
      summary: updateIntent
      description: 'This API modifies an existing service intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: updateIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Intent with the fields to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ServiceIntentRequest'
              - description: Intent with the fields to be updated
        required: false
      responses:
        '200':
          description: Update successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '400':
          description: Invalid input
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/serviceIntents:
    get:
      tags:
      - Service Intents v1
      summary: GetgetAllIntents
      description: 'Gets all Service Intents currently stored in the database.<p>Prerequisite: At least one Service Intent must exist.</p>'
      operationId: GetgetAllIntents
      parameters:
      - name: label
        in: query
        description: (Optional) Retrieve service intents with the specified service user label
        style: form
        explode: true
        schema:
          type: string
      - name: layerRates
        in: query
        description: (Optional) Retrieve service intents that operate at the given layer rate(s)
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roadmLineName
        in: query
        description: (Optional) Retrieve service intents that utilize the named ROADM Line
        style: form
        explode: true
        schema:
          type: string
      - name: supportingServiceName
        in: query
        description: (Optional) Retrieve all client service intents for the specified supporting (infrastructure) service name
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Intents retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponseArray'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Service Intents v1
      summary: PostcreateIntent
      description: 'This API validates intent attributes, computes a path and schedules intent realization for deployment.<p>Prerequisite: The entered Service Intent is valid.</p>'
      operationId: PostcreateIntent
      parameters: []
      requestBody:
        description: Intent as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ServiceIntentRequest'
              - description: Intent as a JSON Profile wrapper object
        required: false
      responses:
        '201':
          description: Intent is created, realized and scheduled
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v1/serviceIntents/deleteIntent/{id}:
    delete:
      tags:
      - Service Intents v1
      summary: DeletedeleteServiceIntent
      description: 'This API deletes service Intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: DeletedeleteServiceIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Intent deleted
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/serviceIntents/getFeasibleRoute:
    post:
      tags:
      - Service Intents v1
      summary: getFeasibleRoute
      description: 'This API returns a feasible route based on provided input parameters, but does not persist the route.<p>Prerequisite: The entered input is valid (including checks such as that the label must be unique).</p>'
      operationId: getFeasibleRoute
      parameters: []
      requestBody:
        description: Inputs as a JSON Profile wrapper object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ServiceIntentRequest'
              - description: Inputs as a JSON Profile wrapper object
        required: false
      responses:
        '200':
          description: Feasibility check has completed without error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentRoute'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/serviceIntents/{id}:
    get:
      tags:
      - Service Intents v1
      summary: GetgetIntent
      description: 'This API retrieves an Intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: GetgetIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Intent retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Service Intents v1
      summary: DeletedeleteIntent
      description: 'This API deletes an Intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: DeletedeleteIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Intent deleted
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/serviceIntents/{id}/deploy:
    post:
      tags:
      - Service Intents v1
      summary: PostdeployIntent
      description: 'This API deploys a created service intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: PostdeployIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v1/serviceIntents/{id}/forceFailState:
    post:
      tags:
      - Service Intents v1
      summary: PostforceState
      description: 'This API switches the service intent to FAILED_ACTIVATING/FAILED_DEACTIVATING from ACTIVATING/DEACTIVATING respectively based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: PostforceState
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/serviceIntents/{id}/realignState:
    post:
      tags:
      - Service Intents v1
      summary: PostrealignState
      description: 'This API will realign service intent state to its resource trackers states in case where service intent is in ACTIVATING state but all intent resource trackers are ACTIVATED.Similarly, intent state is in DEACTIVATING state but all intent resource trackers are DEACTIVATED.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: PostrealignState
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v1/serviceIntents/{id}/resourceTrackers:
    get:
      tags:
      - Service Intents v1
      summary: GetgetServiceResourceTrackers
      description: 'This API retrieves all resource trackers based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: GetgetServiceResourceTrackers
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: ServiceIntent ResourceTrackers retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentRoute'
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/serviceIntents/{id}/route:
    get:
      tags:
      - Service Intents v1
      summary: GetgetServiceRoute
      description: 'This API retrieves a Route based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: GetgetServiceRoute
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Route retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentRoute'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Route id not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v1/serviceIntents/{id}/undeploy:
    post:
      tags:
      - Service Intents v1
      summary: PostundeployIntent
      description: 'This API undeploys a service based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: PostundeployIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: ignoreClientServiceDependencies
        in: query
        description: (Optional. Demo Only - not officially supported) Bypasses service provisioning client service validation if set to true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '202':
          description: Intent found and undeployment will begin
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '412':
          description: Intent not in correct state
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/serviceIntents/{id}/update:
    put:
      tags:
      - Service Intents v1
      summary: PutupdateIntent
      description: 'This API modifies an existing service intent based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: PutupdateIntent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: Intent with the fields to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ServiceIntentRequest'
              - description: Intent with the fields to be updated
        required: false
      responses:
        '200':
          description: Update successful
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentResponse'
        '400':
          description: Invalid input
          headers: {}
          content: {}
        '404':
          description: Intent not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v2/serviceIntents/{id}/route:
    get:
      tags:
      - Service Intents v2
      summary: GetgetServiceRoute1
      description: 'This API retrieves a Route based on ID.<p>Prerequisite: A Service Intent must exist with the given ID.</p>'
      operationId: GetgetServiceRoute1
      parameters:
      - name: id
        in: path
        description: The unique identifier of the service intent
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Route retrieved
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceIntentRoutes'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Route id not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /revell/api/v2/serviceTrails/{freId}:
    get:
      tags:
      - mcp-view v2
      summary: serviceTrailV2
      description: Return Service Trail for a given FRE Id
      operationId: serviceTrailV2
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: startTpeId
        in: query
        description: Source Termination point Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: endTpeId
        in: query
        description: Destination Termination point Identifier
        style: form
        explode: true
        schema:
          type: string
      - name: traversalScope
        in: query
        description: 'Traversal Scope. The allowed values are: TOPOLOGICAL, SERVICE, LAYER NAVIGATION, MULTI LAYER'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts'
        style: form
        explode: true
        schema:
          type: string
      - name: floors
        in: query
        description: List of comma separated service class floors to be provided with the MULTI LAYER traversal scope. Separate composite paths will be provided separately for each floor if found
        style: form
        explode: true
        schema:
          type: string
      - name: additionalFlags
        in: query
        description: 'List of comma separated flags to handle special scenarios. The allowed values are: ignoreRpl'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Return Service Trail
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          headers: {}
          content: {}
      deprecated: false
  /revell/api/v2/serviceTopology/{freId}:
    get:
      tags:
      - mcp-view v2
      summary: serviceTopologyV2
      description: Return Service Topology for a given FRE Id
      operationId: serviceTopologyV2
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: traversalScope
        in: query
        description: 'Traversal Scope. The allowed values are: TOPOLOGICAL, SERVICE, LAYER NAVIGATION, MULTI LAYER'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: 'List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts'
        style: form
        explode: true
        schema:
          type: string
      - name: floors
        in: query
        description: List of comma separated service class floors to be provided with the MULTI LAYER traversal scope. Separate composite paths will be provided separately for each floor if found
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Return Service Topology
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          headers: {}
          content: {}
      deprecated: false
  /revell/api/v2/serviceTopology/:
    post:
      tags:
      - mcp-view v2
      summary: pstServiceTrailV2
      description: Returns a Service Trail
      operationId: pstServiceTrailV2
      parameters:
      - name: additionalFlags
        in: query
        description: 'List of comma separated flags to handle special scenarios. The allowed values are: ignoreRpl'
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: FRE to generate trail
        content:
          text/plain:
            schema:
              type: object
              description: FRE to generate trail
        required: true
      responses:
        '200':
          description: Return Service Trail
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          headers: {}
          content: {}
      deprecated: false
  /revell/api/v2/serviceTopology/topology/:
    post:
      tags:
      - mcp-view v2
      summary: pstServiceTopologyV2
      description: Returns a Service Topology
      operationId: pstServiceTopologyV2
      parameters: []
      requestBody:
        description: FRE to generate topology
        content:
          text/plain:
            schema:
              type: object
              description: FRE to generate topology
        required: true
      responses:
        '200':
          description: Return Service Topology
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          headers: {}
          content: {}
      deprecated: false
  /revell/api/v2/simplePortTrail/{freId}:
    get:
      tags:
      - mcp-view v2
      summary: simplePortTrailV2
      description: Return Simple Port Trail a given FRE Id
      operationId: simplePortTrailV2
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Return Port Trail
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          headers: {}
          content: {}
      deprecated: false
  /revell/api/v1/serviceTrails/{freId}:
    get:
      tags:
      - mcp-view v1
      summary: serviceTrailV1
      description: Return Service Trail for a given FRE Id
      operationId: serviceTrailV1
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Return Service Trail
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          headers: {}
          content: {}
      deprecated: false
  /revell/api/v1/serviceTrails/:
    post:
      tags:
      - mcp-view v1
      summary: pstServiceTrailV1
      description: Returns a Service Trail
      operationId: pstServiceTrailV1
      parameters: []
      requestBody:
        description: FRE to generate trail
        content:
          text/plain:
            schema:
              type: object
              description: FRE to generate trail
        required: true
      responses:
        '200':
          description: Return Service Trail
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          headers: {}
          content: {}
      deprecated: false
  /nsi/api/fres:
    get:
      tags:
      - 000 - nsiapifres
      summary: getFres
      description: >-
        <p>LATEST VERSION: V6

        <p>At least one of the following parameters must be specified:<ul><li>tpeId<li>networkConstruct.id<li>freExpectations.serviceIntent.id<li>freExpectations.equipmentIntent.id<li>childFreId<li>endpoint.tpe.concrete<li>identifiers</ul>

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKeys=key1,key2,...&identifierValues=value1,value2,...
        For instance:
             ?identifierKey=nodalId&identifierValue=nodalIdValue
      operationId: getFres
      parameters:
      - name: tpeId
        in: query
        description: TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: layerRate
        in: query
        description: '(Optional) FRE layer rates in comma separated list. Only applied when Network Construct identifier is provided. The allowed values are: ETHERNET, OTU2, OTU4, OTSi, OMS, OS, PHY, OTS, ODU2, ODU4, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, CBR'
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: The child FRE identifier to return its parents
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.intent.id
        in: query
        description: The intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: freType
        in: query
        description: '(Optional) FRE types in comma separated list. The allowed values are: explicitRoute, explicitRouteGroup, snc, sncGroup, cascadedExplicitRouteInstance, explicitRouteInstance, cascadedExplicitRoute'
        style: form
        explode: true
        schema:
          type: string
      - name: exclude
        in: query
        description: '(Optional) A single given type to be excluded used in conjunction with the `childFreId` parameter. The allowed values are: actual, expectation'
        style: form
        explode: true
        schema:
          type: string
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, frePlanned, freDiscovered, srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    post:
      tags:
      - 000 - nsiapifres
      summary: postFre
      description: >-
        <p>LATEST VERSION: V4<p>This REST API is intended to be used by service provisioning micro-service IFD only to create a FRE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>layerRate, networkRole, directionality, topologySources, etc.<li>endpoint id relationships<li>network construct id relationship if the FRE is nodal<li>id relationship to other FREs if applicable<li>a list of FRE expectation id relationships<li>the endpoint content - specified in the included section<ul><li>role, directionality, etc.<li>tpe id relationships</ul><li>the FRE expectation content - specified in the included section<ul><li> validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs.<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "-3117193564021298218",
            "type": "fres",
            "attributes": {
              "userLabel": "drop4_OCH_planned",
              "mgmtName": "service_1",
              "layerRate": "OTSi",
              "networkRole": "FREAP",
              "directionality": "unidirectional",
              "topologySources": [
                "stitched"
              ]
            },
            "relationships": {
              "endPoints": {
                "data": [
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:1"
                  },
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:2"
                  }
                ]
              },
              "partitionFres": {
                "data": [
                  {
                    "type": "fres",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::FRE_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_1-5-CTPServerToClient-1547.72_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_21-7-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "721516201499390732"
                  },
                  {
                    "type": "fres",
                    "id": "6739849242751075618"
                  },
                  {
                    "type": "fres",
                    "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::FRE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_1-8-CTPServerToClient-1547.72_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_21-8-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "1808637606701600683"
                  }
                ]
              },
              "freExpectations": {
                "data": [
                  {
                    "type": "freExpectations",
                    "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "-3117193564021298218:1",
              "type": "endPoints",
              "attributes": {
                "role": "a",
                "directionality": "receive ingress",
                "associations": [
                   {
                       "orderIndex": 1,
                       "routeType": "home",
                       "relationship": "tpes"
                   }
                 ]
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218:2",
              "type": "endPoints",
              "attributes": {
                "role": "z",
                "directionality": "transmit egress"
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8",
              "type": "freExpectations",
              "attributes": {
                "modelType": "controlPlane",
                "userLabel": "userLabel1",
                "layerRate": "OTSi",
                "networkRole": "IFRE",
                "directionality": "bidirectional",
                "photonicSpectrumPackage": {
                   "frequency": "196.075000:196.125000",
                   "minFreq": "195.975000:196.025000",
                   "maxFreq": "195.775000:195.825000"
                  },
                "validateParameters": {
                  "include": "layerRate"
                }
               },
              "relationships": {
                 "endPoints": {
                     "data": [
                         {
                           "type": "endPoints",
                           "id": "1"
                         },
                         {
                           "type": "endPoints",
                           "id": "2"
                         }
                     ]
                 },
                "networkConstruct": {
                   "data": {
                      "type": "networkConstructs",
                      "id": "ncId1"
                   }
                },
                "serviceIntent": {
                  "data": {
                    "type": "serviceIntents",
                    "id": "eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postFre
      parameters: []
      requestBody:
        description: FRE to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreRO'
              - description: FRE to create
        required: false
      responses:
        '201':
          description: FRE and its expectation created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}:
    get:
      tags:
      - 000 - nsiapifres
      summary: getFrebyId
      description: '<p>LATEST VERSION: V7'
      operationId: getFrebyId
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, controllers,srlgs, utilization'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    put:
      tags:
      - 000 - nsiapifres
      summary: putFreById
      description: '<p>LATEST VERSION: V4<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putFreById
      parameters:
      - name: freId
        in: path
        description: FRE identifier.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new FRE data.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreRO'
              - description: The new FRE data.
        required: true
      responses:
        '200':
          description: FRE has been updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to update FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapifres
      summary: unprovision
      description: 'LATEST VERSION: V3'
      operationId: unprovision
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The de-provisioning request was sent successfully
          headers: {}
          content: {}
        '403':
          description: Forbidden to delete specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 000 - nsiapifres
      summary: PatchpatchOperation3
      description: >
        <p>LATEST VERSION: V4<p>Upon request accepted, code 202 is returned and the output consists of JSON objects representing current fre resource.<p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "note" : {
                           "noteMsg" : "This is an updated message on an Fre",
                           "lastUpdatedBy" : "userName"
                       },
                       "customerName" : "This is the customer name on an Fre"
        ,               "lqsData" : {
                           "status" : "good",
                           "margin" : {
                               "minMargin" : -1.0,
                               "upgrMargin" : -1.0,
                               "sdMargin" : -1.0,
                               "valid" : true,
                               "viableAtEol" : "exceeded"
                           },
                           "fiber" : {
                               "measuredLoss" : -1.0,
                               "modeledLoss" : -1.0,
                               "deltaLoss" : -1.0,
                               "modeledMargin" : -1.0,
                               "method" : "osc",
                               "reconciled" : true
                           }
                       }
                    }
                }
            ]
        }

        </code></pre><p>Example replace request to override a ROADMLine's utilization total capacity:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "path": "data/attributes/utilizationData/overrideTotalCapacity",
              "attributes": {
                "utilizationData": {
                  "overrideTotalCapacity": "4.400"
                }
              }
            }
          ]
        }</code></pre><p>Example replace request to set an SNC refresh state:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "path": "data/attributes/serviceRefresh",
              "attributes": {
                "serviceRefresh": {
                  "state": "Pending"
                }
              }
            }
          ]
        }</code></pre><p>Example delete request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "note"
                }
            ]
        }

        </code></pre><p>Example delete request FRE utilization total capacity override value:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "path": "data/attributes/utilizationData/overrideTotalCapacity"
                }
            ]
        }</code></pre><p>Example delete request SNC refresh state:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "path": "data/attributes/serviceRefresh"
                }
            ]
        }</code></pre>Doing a replace on srlg with an empty list will delete the srlg attribute
      operationId: PatchpatchOperation3
      parameters:
      - name: freId
        in: path
        description: The id of the fre to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given fre.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePatchRO'
              - description: A patch request to the given fre.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/adminState:
    put:
      tags:
      - 000 - nsiapifres
      summary: putFreAdminState
      description: 'LATEST VERSION: V3'
      operationId: putFreAdminState
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired adminState value
        content:
          text/plain:
            schema:
              type: string
              description: The desired adminState value
        required: true
      responses:
        '200':
          description: The AdminState was changed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/bookingData/{bookingDataKey}:
    put:
      tags:
      - 000 - nsiapifres
      summary: putFreBookingData
      description: '<ul><li>Any leading or trailing whitespace will be trimmed from the bookingData<li>LATEST VERSION: V2_0<li>assignedBandwidth and assignedBandwidthUnit is not valid on an ETHERNET LLDP Link FRE_AP'
      operationId: putFreBookingData
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: bookingDataKey
        in: path
        description: bookingData attribute name (and allowable values):<ul><li>assignedBandwidth (positive number)<li>assignedBandwidthUnit (mpbs, kbps, or gbps)<li>bandwidthLockout (true, false)<li>bookingFactor (positive number to one decimal place, like 1.0)</ul>
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired bookingData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired bookingData value
        required: true
      responses:
        '200':
          description: FRE bookingData attribute created/updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid parameters specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to modify bookingData on FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapifres
      summary: deleteFreBookingData
      description: '<p>LATEST VERSION: V2_0'
      operationId: deleteFreBookingData
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: bookingDataKey
        in: path
        description: bookingData attribute to delete:<ul><li>assignedBandwidth<li>assignedBandwidthUnit<li>bandwidthLockout<li>bookingFactor</ul>
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified bookingData attribute does not exist in FRE.
          headers: {}
          content: {}
        '204':
          description: Deleted FRE bookingData successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid parameters specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete FRE bookingData attribute
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/expectationMismatches:
    get:
      tags:
      - 000 - nsiapifres
      summary: getFreExpectationMismatches
      description: '<p>LATEST VERSION: V4<p>Mismatch for each FRE in the FRE subtree are returned'
      operationId: getFreExpectationMismatches
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/fres/{freId}/expectations:
    post:
      tags:
      - 000 - nsiapifres
      summary: postFREExpectation
      description: >-
        <p>LATEST VERSION: V3<p>This REST API is intended to be used by service provisioning micro-service IFD only to create or update an FRE expectation on existing FRE.<p>The following attributes and relationships should be specified in the post request:<ul><li>layerRate, networkRole, directionality, topologySources, etc.<li>endpoint id relationships<li>network construct id relationship if the FRE is nodal<li>id relationship to other FREs if applicable<li>a list of FRE expectation id relationships<li>the endpoint content - specified in the included section<ul><li>role, directionality, etc.<li>tpe id relationships</ul><li>the FRE expectation content - specified in the included section<ul><li>service intent id relationship</ul></ul><p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs.<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "SNCG(2)-57f3cccb-6918-4ce1-949f-0dff34a8a501",
            "type": "freExpectations",
            "attributes": {
              "directionality": "bidirectional",
              "userLabel": "BP SNCG",
              "networkRole": "IFRE",
              "layerRate": "OMS",
              "modelType": "controlPlane",
              "freType": "sncGroup",
              "routingConstraints": {
                "isRouteExclusive": "true",
                "identifier": "c807e13a-6ec6-48c4-a4cd-38afe40fdd39"
              }
            },
            "relationships": {
              "serviceIntent": {
                "data": {
                  "type": "serviceIntents",
                  "id": "57f3cccb-6918-4ce1-949f-0dff34a8a501"
                }
              },
              "endPoints": {
                "data": [
                  {
                    "type": "endPoints",
                    "id": "1"
                  },
                  {
                    "type": "endPoints",
                    "id": "2"
                  }
                ]
              },
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "2452f453-fb13-4ebb-bee5-d32ac520611c"
                }
              }
            }
          },
          "included": [
            {
              "id": "1",
              "type": "endPoints",
              "attributes": {
                "role": "a",
                "associations": [
                  {
                    "relationship": "networkConstructs",
                    "identifier": {
                      "osrpNodeName": "PV0037FGD"
                    }
                  }
                ]
              },
              "relationships": {}
            },
            {
              "id": "2",
              "type": "endPoints",
              "attributes": {
                "role": "z",
                "associations": [
                  {
                    "relationship": "networkConstructs",
                    "identifier": {
                      "osrpNodeName": "PV0037FGA"
                    }
                  }
                ]
              },
              "relationships": {}
            }
          ]
        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postFREExpectation
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request to create an FRE expectation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreExpectationRO'
              - description: Request to create an FRE expectation
        required: false
      responses:
        '200':
          description: An existing FRE expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '201':
          description: FRE expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/expectations/{expectationId}/realize:
    post:
      tags:
      - 000 - nsiapifres
      summary: PostprovisionOperations3
      description: '<p>LATEST VERSION: V3'
      operationId: PostprovisionOperations3
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: FreExpectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Request to provision was sent successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Provisioning request failed against FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/expectations/{freExpId}:
    patch:
      tags:
      - 000 - nsiapifres
      summary: patchFreExpectation
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current fre resource.</code></pre><p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "srlg" : ["srlg1", "srlg2"]
                    }
                }
            ]
        }

        </code></pre>
      operationId: patchFreExpectation
      parameters:
      - name: freId
        in: path
        description: The id of the fre to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: freExpId
        in: path
        description: The id of the freExpectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given fre.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePatchRO'
              - description: A patch request to the given fre.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FreExpectationRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/freExpectations:
    get:
      tags:
      - 000 - nsiapifres
      summary: getFreExpectation
      description: '<p>LATEST VERSION: V2_0'
      operationId: getFreExpectation
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Get FRE Expectations with given id successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreExpectationRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find FRE Expectations for the FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to get FRE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/freExpectations/{freExpectationId}:
    get:
      tags:
      - 000 - nsiapifres
      summary: getFreExpectationWithExpId
      description: '<p>LATEST VERSION: V2_0'
      operationId: getFreExpectationWithExpId
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: freExpectationId
        in: path
        description: FRE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Get FRE Expectations with given id successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreExpectationRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find FRE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to get FRE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapifres
      summary: deleteFreExpectationById
      description: '<p>LATEST VERSION: V3'
      operationId: deleteFreExpectationById
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: freExpectationId
        in: path
        description: FRE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted FRE Expectation successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete FRE Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/frePlanned:
    get:
      tags:
      - 000 - nsiapifres
      summary: getPlannedAttributesFrebyId
      description: "<p>LATEST VERSION: V4<p>When using the include parameter, resources will also be retrieved from the expectation if 'expectations' is one of the include parameters."
      operationId: getPlannedAttributesFrebyId
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, equipment'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - 000 - nsiapifres
      summary: putFrePlanned
      description: '<p>LATEST VERSION: V4<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putFrePlanned
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Planned FRE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePlannedRO'
              - description: Planned FRE to create or update
        required: false
      responses:
        '201':
          description: Planned FRE created/updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create a planned FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 000 - nsiapifres
      summary: patchPlannedFre
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current fre resource.<p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "userLabel" : "newLabel",
                       "description" : "This is the description on an Fre"
        ,            }
                }
            ]
        }

        </code></pre><p>Example delete request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "userLabel"
                }
            ]
        }

        </code></pre><p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre>
      operationId: patchPlannedFre
      parameters:
      - name: freId
        in: path
        description: The id of the fre to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given fre.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePatchRO'
              - description: A patch request to the given fre.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/identifiers:
    put:
      tags:
      - 000 - nsiapifres
      summary: updateFreIdentifier
      description: 'LATEST VERSION: V3<p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updateFreIdentifier
      parameters:
      - name: freId
        in: path
        description: The FRE id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The identifier JSON object
        content:
          application/json:
            schema:
              type: object
              description: The identifier JSON object
        required: true
      responses:
        '200':
          description: Fre identifier have been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '201':
          description: Successfully created a new FRE identifier for the given FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapifres
      summary: deleteFreIdentifier
      description: '<p>LATEST VERSION: V3'
      operationId: deleteFreIdentifier
      parameters:
      - name: freId
        in: path
        description: The FRE id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Successfully deleted the FRE identifier
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/operations/{operation}:
    put:
      tags:
      - 000 - nsiapifres
      summary: putFreOperationV6
      description: execute FRE Operation on NE
      operationId: putFreOperationV6
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: operation
        in: path
        description: FRE operation
        required: true
        style: simple
        schema:
          allOf:
          - $ref: '#/components/schemas/operation41'
          - description: FRE operation
      requestBody:
        description: The desired fre operation
        content:
          application/json:
            schema:
              type: object
              description: The desired fre operation
        required: false
      responses:
        '200':
          description: The FRE Operation was executed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/fres/{freId}/userData/{userDataKey}:
    put:
      tags:
      - 000 - nsiapifres
      summary: putFreUserData
      description: '<p>LATEST VERSION: V2_0<p>Any leading or trailing whitespace will be trimmed from userData.<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putFreUserData
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of userData to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: true
      responses:
        '200':
          description: FRE userData attribute created/updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid parameters specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to modify userData on FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 000 - nsiapifres
      summary: deleteFreUserData
      description: '<p>LATEST VERSION: V2_0'
      operationId: deleteFreUserData
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of userData to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified userData attribute does not exist in FRE.
          headers: {}
          content: {}
        '204':
          description: Deleted FRE userData attribute successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete FRE userData attribute
          headers: {}
          content: {}
      deprecated: false
  /nsi/api/fres/{freId}/validationExpectation:
    put:
      tags:
      - 000 - nsiapifres
      summary: postFreValidationExpectation
      description: >-
        <p>LATEST VERSION: V3<p>This REST API is intended to be used by service provisioning micro-service IFD only to create or update a FRE validation expectation. On initial creation, FRE expectations can be specified and created as well, on update, only the FRE validation expectation can be updated<p>The following attributes and relationships should be specified in the post request for initial creation:<ul><li>layerRate, networkRole, directionality, topologySources, etc.<li>endpoint id relationships<li>network construct id relationship if the FRE is nodal<li>id relationship to other FREs if applicable<li>a list of FRE expectation id relationships<li>the endpoint content - specified in the included section<ul><li>role, directionality, etc.<li>tpe id relationships</ul><li>the FRE expectation content - specified in the included section<ul><li> validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs.<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "-3117193564021298218",
            "type": "fres",
            "attributes": {
              "userLabel": "drop4_OCH_planned",
              "mgmtName": "service_1",
              "layerRate": "OTSi",
              "networkRole": "FREAP",
              "directionality": "unidirectional",
              "topologySources": [
                "stitched"
              ],
              "additionalAttributes": {
                "isActual": "false"
              }
            },
            "relationships": {
              "endPoints": {
                "data": [
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:1"
                  },
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:2"
                  }
                ]
              },
              "partitionFres": {
                "data": [
                  {
                    "type": "fres",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::FRE_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_1-5-CTPServerToClient-1547.72_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_21-7-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "721516201499390732"
                  },
                  {
                    "type": "fres",
                    "id": "6739849242751075618"
                  },
                  {
                    "type": "fres",
                    "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::FRE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_1-8-CTPServerToClient-1547.72_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_21-8-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "1808637606701600683"
                  }
                ]
              },
              "freExpectations": {
                "data": [
                  {
                    "type": "freExpectations",
                    "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "-3117193564021298218:1",
              "type": "endPoints",
              "attributes": {
                "role": "a",
                "directionality": "receive ingress",
                "associations": [
                   {
                     "orderIndex": 1,             "routeType": "home",             "relationship": "tpes"           }
                 ]
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218:2",
              "type": "endPoints",
              "attributes": {
                "role": "z",
                "directionality": "transmit egress"
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8",
              "type": "freExpectations",
              "attributes": {
                "modelType": "controlPlane",
                "userLabel": "userLabel1",
                "layerRate": "OTSi",
                "networkRole": "IFRE",
                "directionality": "bidirectional",
                "photonicSpectrumPackage": {
                   "frequency": "196.075000:196.125000",
                   "minFreq": "195.975000:196.025000",
                   "maxFreq": "195.775000:195.825000"
                  },
                "validateParameters": {
                  "include": "layerRate"
                }
               },
              "relationships": {
                 "endPoints": {
                     "data": [
                         {
                           "type": "endPoints",
                           "id": "1"
                         },
                         {
                           "type": "endPoints",
                           "id": "2"
                         }
                     ]
                 },
                "networkConstruct": {
                   "data": {
                      "type": "networkConstructs",
                      "id": "ncId1"
                   }
                },
                "serviceIntent": {
                  "data": {
                    "type": "serviceIntents",
                    "id": "eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                }
              }
            }
          ]
        }</code></pre>
      operationId: postFreValidationExpectation
      parameters:
      - name: freId
        in: path
        description: FRE identifier.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: FRE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreRO'
              - description: FRE to create or update
        required: false
      responses:
        '201':
          description: validation FRE and its expectations created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create or update FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v6/fres:
    get:
      tags:
      - 994 - nsiapiv6fres
      summary: getFresV6
      description: >-
        <p>At least one of the following parameters must be specified:<ul><li>tpeId<li>networkConstruct.id<li>freExpectations.serviceIntent.id<li>freExpectations.equipmentIntent.id<li>childFreId<li>endpoint.tpe.concrete<li>identifiers</ul>

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKeys=key1,key2,...&identifierValues=value1,value2,...
        For instance:
             ?identifierKey=nodalId&identifierValue=nodalIdValue
      operationId: getFresV6
      parameters:
      - name: tpeId
        in: query
        description: TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: layerRate
        in: query
        description: '(Optional) FRE layer rates in comma separated list. Only applied when Network Construct identifier is provided. The allowed values are: ETHERNET, OTU2, OTU4, OTSi, OMS, OS, PHY, OTS, ODU2, ODU4, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, CBR'
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: The child FRE identifier to return its parents
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.intent.id
        in: query
        description: The intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifer object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: freType
        in: query
        description: '(Optional) FRE types in comma separated list. The allowed values are: explicitRoute, cascadedExplicitRoute, explicitRouteGroup, snc, sncGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: exclude
        in: query
        description: '(Optional) A single given type to be excluded used in conjunction with the `childFreId` parameter. The allowed values are: actual, expectation'
        style: form
        explode: true
        schema:
          type: string
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, frePlanned, freDiscovered, utilization'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v6/fres/{freId}:
    get:
      tags:
      - 994 - nsiapiv6fres
      summary: getFreByIdV6
      description: Retrieves a specific FRE
      operationId: getFreByIdV6
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, controllers, srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsi/api/v6/fres/{freId}/operations/{operation}:
    put:
      tags:
      - 994 - nsiapiv6fres
      summary: PutputFreOperationV6
      description: execute FRE Operation on NE
      operationId: PutputFreOperationV6
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: operation
        in: path
        description: FRE operation
        required: true
        style: simple
        schema:
          allOf:
          - $ref: '#/components/schemas/operation41'
          - description: FRE operation
      requestBody:
        description: The desired fre operation
        content:
          application/json:
            schema:
              type: object
              description: The desired fre operation
        required: false
      responses:
        '200':
          description: The FRE Operation was executed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v7/fres/{freId}:
    get:
      tags:
      - 994 - nsiapiv7fres
      summary: getFreByIdV7
      description: Retrieves a specific FRE
      operationId: getFreByIdV7
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, controllers, utilization'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v5/fres:
    get:
      tags:
      - 995 - nsiapiv5fres
      summary: getFresV5
      description: >-
        <p>At least one of the following parameters must be specified:<ul><li>tpeId<li>networkConstruct.id<li>freExpectations.serviceIntent.id<li>freExpectations.equipmentIntent.id<li>childFreId<li>endpoint.tpe.concrete<li>identifiers</ul>

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKeys=key1,key2,...&identifierValues=value1,value2,...
        For instance:
             ?identifierKey=ossLabel&identifierValue=ossLabel
      operationId: getFresV5
      parameters:
      - name: tpeId
        in: query
        description: TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: layerRate
        in: query
        description: '(Optional) FRE layer rates in comma separated list. Only applied when Network Construct identifier is provided. The allowed values are: ETHERNET, OTU2, OTU4, OTSi, OMS, OS, PHY, OTS, ODU2, ODU4, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET'
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: The child FRE identifier to return its parents
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.intent.id
        in: query
        description: The intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifer object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: freType
        in: query
        description: '(Optional) FRE types in comma separated list. The allowed values are: explicitRoute, explicitRouteGroup, snc, sncGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: exclude
        in: query
        description: '(Optional) A single given type to be excluded used in conjunction with the `childFreId` parameter. The allowed values are: actual, expectation'
        style: form
        explode: true
        schema:
          type: string
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, frePlanned, freDiscovered, srlgs'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v5/fres/{freId}:
    get:
      tags:
      - 995 - nsiapiv5fres
      summary: getFreByIdV5
      description: Retrieves a specific FRE
      operationId: getFreByIdV5
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, controllers,srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /nsi/api/v4/fres:
    get:
      tags:
      - 996 - nsiapiv4fres
      summary: getFresV4
      description: >2-

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKey=key1,key2,...&identifierValue=value1,value2,...
        For instance:
             ?identifierKey=ossLabel&identifierValue=ossLabel
      operationId: getFresV4
      parameters:
      - name: id
        in: query
        description: (Optional) Comma separated list of FRE identifiers to retrieve
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text, (default search Fields are name, layerRate, tpeLocations if searchFields is not specified.)
        style: form
        explode: true
        schema:
          type: string
      - name: searchFields
        in: query
        description: (Optional) List of comma separated fields to search with, combined with searchText. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: resourceState
        in: query
        description: '(Optional) List of fre planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown'
        style: form
        explode: true
        schema:
          type: string
          default: planned,discovered,plannedAndDiscovered
      - name: layerRate
        in: query
        description: 'FRE layer rates in comma separated list.  The allowed values are: ETHERNET, OTU1, OTU2, OTU2e, OTU3, OTU4, OTUCn, OTSi, OMS, OS, PHY, OTS, FICON, FC, ODU, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU4, ODUCn, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, ENCAPSULATION, MPLS, MPLS_PROTECTION, MEDIA, LAG, RS, E1, E3, E1_2M, EC1, DSR_2M, LINE_OC3_STS3_AND_MS_STM1, SECTION_OC3_STS3_AND_RS_STM1, DSR_OC3_STM1, DSR_OC12_STM4, DSR_OC48_STM16, DSR_OC192_STM64, CES_IWF, T1, DSR_1_5M, STS1, STS3C, STS12C, STS24C, STS48C, DS0, DS1, DS3, VT15, VT2, NOT_APPLICABLE, ODUFLEX, OTUg, ODUg, BGP, IP'
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: tpeId
        in: query
        description: TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifer object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: concrete
        in: query
        description: (Optional) List of concrete FRE identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: modelType
        in: query
        description: (Optional) modelType parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: bookingData.lockout
        in: query
        description: (Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/bookingData.lockout1'
          - description: (Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed
      - name: group
        in: query
        description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/group1'
          - description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
      - name: freType
        in: query
        description: 'FRE types in comma separated list The allowed values are: explicitRoute, explicitRouteGroup, snc, sncGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: userLabel
        in: query
        description: User label
        style: form
        explode: true
        schema:
          type: string
      - name: managementName
        in: query
        description: Management Name
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: (Optional) The child FRE identifier to return its parents
        style: form
        explode: true
        schema:
          type: string
      - name: exclude
        in: query
        description: (Optional) The given type would be excluded from get parents call, only combine with childFreId
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/exclude1'
          - description: (Optional) The given type would be excluded from get parents call, only combine with childFreId
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) Find roadmlines by srlg values separated by comma. A roadmline is a FRE between two SAM cards.
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: deploymentState
        in: query
        description: (Optional) deploymentState parameter used to filter results
        style: form
        explode: true
        schema:
          type: string
      - name: active
        in: query
        description: (Optional) The active state of the resource
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/active1'
          - description: (Optional) The active state of the resource
      - name: namedQuery
        in: query
        description: '(Optional) Comma-separated named query id list; The allowed values are: resiliency, tdmServices, topologicalLinks, roadmLineSpan'
        style: form
        explode: true
        schema:
          type: string
      - name: directionality
        in: query
        description: (Optional) Indicates if unidirectional or bidirectional FREs should be returned
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/directionality51'
          - description: (Optional) Indicates if unidirectional or bidirectional FREs should be returned
      - name: networkRole
        in: query
        description: (Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/networkRole41'
          - description: (Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
      - name: type
        in: query
        description: 'FRE types in comma separated list. The allowed values are: service, link, roadmline-ap, roadmline'
        style: form
        explode: true
        schema:
          type: string
      - name: serviceClass
        in: query
        description: (Optional) Allow filtering on the FRE service class. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/serviceClass51'
          - description: (Optional) Allow filtering on the FRE service class. This parameter accepts a list of comma separated values
      - name: layerRateQualifier
        in: query
        description: (Optional) Indicates additional qualification information for a LayerRate. For example, for beyond 100G rates (e.g. OTUCn, ODUCn), defines the n multiplier, or the n-M subrate value.
        style: form
        explode: true
        schema:
          type: string
      - name: supportedByFreId
        in: query
        description: (Optional) Retrieves all supported parent FREs (one serviceClass/layer level up) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: supportingFreId
        in: query
        description: (Optional) Retrieves all supporting child FREs (one serviceClass/layer level down) that have a serviceClass designation for the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: customerName
        in: query
        description: (Optional) Search for an exact match on customerName
        style: form
        explode: true
        schema:
          type: string
      - name: sncgUserlabel
        in: query
        description: '(Optional) For Control Plane SNCs only: Retrieves all SNCs provided the parent SNCG userLabel'
        style: form
        explode: true
        schema:
          type: string
      - name: tunnelType
        in: query
        description: '(Optional) Allow filtering on FRE Tunnel class service. This parameter accepts a list of comma separated values: dynamic, static'
        style: form
        explode: true
        schema:
          type: string
      - name: adminState
        in: query
        description: '(Optional) Allow filtering on FRE adminState. This parameter accepts a list of comma separated values: enabled, disabled, not applicable, In Service, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: operationState
        in: query
        description: '(Optional) Allow filtering on FRE operationState. This parameter accepts a list of comma separated values: fully operating, not operating, degraded operation, Not Applicable, Undetermined, In Service, Degraded, Out of Service External, Out of Service'
        style: form
        explode: true
        schema:
          type: string
      - name: lqsData.status
        in: query
        description: (Optional) Allow filtering on the LQS status. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.status1'
          - description: (Optional) Allow filtering on the LQS status. This parameter accepts a list of comma separated values
      - name: lqsData.margin.valid
        in: query
        description: (Optional) The LQS margin validity state
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.margin.valid1'
          - description: (Optional) The LQS margin validity state
      - name: lqsData.fiber.reconciled
        in: query
        description: (Optional) The LQS fiber reconciled state
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.fiber.reconciled1'
          - description: (Optional) The LQS fiber reconciled state
      - name: lqsData.fiber.method
        in: query
        description: (Optional) Allow filtering on the LQS fiber method. This parameter accepts a list of comma separated values
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/lqsData.fiber.method1'
          - description: (Optional) Allow filtering on the LQS fiber method. This parameter accepts a list of comma separated values
      - name: lqsData.margin.viableAtEol
        in: query
        description: (Optional) A list of LQS margin viable at EOL states
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.totalExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth totalExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.availableExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth availableExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.unavailableExplicitRoutes
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth unavailableExplicitRoutes
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.availablePercentage
        in: query
        description: ((Optional) Allow filtering on FRE restorationHealth availablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.unavailablePercentage
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth unavailablePercentage
        style: form
        explode: true
        schema:
          type: string
      - name: restorationHealth.homeAvailable
        in: query
        description: (Optional) Allow filtering on FRE restorationHealth homeAvailable
        style: form
        explode: true
        schema:
          type: string
      - name: coroutedFreId
        in: query
        description: (Optional) Retrieves all correlated FREs that are co-routed and co-terminated with the specified FRE Id
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: (Optional) Allow filtering on FRE tags. This parameter accepts a list of comma separated strings
        style: form
        explode: true
        schema:
          type: string
      - name: displayAdminState
        in: query
        description: (Optional) Allow filtering on FRE adminState display string
        style: form
        explode: true
        schema:
          type: string
      - name: displayOperationState
        in: query
        description: (Optional) Allow filtering on FRE operationState display string
        style: form
        explode: true
        schema:
          type: string
      - name: displayTopologySource
        in: query
        description: (Optional) Allow filtering on FRE topologySource display string. Currently will only be set to 'Retained' on Fres
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: (Optional) List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: metaDataFields
        in: query
        description: 'MetaData to be included. The allowed values are: layerRate, layerRateQualifier, signalContentType, serviceClass, sncgUserlabel, adminState, operationState, lqsData.status, lqsData.margin.valid, lqsData.fiber.reconciled, lqsData.fiber.method, lqsData.margin.viableAtEol, displayAdminState, displayOperationState, displayTopologySource, customerName'
        style: form
        explode: true
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, networkConstructs, planned, freDiscovered, frePlanned'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 996 - nsiapiv4fres
      summary: postFreV4
      description: >-
        This REST API is intended to be used by service provisioning micro-service IFD only to create a FRE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>layerRate, networkRole, directionality, topologySources, etc.<li>endpoint id relationships<li>network construct id relationship if the FRE is nodal<li>id relationship to other FREs if applicable<li>a list of FRE expectation id relationships<li>the endpoint content - specified in the included section<ul><li>role, directionality, etc.<li>tpe id relationships</ul><li>the FRE expectation content - specified in the included section<ul><li> validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs.<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "-3117193564021298218",
            "type": "fres",
            "attributes": {
              "userLabel": "drop4_OCH_planned",
              "mgmtName": "service_1",
              "layerRate": "OTSi",
              "networkRole": "FREAP",
              "directionality": "unidirectional",
              "topologySources": [
                "stitched"
              ]
            },
            "relationships": {
              "endPoints": {
                "data": [
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:1"
                  },
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:2"
                  }
                ]
              },
              "partitionFres": {
                "data": [
                  {
                    "type": "fres",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::FRE_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_1-5-CTPServerToClient-1547.72_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_21-7-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "721516201499390732"
                  },
                  {
                    "type": "fres",
                    "id": "6739849242751075618"
                  },
                  {
                    "type": "fres",
                    "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::FRE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_1-8-CTPServerToClient-1547.72_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_21-8-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "1808637606701600683"
                  }
                ]
              },
              "freExpectations": {
                "data": [
                  {
                    "type": "freExpectations",
                    "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "-3117193564021298218:1",
              "type": "endPoints",
              "attributes": {
                "role": "a",
                "directionality": "receive ingress",
                "associations": [
                   {
                       "orderIndex": 1,
                       "routeType": "home",
                       "relationship": "tpes"
                   }
                 ]
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218:2",
              "type": "endPoints",
              "attributes": {
                "role": "z",
                "directionality": "transmit egress"
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8",
              "type": "freExpectations",
              "attributes": {
                "modelType": "controlPlane",
                "userLabel": "userLabel1",
                "layerRate": "OTSi",
                "networkRole": "IFRE",
                "directionality": "bidirectional",
                "photonicSpectrumPackage": {
                   "frequency": "196.075000:196.125000",
                   "minFreq": "195.975000:196.025000",
                   "maxFreq": "195.775000:195.825000"
                  },
                "validateParameters": {
                  "include": "layerRate"
                }
               },
              "relationships": {
                 "endPoints": {
                     "data": [
                         {
                           "type": "endPoints",
                           "id": "1"
                         },
                         {
                           "type": "endPoints",
                           "id": "2"
                         }
                     ]
                 },
                "networkConstruct": {
                   "data": {
                      "type": "networkConstructs",
                      "id": "ncId1"
                   }
                },
                "serviceIntent": {
                  "data": {
                    "type": "serviceIntents",
                    "id": "eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                }
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postFreV4
      parameters: []
      requestBody:
        description: FRE to create
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreRO'
              - description: FRE to create
        required: false
      responses:
        '201':
          description: FRE and its expectation created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/fres/{freId}:
    get:
      tags:
      - 996 - nsiapiv4fres
      summary: getFreByIdV4
      description: Retrieves a specific FRE
      operationId: getFreByIdV4
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, abstracts, srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - 996 - nsiapiv4fres
      summary: putFreByIdV4
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putFreByIdV4
      parameters:
      - name: freId
        in: path
        description: FRE identifier.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new FRE data.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreRO'
              - description: The new FRE data.
        required: true
      responses:
        '200':
          description: FRE has been updated successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to update FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 996 - nsiapiv4fres
      summary: patchOperationV4
      description: >
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current fre resource.<p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "note" : {
                           "noteMsg" : "This is an updated message on an Fre",
                           "lastUpdatedBy" : "userName"
                       },
                       "customerName" : "This is the customer name on an Fre"
        ,               "restorationHealth" : {
                           "totalExplicitRoutes": 10,
                           "availableExplicitRoutes": 5,
                           "homeAvailable": true
                        },
                       "lqsData" : {
                           "status" : "good",
                           "margin" : {
                               "minMargin" : -1.0,
                               "upgrMargin" : -1.0,
                               "sdMargin" : -1.0,
                               "valid" : true,
                               "viableAtEol" : "exceeded"
                           },
                           "fiber" : {
                               "measuredLoss" : -1.0,
                               "modeledLoss" : -1.0,
                               "deltaLoss" : -1.0,
                               "modeledMargin" : -1.0,
                               "method" : "osc",
                               "reconciled" : true
                           }
                       }
                    }
                }
            ]
        }

        </code></pre><p>Example replace request to override a ROADMLine's utilization total capacity:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "path": "data/attributes/utilizationData/overrideTotalCapacity",
              "attributes": {
                "utilizationData": {
                  "overrideTotalCapacity": "4.400"
                }
              }
            }
          ]
        }</code></pre><p>Example replace request to set an SNC refresh state:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "path": "data/attributes/serviceRefresh",
              "attributes": {
                "serviceRefresh": {
                  "state": "Pending"
                }
              }
            }
          ]
        }</code></pre><p>Example delete request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "note"
                }
            ]
        }

        </code></pre><p>Example delete request FRE utilization total capacity override value:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "path": "data/attributes/utilizationData/overrideTotalCapacity"
                }
            ]
        }</code></pre><p>Example delete request SNC refresh state:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "path": "data/attributes/serviceRefresh"
                }
            ]
        }</code></pre>Doing a replace on srlg with an empty list will delete the srlg attribute
      operationId: patchOperationV4
      parameters:
      - name: freId
        in: path
        description: The id of the fre to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given fre.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePatchRO'
              - description: A patch request to the given fre.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/fres/{freId}/expectationMismatches:
    get:
      tags:
      - 996 - nsiapiv4fres
      summary: getFreExpectationMismatchesV4
      description: <p>Mismatch for each FRE in the FRE subtree are returned
      operationId: getFreExpectationMismatchesV4
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v4/fres/{freId}/expectations/{freExpId}:
    patch:
      tags:
      - 996 - nsiapiv4fres
      summary: PatchpatchFreExpectation
      description: >
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current fre resource.</code></pre><p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "srlg" : ["srlg1", "srlg2"]
                    }
                }
            ]
        }

        </code></pre>Doing a replace on srlg with an empty list will delete the srlg attribute
      operationId: PatchpatchFreExpectation
      parameters:
      - name: freId
        in: path
        description: The id of the fre to be updated
        required: true
        style: simple
        schema:
          type: string
      - name: freExpId
        in: path
        description: The id of the freExpectation to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given fre.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePatchRO'
              - description: A patch request to the given fre.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FreExpectationRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v4/fres/{freId}/frePlanned:
    get:
      tags:
      - 996 - nsiapiv4fres
      summary: getFrePlannedById
      description: Retrieves the planned FRE by specific FRE ID
      operationId: getFrePlannedById
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE Planned to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, equipment'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - 996 - nsiapiv4fres
      summary: putFrePlannedV4
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: putFrePlannedV4
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Planned FRE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePlannedRO'
              - description: Planned FRE to create or update
        required: false
      responses:
        '201':
          description: Planned FRE created/updated successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create a planned FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    patch:
      tags:
      - 996 - nsiapiv4fres
      summary: PatchpatchPlannedFre
      description: >-
        Upon request accepted, code 202 is returned and the output consists of JSON objects representing current fre resource.<p>Example replace request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "replace",
                    "attributes" : {
                       "userLabel" : "newLabel",
                       "description" : "This is the description on an Fre"
        ,            }
                }
            ]
        }

        </code></pre><p>Example delete request:</p><pre style='font-size: smaller'><code class='json'>{
            "operations" : [
                {
                    "op" : "delete",
                    "attribute" : "userLabel"
                }
            ]
        }

        </code></pre><p>Example Payload for Srlg Patch Operation</p>

        <pre style='font-size: smaller'><code class='json'>{

        "operations": [

        {

        "op": "srlgPatch",

        "srlgRelationships": {

        "dynamicAutoSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "manualSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "dynamicPropagatedSRLG": {

        "data": [

        {

        "id": "string",

        "type": "srlg",

        "attributes": {}

        }

        ]

        },

        "srlgPatchTime": "string"

        }

        }

        ]

        }

        </code></pre>
      operationId: PatchpatchPlannedFre
      parameters:
      - name: freId
        in: path
        description: The id of the fre to be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given fre.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FrePatchRO'
              - description: A patch request to the given fre.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/FrePlannedRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres:
    get:
      tags:
      - 997 - nsiapiv3fres
      summary: getFresV3
      description: >-
        <p>At least one of the following parameters must be specified:<ul><li>tpeId<li>networkConstruct.id<li>group<li>freExpectations.serviceIntent.id<li>freExpectations.equipmentIntent.id<li>childFreId<li>endpoint.tpe.concrete<li>identifiers</ul>

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKeys=key1,key2,...&identifierValues=value1,value2,...
        For instance:
             ?identifierKey=ossLabel&identifierValue=ossLabel
      operationId: getFresV3
      parameters:
      - name: tpeId
        in: query
        description: TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: group
        in: query
        description: FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/group41'
          - description: FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
      - name: freExpectations.serviceIntent.id
        in: query
        description: The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: The child FRE identifier to return its parents
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifer object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: type
        in: query
        description: '(Optional) FRE types in comma separated list. The allowed values are: service, link, roadmline-ap, roadmline'
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: (Optional) Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, planned (roadmlines), frePlanned, freDiscovered, srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: layerRate
        in: query
        description: '(Optional) FRE layer rates in comma separated list. The allowed values are: ETHERNET, OTU2, OTU4, OTSi, OMS, OS, PHY, OTS, ODU2, ODU4, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET'
        style: form
        explode: true
        schema:
          type: string
      - name: freType
        in: query
        description: '(Optional) FRE types in comma separated list. The allowed values are: explicitRoute, explicitRouteGroup, snc, sncGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: userLabel
        in: query
        description: (Optional) User label
        style: form
        explode: true
        schema:
          type: string
      - name: managementName
        in: query
        description: (Optional) Management Name
        style: form
        explode: true
        schema:
          type: string
      - name: exclude
        in: query
        description: (Optional) The given type would be excluded from get parents call, only combine with childFreId
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/exclude1'
          - description: (Optional) The given type would be excluded from get parents call, only combine with childFreId
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) Find roadmlines by srlg values separated by comma. A roadmline is a FRE between two SAM cards.
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: includeMetaData
        in: query
        description: '(Optional) MetaData to be included. The allowed values are: layerRate'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of FREs.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/fres/deploymentState:
    put:
      tags:
      - 997 - nsiapiv3fres
      summary: putFreDeploymentState
      description: <p>One of the following parameters must be specified:<ul><li>freExpectations.serviceIntent.id<li>top-level freId</ul>
      operationId: putFreDeploymentState
      parameters:
      - name: freExpectations.serviceIntent.id
        in: query
        description: The service intent Id. Mutually exclusive with freId
        style: form
        explode: true
        schema:
          type: string
      - name: freId
        in: query
        description: Top-level FRE Identifier. Mutually exclusive with freExpectations.serviceIntent.id
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: The desired deployment state value
        content:
          text/plain:
            schema:
              type: string
              description: The desired deployment state value
        required: true
      responses:
        '200':
          description: The DeploymentState was changed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: There are no FREs for the specified intent ID or top-level fre ID
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/fres/{freId}:
    get:
      tags:
      - 997 - nsiapiv3fres
      summary: GetgetFreById
      description: Retrieves a specific FRE
      operationId: GetgetFreById
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE to be retrieved
        required: true
        style: simple
        schema:
          type: string
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: fres, tpes, networkConstructs, equipment, expectations, frePlanned, freDiscovered, srlgs'
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find the FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve FRE with given Id
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    delete:
      tags:
      - 997 - nsiapiv3fres
      summary: unprovisionV3
      description: De-provision an actul FRE or  delete a root FRE
      operationId: unprovisionV3
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The de-provisioning request was sent or FRE is deleted successfully.
          headers: {}
          content: {}
        '204':
          description: FRE does not exist.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to delete specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres/{freId}/adminState:
    put:
      tags:
      - 997 - nsiapiv3fres
      summary: putFreAdminStateV3
      description: Set the AdminState of an FRE
      operationId: putFreAdminStateV3
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired adminState value
        content:
          text/plain:
            schema:
              type: string
              description: The desired adminState value
        required: true
      responses:
        '200':
          description: The AdminState was changed successfully
          headers: {}
          content: {}
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres/{freId}/discovered/validate:
    post:
      tags:
      - 997 - nsiapiv3fres
      summary: validateDiscoveredAgainstPlanned
      description: The validation is hierarchical and includes  all children (decomposed or partitioned) FREs in the tree of the specified parent FRE
      operationId: validateDiscoveredAgainstPlanned
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Validation was performed successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Provisioning request failed against FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres/{freId}/expectations:
    post:
      tags:
      - 997 - nsiapiv3fres
      summary: postFREExpectationV3
      description: >-
        <p>This REST API is intended to be used by service provisioning micro-service IFD only to create or update an FRE expectation on existing FRE.<p>The following attributes and relationships should be specified in the post request:<ul><li>layerRate, networkRole, directionality, topologySources, etc.<li>endpoint id relationships<li>network construct id relationship if the FRE is nodal<li>id relationship to other FREs if applicable<li>a list of FRE expectation id relationships<li>the endpoint content - specified in the included section<ul><li>role, directionality, etc.<li>tpe id relationships</ul><li>the FRE expectation content - specified in the included section<ul><li>service intent id relationship</ul></ul><p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs.<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "SNCG(2)-57f3cccb-6918-4ce1-949f-0dff34a8a501",
            "type": "freExpectations",
            "attributes": {
              "directionality": "bidirectional",
              "userLabel": "BP SNCG",
              "networkRole": "IFRE",
              "layerRate": "OMS",
              "modelType": "controlPlane",
              "freType": "sncGroup",
              "routingConstraints": {
                "isRouteExclusive": "true",
                "identifier": "c807e13a-6ec6-48c4-a4cd-38afe40fdd39"
              }
            },
            "relationships": {
              "serviceIntent": {
                "data": {
                  "type": "serviceIntents",
                  "id": "57f3cccb-6918-4ce1-949f-0dff34a8a501"
                }
              },
              "endPoints": {
                "data": [
                  {
                    "type": "endPoints",
                    "id": "1"
                  },
                  {
                    "type": "endPoints",
                    "id": "2"
                  }
                ]
              },
              "networkConstruct": {
                "data": {
                  "type": "networkConstructs",
                  "id": "2452f453-fb13-4ebb-bee5-d32ac520611c"
                }
              }
            }
          },
          "included": [
            {
              "id": "1",
              "type": "endPoints",
              "attributes": {
                "role": "a",
                "associations": [
                  {
                    "relationship": "networkConstructs",
                    "identifier": {
                      "osrpNodeName": "PV0037FGD"
                    }
                  }
                ]
              },
              "relationships": {}
            },
            {
              "id": "2",
              "type": "endPoints",
              "attributes": {
                "role": "z",
                "associations": [
                  {
                    "relationship": "networkConstructs",
                    "identifier": {
                      "osrpNodeName": "PV0037FGA"
                    }
                  }
                ]
              },
              "relationships": {}
            }
          ]
        }

        </code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postFREExpectationV3
      parameters:
      - name: freId
        in: path
        description: Identifier of the FRE under which to create the expectation
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request to create an FRE expectation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreExpectationRO'
              - description: Request to create an FRE expectation
        required: false
      responses:
        '200':
          description: An existing FRE expectation have been updated on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '201':
          description: FRE expectation has been created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres/{freId}/expectations/{expectationId}/realize:
    post:
      tags:
      - 997 - nsiapiv3fres
      summary: provisionOperationsV3
      description: If FRE is not realized, it will trigger a create provisioning operation, otherwise it will trigger a update provisioning operation to change the current discovered data.
      operationId: provisionOperationsV3
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: expectationId
        in: path
        description: FreExpectation to realize
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Request to provision was sent successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Provisioning request failed against FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres/{freId}/freExpectations/{freExpectationId}:
    delete:
      tags:
      - 997 - nsiapiv3fres
      summary: deleteFreExpectationByIdV3
      description: Delete a FRE Expectaion given the fre id and expectation id
      operationId: deleteFreExpectationByIdV3
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: freExpectationId
        in: path
        description: FRE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted FRE Expectation successfully.
          headers: {}
          content: {}
        '204':
          description: FRE Expectation does not exist.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: FRE does not exist.
          headers: {}
          content: {}
        '500':
          description: Failed to delete FRE Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres/{freId}/identifiers:
    put:
      tags:
      - 997 - nsiapiv3fres
      summary: updateFreIdentifierV3
      description: '<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updateFreIdentifierV3
      parameters:
      - name: freId
        in: path
        description: The FRE id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The identifier JSON object
        content:
          application/json:
            schema:
              type: object
              description: The identifier JSON object
        required: true
      responses:
        '200':
          description: Successfully updated the FRE identifier for a given FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '201':
          description: Successfully created a new FRE identifier for the given FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3fres
      summary: deleteFreIdentifierV3
      description: Deletes the FRE identifier from a given FRE
      operationId: deleteFreIdentifierV3
      parameters:
      - name: freId
        in: path
        description: The FRE id
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Unsuccessfully deleted the FRE identifier
          headers: {}
          content: {}
        '204':
          description: Successfully deleted the FRE identifier
          headers: {}
          content: {}
        '400':
          description: Bad parameters were passed, please check the identifier object for errors
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist or their was error processing information
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/fres/{freId}/validationExpectation:
    put:
      tags:
      - 997 - nsiapiv3fres
      summary: postFrePlannedWithExpectation
      description: >-
        This REST API is intended to be used by service provisioning micro-service IFD only to create or update a FRE validation expectation. On initial creation, FRE expectations can be specified and created as well, on update, only the FRE validation expectation can be updated<p>The following attributes and relationships should be specified in the post request for initial creation:<ul><li>layerRate, networkRole, directionality, topologySources, etc.<li>endpoint id relationships<li>network construct id relationship if the FRE is nodal<li>id relationship to other FREs if applicable<li>a list of FRE expectation id relationships<li>the endpoint content - specified in the included section<ul><li>role, directionality, etc.<li>tpe id relationships</ul><li>the FRE expectation content - specified in the included section<ul><li> validateParameters - Comma separated list of parameters (if any) to be validated against the expectation</ul></ul><p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs.<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "-3117193564021298218",
            "type": "fres",
            "attributes": {
              "userLabel": "drop4_OCH_planned",
              "mgmtName": "service_1",
              "layerRate": "OTSi",
              "networkRole": "FREAP",
              "directionality": "unidirectional",
              "topologySources": [
                "stitched"
              ],
              "additionalAttributes": {
                "isActual": "false"
              }
            },
            "relationships": {
              "endPoints": {
                "data": [
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:1"
                  },
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:2"
                  }
                ]
              },
              "partitionFres": {
                "data": [
                  {
                    "type": "fres",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::FRE_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_1-5-CTPServerToClient-1547.72_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_21-7-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "721516201499390732"
                  },
                  {
                    "type": "fres",
                    "id": "6739849242751075618"
                  },
                  {
                    "type": "fres",
                    "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::FRE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_1-8-CTPServerToClient-1547.72_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_21-8-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "1808637606701600683"
                  }
                ]
              },
              "freExpectations": {
                "data": [
                  {
                    "type": "freExpectations",
                    "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "-3117193564021298218:1",
              "type": "endPoints",
              "attributes": {
                "role": "a",
                "directionality": "receive ingress",
                "associations": [
                   {
                     "orderIndex": 1,             "routeType": "home",             "relationship": "tpes"           }
                 ]
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218:2",
              "type": "endPoints",
              "attributes": {
                "role": "z",
                "directionality": "transmit egress"
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8",
              "type": "freExpectations",
              "attributes": {
                "modelType": "controlPlane",
                "userLabel": "userLabel1",
                "layerRate": "OTSi",
                "networkRole": "IFRE",
                "directionality": "bidirectional",
                "photonicSpectrumPackage": {
                   "frequency": "196.075000:196.125000",
                   "minFreq": "195.975000:196.025000",
                   "maxFreq": "195.775000:195.825000"
                  },
                "validateParameters": {
                  "include": "layerRate"
                }
               },
              "relationships": {
                 "endPoints": {
                     "data": [
                         {
                           "type": "endPoints",
                           "id": "1"
                         },
                         {
                           "type": "endPoints",
                           "id": "2"
                         }
                     ]
                 },
                "networkConstruct": {
                   "data": {
                      "type": "networkConstructs",
                      "id": "ncId1"
                   }
                },
                "serviceIntent": {
                  "data": {
                    "type": "serviceIntents",
                    "id": "eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                }
              }
            }
          ]
        }</code></pre>
      operationId: postFrePlannedWithExpectation
      parameters:
      - name: freId
        in: path
        description: FRE identifier.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: FRE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreRO'
              - description: FRE to create or update
        required: false
      responses:
        '201':
          description: validation FRE and its expectations created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to create or update FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/fres:
    get:
      tags:
      - 998 - nsiapiv2_0fres
      summary: getFre
      description: >-
        <p>At least one of the following parameters must be specified:<ul><li>tpeId<li>networkConstruct.id<li>ncId (Deprecated)<li>group<li>freExpectations.serviceIntent.id<li>freExpectations.equipmentIntent.id<li>childFreId<li>endpoint.tpe.concrete<li>identifiers (Deprecated)<li>identifierKey & identifierValue</ul>

        Note: when querying by identifiers, the supported syntax is as follows:
             ?identifierKeys=key1,key2,...&identifierValues=value1,value2,...
        For instance:
             ?identifierKey=ossLabel&identifierValue=ossLabel
        Note: In place of a blank space you can also use + or %20
      operationId: getFre
      parameters:
      - name: tpeId
        in: query
        description: TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: (Deprecated) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: networkConstruct.id
        in: query
        description: Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'FRE types in comma separated list. The allowed values are: service, link, roadmline-ap, roadmline'
        style: form
        explode: true
        schema:
          type: string
      - name: group
        in: query
        description: FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/group6'
          - description: FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: include
        in: query
        description: '(Optional) List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations'
        style: form
        explode: true
        schema:
          type: string
      - name: layerRate
        in: query
        description: 'FRE layer rates in comma separated list The allowed values are: ETHERNET, OTU2, OTU4, OTSi, OMS, OS, PHY, OTS, ODU2, ODU4, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET'
        style: form
        explode: true
        schema:
          type: string
      - name: freType
        in: query
        description: 'FRE types in comma separated list The allowed values are: explicitRoute, explicitRouteGroup, snc, sncGroup'
        style: form
        explode: true
        schema:
          type: string
      - name: userLabel
        in: query
        description: User label
        style: form
        explode: true
        schema:
          type: string
      - name: managementName
        in: query
        description: Management Name
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.serviceIntent.id
        in: query
        description: (Optional) The service intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: freExpectations.equipmentIntent.id
        in: query
        description: (Optional) The equipment intent Id
        style: form
        explode: true
        schema:
          type: string
      - name: childFreId
        in: query
        description: (Optional) The child FRE identifier to return its parents
        style: form
        explode: true
        schema:
          type: string
      - name: exclude
        in: query
        description: (Optional) The given type would be excluded from get parents call, only combine with childFreId
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/exclude1'
          - description: (Optional) The given type would be excluded from get parents call, only combine with childFreId
      - name: signalContentType
        in: query
        description: (Optional) The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        style: form
        explode: true
        schema:
          type: string
      - name: srlg
        in: query
        description: (Optional) Find roadmlines by srlg values separated by comma. A roadmline is a FRE between two SAM cards.
        style: form
        explode: true
        schema:
          type: string
      - name: roadmLineId
        in: query
        description: (Optional) Find services configured over a roadmline based on the roadmline FRE identifier.
        style: form
        explode: true
        schema:
          type: string
      - name: searchText
        in: query
        description: (Optional) The searchable text
        style: form
        explode: true
        schema:
          type: string
      - name: includeMetaData
        in: query
        description: 'MetaData to be included. The allowed values are: layerRate'
        style: form
        explode: true
        schema:
          type: string
      - name: endpoint.tpe.concrete
        in: query
        description: Concrete TPE identifier for endpoints
        style: form
        explode: true
        schema:
          type: string
      - name: identifierKey
        in: query
        description: List of comma separated keys for an identifer object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identifierValue
        in: query
        description: List of comma separated values for an identifier object
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: fields
        in: query
        description: (Optional) List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        style: form
        explode: true
        schema:
          type: string
      - name: directionality
        in: query
        description: (Optional) Indicates if unidirectional or bidirectional FREs should be returned
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/directionality51'
          - description: (Optional) Indicates if unidirectional or bidirectional FREs should be returned
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the FREs with given query parameter.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
    post:
      tags:
      - 998 - nsiapiv2_0fres
      summary: postFreV2
      description: >-
        This REST API is intended to be used by service provisioning micro-service IFD only to create or update a FRE expectation.<p>The following attributes and relationships should be specified in the post request:<ul><li>layerRate, networkRole, directionality, topologySources, etc.<li>endpoint id relationships<li>network construct id relationship if the FRE is nodal<li>id relationship to other FREs if applicable<li>a list of FRE expectation id relationships<li>the endpoint content - specified in the included section<ul><li>role, directionality, etc.<li>tpe id relationships</ul><li>the FRE expectation content - specified in the included section<ul><li>service intent id relationship</ul></ul><p>Identifier keys and values cannot contain whitespace, square brackets, percent, nor plus signs.<p>The response only has id field populated.<p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "-3117193564021298218",
            "type": "fres",
            "attributes": {
              "userLabel": "drop4_OCH_planned",
              "mgmtName": "service_1",
              "layerRate": "OTSi",
              "networkRole": "FREAP",
              "directionality": "unidirectional",
              "topologySources": [
                "stitched"
              ],
              "additionalAttributes": {
                "isActual": "false"
              }
            },
            "relationships": {
              "endPoints": {
                "data": [
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:1"
                  },
                  {
                    "type": "endPoints",
                    "id": "-3117193564021298218:2"
                  }
                ]
              },
              "partitionFres": {
                "data": [
                  {
                    "type": "fres",
                    "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::FRE_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_1-5-CTPServerToClient-1547.72_aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_11_21-7-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "721516201499390732"
                  },
                  {
                    "type": "fres",
                    "id": "6739849242751075618"
                  },
                  {
                    "type": "fres",
                    "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::FRE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_1-8-CTPServerToClient-1547.72_fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_11_21-8-CTPServerToClient-1547.72"
                  },
                  {
                    "type": "fres",
                    "id": "1808637606701600683"
                  }
                ]
              },
              "freExpectations": {
                "data": [
                  {
                    "type": "freExpectations",
                    "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "-3117193564021298218:1",
              "type": "endPoints",
              "attributes": {
                "role": "a",
                "directionality": "receive ingress",
                "associations": [
                   {
                     "orderIndex": 1,             "routeType": "home",             "relationship": "tpes"           }
                 ]
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "aca92325-0c37-45b4-815d-df8c2c4e7da8::TPE_aca92325-0c37-45b4-815d-df8c2c4e7da8::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218:2",
              "type": "endPoints",
              "attributes": {
                "role": "z",
                "directionality": "transmit egress"
              },
              "relationships": {
                "tpes": {
                  "data": [
                    {
                      "type": "tpes",
                      "id": "fdde6704-5d06-41bb-a3f4-d85db8d8c508::TPE_fdde6704-5d06-41bb-a3f4-d85db8d8c508::EQPT_12_11-1-PTP"
                    }
                  ]
                }
              }
            },
            {
              "id": "-3117193564021298218::eb7542a1-a0af-4bfb-a828-63e1162aa1a8",
              "type": "freExpectations",
              "attributes": {
                "modelType": "controlPlane",
                "userLabel": "userLabel1",
                "layerRate": "OTSi",
                "networkRole": "IFRE",
                "directionality": "bidirectional",
                "photonicSpectrumPackage": {
                   "frequency": "196.075000:196.125000",
                   "minFreq": "195.975000:196.025000",
                   "maxFreq": "195.775000:195.825000"
                  }
               },
              "relationships": {
                 "endPoints": {
                     "data": [
                         {
                           "type": "endPoints",
                           "id": "1"
                         },
                         {
                           "type": "endPoints",
                           "id": "2"
                         }
                     ]
                 },
                "networkConstruct": {
                   "data": {
                      "type": "networkConstructs",
                      "id": "ncId1"
                   }
                },
                "serviceIntent": {
                  "data": {
                    "type": "serviceIntents",
                    "id": "eb7542a1-a0af-4bfb-a828-63e1162aa1a8"
                  }
                }
              }
            }
          ]
        }</code></pre>
      operationId: postFreV2
      parameters: []
      requestBody:
        description: FRE to create or update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreRO'
              - description: FRE to create or update
        required: false
      responses:
        '201':
          description: FRE and its expectation created successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to create or update FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v2_0/fres/{freId}/bookingData/{bookingDataKey}:
    put:
      tags:
      - 998 - nsiapiv2_0fres
      summary: putFreBookingDataV2
      description: <ul><li>Any leading or trailing whitespace will be trimmed from the bookingData<li>assignedBandwidth and assignedBandwidthUnit is not valid on an ETHERNET LLDP Link FRE_AP
      operationId: putFreBookingDataV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: bookingDataKey
        in: path
        description: bookingData attribute name (and allowable values):<ul><li>assignedBandwidth (positive number)<li>assignedBandwidthUnit (mpbs, kbps, or gbps)<li>bandwidthLockout (true, false)<li>bookingFactor (positive number to one decimal place, like 1.0)</ul>
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired bookingData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired bookingData value
        required: true
      responses:
        '200':
          description: FRE bookingData attribute created/updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid parameters specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to modify bookingData on FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0fres
      summary: deleteFreBookingDataV2
      description: Delete a bookingData attribute from an FRE
      operationId: deleteFreBookingDataV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: bookingDataKey
        in: path
        description: bookingData attribute to delete:<ul><li>assignedBandwidth<li>assignedBandwidthUnit<li>bandwidthLockout<li>bookingFactor</ul>
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified bookingData attribute does not exist in FRE.
          headers: {}
          content: {}
        '204':
          description: Deleted FRE bookingData successfully.
          headers: {}
          content: {}
        '400':
          description: Invalid parameters specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete FRE bookingData attribute
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/fres/{freId}/freExpectations:
    get:
      tags:
      - 998 - nsiapiv2_0fres
      summary: getFreExpectationV2
      description: Retrieve FRE Expectations with freId
      operationId: getFreExpectationV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Get FRE Expectations with given id successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreExpectationRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find FRE Expectations for the FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to get FRE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v2_0/fres/{freId}/freExpectations/{freExpectationId}:
    get:
      tags:
      - 998 - nsiapiv2_0fres
      summary: getFreExpectationWithExpIdV2
      description: Retrieve FRE Expectations with freId and expectationId
      operationId: getFreExpectationWithExpIdV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: freExpectationId
        in: path
        description: FRE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Get FRE Expectations with given id successfully.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreExpectationRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Cannot find FRE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to get FRE Expectation with id.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0fres
      summary: deleteFreExpectationByIdV2
      description: Delete a FRE Expectaion given the fre id and expectation id
      operationId: deleteFreExpectationByIdV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: freExpectationId
        in: path
        description: FRE expectation identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted FRE Expectation successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete FRE Expectation.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v2_0/fres/{freId}/provisioningOperations:
    post:
      tags:
      - 998 - nsiapiv2_0fres
      summary: provisionOperationsV2
      description: >-
        Triggers a provisioning operation.  <p> Supports operation values of: <p>&nbsp;&nbsp; 'update',<p> &nbsp;&nbsp;   'delete'<p> If operation is 'delete' all other properties will be ignored. <p> If operation is 'update' the state property is required.  Valid state values are: <p>&nbsp;&nbsp;   'IS',<p> &nbsp;&nbsp;   'OOS',<p> &nbsp;&nbsp;  'OOS_AUMA<p> Here is an example request:<pre style='font-size: smaller'><code class='json'>{
          "data": {
            "id": "-3117193564021298218::FRE_PO_1",
            "attributes": {
              "id": "-3117193564021298218",
              "operation": "delete"
            }
          }
        }</code></pre>
      operationId: provisionOperationsV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: FreProvisioningOperation to execute
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FreProvisioningOperationRO'
              - description: FreProvisioningOperation to execute
        required: true
      responses:
        '201':
          description: Request to provision FRE successfully.
          headers: {}
          content: {}
        '400':
          description: Bad request. Input validation error.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Provisioning request failed against FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v2_0/fres/{freId}/userData/{userDataKey}:
    put:
      tags:
      - 998 - nsiapiv2_0fres
      summary: putFreUserDataV2
      description: Any leading or trailing whitespace will be trimmed from userData.
      operationId: putFreUserDataV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: Key of userData to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The desired userData value
        content:
          text/plain:
            schema:
              type: string
              description: The desired userData value
        required: true
      responses:
        '200':
          description: FRE userData attribute created/updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Invalid parameters specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to modify userData on FRE.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0fres
      summary: deleteFreUserDataV2
      description: Delete a userData attribute from an FRE
      operationId: deleteFreUserDataV2
      parameters:
      - name: freId
        in: path
        description: FRE identifier
        required: true
        style: simple
        schema:
          type: string
      - name: userDataKey
        in: path
        description: userData attribute name to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: The specified userData attribute does not exist in FRE.
          headers: {}
          content: {}
        '204':
          description: Deleted FRE userData attribute successfully.
          headers: {}
          content: {}
        '403':
          description: Forbidden to access specified FRE
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The specified FRE does not exist.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to delete FRE userData attribute
          headers: {}
          content: {}
      deprecated: false
  /nsi/api/v2_0/fres/{id}/identifiers/{identifierKey}:
    put:
      tags:
      - 998 - nsiapiv2_0fres
      summary: updateFreIdentifiers
      description: 'Identifier keys and values cannot contain square brackets, percent, nor plus signs.<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: updateFreIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the FRE under which to create or update the identifier
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to create or update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: identifier
        content:
          application/json:
            schema:
              type: object
              description: identifier
        required: false
      responses:
        '200':
          description: FRE identifier created on the server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreRO'
        '400':
          description: Bad or invalid parameters were provided
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '404':
          description: The specified FRE does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
    delete:
      tags:
      - 998 - nsiapiv2_0fres
      summary: deleteFreIdentifiers
      description: Identifier keys cannot contain whitespace, square brackets, percent, nor plus signs
      operationId: deleteFreIdentifiers
      parameters:
      - name: id
        in: path
        description: Identifier of the FRE whose identifier is to be deleted
        required: true
        style: simple
        schema:
          type: string
      - name: identifierKey
        in: path
        description: Key of the identifier to delete
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Deleted FRE identifier successfully.
          headers: {}
          content: {}
        '404':
          description: The specified FRE or identifier does not exist
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to delete FRE identifier.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /slv-support/api/v1/equipmentGraphics:
    get:
      tags:
      - slv-supportapiv1equipmentGraphics
      summary: getEquipmentGraphic
      description: <p>List of equipment graphics returned in JSON format.<p>At least one of the following parameters must be specified:<ul><li>ncId<li>siteId</ul>
      operationId: getEquipmentGraphic
      parameters:
      - name: siteId
        in: query
        description: (Optional) Site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: (Optional) Network Construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested list of equipment graphics.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentGraphicListRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested list of equipment graphics.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /slv-support/api/v1/equipmentLayouts:
    get:
      tags:
      - slv-supportapiv1equipmentLayout
      summary: getEquipmentLayout
      description: List of Equipment layout returned in JSON format
      operationId: getEquipmentLayout
      parameters:
      - name: siteId
        in: query
        description: (Optional) Site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: (Optional) Network construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) Resource Type
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested list of equipment layout.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentLayoutListRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested list of equipment layout.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /slv-support/api/v1/shelfGraphics:
    get:
      tags:
      - slv-supportapiv1shelfGraphics
      summary: getShelfGraphic
      description: <p>List of shelf graphics returned in JSON format.<p>At least one of the following parameters must be specified:<ul><li>ncId<li>siteId</ul>
      operationId: getShelfGraphic
      parameters:
      - name: siteId
        in: query
        description: (Optional) Site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: (Optional) Network construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested list of shelf graphics.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShelfGraphicListRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested list of shelf graphics.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /slv-support/api/v1/shelfLayouts:
    get:
      tags:
      - slv-supportapiv1shelfLayouts
      summary: getShelfLayout
      description: List of Shelf layout returned in JSON format
      operationId: getShelfLayout
      parameters:
      - name: siteId
        in: query
        description: (Optional) Site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: (Optional) Network construct identifier
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: (Optional) Resource Type
        style: form
        explode: true
        schema:
          type: string
      - name: ipAddress
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested list of shelf layout.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShelfLayoutListRO'
        '400':
          description: Invalid value specified for a query parameter
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '500':
          description: Failed to retrieve the requested list of shelf layout.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /ifd/api/srlgJobs:
    get:
      tags:
      - SRLG Jobs
      summary: getJobs
      description: >-
        <p>LATEST VERSION: V3

        <h3>Description:</h3><br/><p>This API provides functionality to get the Srlg Batch Operation's jobs status using different parameters.</p><br/><strong>*Provide atleast one of the following Parameters*</strong><p><ul><li>JobType<br/></li><li>JobId<br/></li><li>JobStatus<br/></li></ul><br/></p><br/>
      operationId: getJobs
      parameters:
      - name: fromTime
        in: query
        description: Jobs that completed after the given time
        style: form
        explode: true
        schema:
          type: string
      - name: toTime
        in: query
        description: Jobs that completed before the given time
        style: form
        explode: true
        schema:
          type: string
      - name: jobType
        in: query
        description: 'Comma separated type of Job/Srlg Operation. Values could be: auto_assign,clear_auto_assign,write_to_network,propagate,assign_external_srlg, release_external_srlg, propagate_share_srlg, clear_propagated_share_srlg, audit_fb_profile, clear_manual_assign.'
        style: form
        explode: true
        schema:
          type: string
      - name: scheduleName
        in: query
        description: Schedule name to which the Srlg job belongs.
        style: form
        explode: true
        schema:
          type: string
      - name: scope
        in: query
        description: Scope in which the Job would run
        style: form
        explode: true
        schema:
          type: string
      - name: jobStatus
        in: query
        description: 'Status of Job/Srlg Operation.Values could be: in_progress,completed,failed.'
        style: form
        explode: true
        schema:
          type: string
      - name: scheduledOnly
        in: query
        description: 'Is job essentially kicked-off through  schedule API:  By default all jobs would be returned.'
        style: form
        explode: true
        schema:
          type: boolean
      - name: includeDetails
        in: query
        description: Include job details. By default only job status would be returned.
        style: form
        explode: true
        schema:
          type: boolean
      - name: metaFields
        in: query
        description: 'Comma separated. Meta-data fields to include. Options are: jobStatus, jobType, scope, scheduleName'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgJobResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlgJobs/{jobId}:
    get:
      tags:
      - SRLG Jobs
      summary: getJobDetailsV3
      description: >-
        <p>LATEST VERSION: V3

        <h3>Description:</h3><br/><p>This API provides details about the srlg job operation status.Job id obtained from batch operation response needs to be used for tracking srlg operation.</p><br/>
      operationId: getJobDetailsV3
      parameters:
      - name: jobId
        in: path
        description: Id of Job/Srlg Operation for which details needs to be searched
        required: true
        style: simple
        schema:
          type: string
      - name: downloadReport
        in: query
        description: (Optional) Download report Y/N. Default is No. Download  format is  JSON
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgManualJobDetailsOpResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - SRLG Jobs
      summary: DeletedeleteSchedule
      description: ' "<p>LATEST VERSION: V3"'
      operationId: DeletedeleteSchedule
      parameters:
      - name: jobId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Srlg Job deleted
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlgJobs:
    get:
      tags:
      - SRLG Jobs V3
      summary: GetgetJobs
      description: <h3>Description:</h3><br/><p>This API provides functionality to get the Srlg Batch Operation's jobs status using different parameters.</p><br/><strong>*Provide atleast one of the following Parameters*</strong><p><ul><li>JobType<br/></li><li>JobId<br/></li><li>JobStatus<br/></li></ul><br/></p><br/>
      operationId: GetgetJobs
      parameters:
      - name: fromTime
        in: query
        description: Jobs that completed after the given time
        style: form
        explode: true
        schema:
          type: string
      - name: toTime
        in: query
        description: Jobs that completed before the given time
        style: form
        explode: true
        schema:
          type: string
      - name: jobType
        in: query
        description: 'Comma separated type of Job/Srlg Operation. Values could be: auto_assign,clear_auto_assign,write_to_network,propagate,assign_external_srlg, release_external_srlg, propagate_share_srlg, clear_propagated_share_srlg, audit_fb_profile, clear_manual_assign.'
        style: form
        explode: true
        schema:
          type: string
      - name: scheduleName
        in: query
        description: Schedule name to which the Srlg job belongs.
        style: form
        explode: true
        schema:
          type: string
      - name: scope
        in: query
        description: Scope in which the Job would run
        style: form
        explode: true
        schema:
          type: string
      - name: jobStatus
        in: query
        description: 'Status of Job/Srlg Operation.Values could be: in_progress,completed,failed.'
        style: form
        explode: true
        schema:
          type: string
      - name: scheduledOnly
        in: query
        description: 'Is job essentially kicked-off through  schedule API:  By default all jobs would be returned.'
        style: form
        explode: true
        schema:
          type: boolean
      - name: includeDetails
        in: query
        description: Include job details. By default only job status would be returned.
        style: form
        explode: true
        schema:
          type: boolean
      - name: metaFields
        in: query
        description: 'Comma separated. Meta-data fields to include. Options are: jobStatus, jobType, scope, scheduleName'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Jobs returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgJobResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlgJobs/{jobId}:
    get:
      tags:
      - SRLG Jobs V3
      summary: GetgetJobDetailsV3
      description: <h3>Description:</h3><br/><p>This API provides details about the srlg job operation status.Job id obtained from batch operation response needs to be used for tracking srlg operation.</p><br/>
      operationId: GetgetJobDetailsV3
      parameters:
      - name: jobId
        in: path
        description: Id of Job/Srlg Operation for which details needs to be searched
        required: true
        style: simple
        schema:
          type: string
      - name: downloadReport
        in: query
        description: (Optional) Download report Y/N. Default is No. Download  format is  JSON
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgManualJobDetailsOpResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - SRLG Jobs V3
      summary: deleteSrlgJob
      description: Delete Srlg Job for given Id
      operationId: deleteSrlgJob
      parameters:
      - name: jobId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Srlg Job deleted
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlgSchedules:
    get:
      tags:
      - SRLG Schedules
      summary: getAllSchedules
      description: ' "<p>LATEST VERSION: V3"'
      operationId: getAllSchedules
      parameters:
      - name: scheduleName
        in: query
        description: Schedule name to which the Srlg job belongs.
        style: form
        explode: true
        schema:
          type: string
      - name: scope
        in: query
        description: Scope in which the Job would run
        style: form
        explode: true
        schema:
          type: string
      - name: jobType
        in: query
        description: 'Type of Job/Srlg Operation.Values could be: auto_assign,clear_auto_assign,write_to_network,propagate,assign_external_srlg, release_external_srlg, propagate_share_srlg, clear_propagated_share_srlg, audit_fb_profile, clear_manual_assign.'
        style: form
        explode: true
        schema:
          type: string
      - name: frequency
        in: query
        description: 'Schedule frequency. Possible values are: ONCE, DAILY, WEEKLY, MONTHLY'
        style: form
        explode: true
        schema:
          type: string
      - name: metaFields
        in: query
        description: 'Comma separated. Meta-data fields to include. Options are: jobType, scope, scheduleName, frequency'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: All Srlg Schedule Jobs returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgSchedulesResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Scheduler Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - SRLG Schedules
      summary: PostcreateSchedule1
      description: >2
         "<p>LATEST VERSION: V3"
        <h3>Description :</h3><p>This request is intended for SRLG(s) Schedule Creation.<p><h3>Schema Description: </h3><strong>scheduleName: </strong> unique name for schedule <br/><strong>scopeType: </strong> network<br/><strong>jobs: </strong> jobs to schedule<br/></p><br/><p>Here are some example requests:</p>

        ```json

        Schedule Later :


        {
          "data": {
              "type": "srlgJobsSchedule",
            "attributes": {
              "scheduleName": "Schedule1",
              "scopeType": "network",
              "cronExpression": "5 11 7 1/1 * ? *",
              "cronExpressionFormat": "Quartz",
            "jobs": [
         "auto_assign",
        "propagate",
         "write_to_network"
         ]
          }
        }

        }


        Schedule Now For Scope network:


        {
          "data": {
              "type": "srlgJobsSchedule",
            "attributes": {
              "scheduleName": "Schedule1",
              "scopeType": "Network",
            "jobs": [
         "auto_assign",
        "propagate",
         "write_to_network"
         ]
          }
        }

        }


        Schedule Now For Scope subNetwork:


        {
          "data": {
              "type": "srlgJobsSchedule",
            "attributes": {
              "scheduleName": "Schedule1",
              "scopeType": "subNetwork",
              "scopeValue": "EastRegion",
            "jobs": [
         "auto_assign",
        "propagate",
         ]
          }
        }

        }
      operationId: PostcreateSchedule1
      parameters: []
      requestBody:
        description: SRLG Schedule Job request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgScheduleRequest'
              - description: SRLG Schedule Job request
        required: true
      responses:
        '201':
          description: SRLG Schedule Created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgScheduleResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlgSchedules/allowedJobs:
    get:
      tags:
      - SRLG Schedules
      summary: getAllowedJobs
      description: ' "<p>LATEST VERSION: V3"'
      operationId: getAllowedJobs
      parameters: []
      responses:
        '200':
          description: Display models for SRLG Scheduler UI returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgScheduleModelsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Display models for SRLG Scheduler UI not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/srlgSchedules/{scheduleId}:
    delete:
      tags:
      - SRLG Schedules
      summary: DeletedeleteSchedule1
      description: ' "<p>LATEST VERSION: V3"'
      operationId: DeletedeleteSchedule1
      parameters:
      - name: scheduleId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Srlg Schedule  deleted
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Schedule  not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlgSchedules:
    get:
      tags:
      - SRLG Schedules v3
      summary: GetgetAllSchedules
      description: Get all SRLG Job schedules
      operationId: GetgetAllSchedules
      parameters:
      - name: scheduleName
        in: query
        description: Schedule name to which the Srlg job belongs.
        style: form
        explode: true
        schema:
          type: string
      - name: scope
        in: query
        description: Scope in which the Job would run
        style: form
        explode: true
        schema:
          type: string
      - name: jobType
        in: query
        description: 'Type of Job/Srlg Operation.Values could be: auto_assign,clear_auto_assign,write_to_network,propagate,assign_external_srlg, release_external_srlg, propagate_share_srlg, clear_propagated_share_srlg, audit_fb_profile, clear_manual_assign.'
        style: form
        explode: true
        schema:
          type: string
      - name: frequency
        in: query
        description: 'Schedule frequency. Possible values are: ONCE, DAILY, WEEKLY, MONTHLY'
        style: form
        explode: true
        schema:
          type: string
      - name: metaFields
        in: query
        description: 'Comma separated. Meta-data fields to include. Options are: jobType, scope, scheduleName, frequency'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: All Srlg Schedule Jobs returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgSchedulesResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Scheduler Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - SRLG Schedules v3
      summary: PostcreateSchedule2
      description: >
        <h3>Description :</h3><p>This request is intended for SRLG(s) Schedule Creation.<p><h3>Schema Description: </h3><strong>scheduleName: </strong> unique name for schedule <br/><strong>scopeType: </strong> network<br/><strong>jobs: </strong> jobs to schedule<br/></p><br/><p>Here are some example requests:</p>

        ```json

        Schedule Later :


        {
          "data": {
              "type": "srlgJobsSchedule",
            "attributes": {
              "scheduleName": "Schedule1",
              "scopeType": "network",
              "cronExpression": "5 11 7 1/1 * ? *",
              "cronExpressionFormat": "Quartz",
            "jobs": [
         "auto_assign",
        "propagate",
         "write_to_network"
         ]
          }
        }

        }


        Schedule Now For Scope network:


        {
          "data": {
              "type": "srlgJobsSchedule",
            "attributes": {
              "scheduleName": "Schedule1",
              "scopeType": "network",
            "jobs": [
         "auto_assign",
        "propagate",
         "write_to_network"
         ]
          }
        }

        }


        Schedule Now For Scope subNetwork:


        {
          "data": {
              "type": "srlgJobsSchedule",
            "attributes": {
              "scheduleName": "Schedule1",
              "scopeType": "subNetwork",
              "scopeValue": "EastRegion",
            "jobs": [
         "auto_assign",
        "propagate",
         ]
          }
        }

        }
      operationId: PostcreateSchedule2
      parameters: []
      requestBody:
        description: SRLG Schedule Job request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgScheduleRequest'
              - description: SRLG Schedule Job request
        required: true
      responses:
        '201':
          description: SRLG Schedule Created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgScheduleResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlgSchedules/allowedJobs:
    get:
      tags:
      - SRLG Schedules v3
      summary: GetgetAllowedJobs
      description: Get display models for SRLG Scheduler UI
      operationId: GetgetAllowedJobs
      parameters: []
      responses:
        '200':
          description: Display models for SRLG Scheduler UI returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgScheduleModelsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Display models for SRLG Scheduler UI not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlgSchedules/{scheduleId}:
    delete:
      tags:
      - SRLG Schedules v3
      summary: DeletedeleteSchedule2
      description: Delete Srlg Job Schedule for schedule Id
      operationId: DeletedeleteSchedule2
      parameters:
      - name: scheduleId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Srlg Schedule  deleted
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Schedule not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v1/srlg:
    put:
      tags:
      - SRLG v1
      summary: PutputSRLG1
      description: >-
        <h3>Description of the Schema:</h3><p>This schema is intended for manual input of SRLG(s).  Minimally following attributes need to be provided.</p><br/><p><strong>resourceId:</strong>  FreId of the roadmline<br/><strong>resourceType:</strong> Fre<br/><strong>resourceName:</strong>  userLabel of the roadmline<br/>[<strong>Note:</strong> Either resourceId or resourceName should be provided. If both are present they will cause failure due to ambiguity.]<br/><strong>srlgSet:</strong> Is an object of plannedStartDate and list of srlgValues. If plannedStartDate is not provided IFD will default it to current date. The date format is ie. “YYYY-MM-DDTHH:MM:SS.SSSZ”</p><br/><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": {
            "attributes": {
              "resourceName": "1 DWDMU PV0754A111 PV0754B111",
              "resourceType": "Fre",
              "srlgSet": [
                {
                  "srlgValues": [
                    "10234",
                    "20567"
                  ],
                  "plannedStartDate": "2019-11-19T11:37:29.739Z"
                }
              ]
            }
          }
        }

        </code></pre>
      operationId: PutputSRLG13
      parameters: []
      requestBody:
        description: SRLG request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgIntentRequest'
              - description: SRLG request
        required: false
      responses:
        '200':
          description: SRLG updated
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: ROADMLINE not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v1/srlg/{resourceId}:
    get:
      tags:
      - SRLG v1
      summary: GetgetSRLG1
      description: Get SRLG by ID
      operationId: GetgetSRLG13
      parameters:
      - name: resourceId
        in: path
        description: FreId of the Roadmline
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgIntentRequest'
        '404':
          description: SRLG not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v2/srlg:
    get:
      tags:
      - SRLG v2
      summary: GetgetSRLG2
      description: <br/><h3>Description:</h3><p>This API provides functionality to get the details of srlg on resources using different parameters.</p><br/>
      operationId: GetgetSRLG2
      parameters:
      - name: resourceId
        in: query
        description: Id of the Resource whose details needs to be searched
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: 'Resource Type: fres, networkConstructs, equipments, tpes values.equipment value is also accepted'
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: isStructured
        in: query
        description: 'Is Structured: (Y or N) Srlg Values needs to be shown in Structured Form or not'
        style: form
        explode: true
        schema:
          type: string
      - name: plannedStartTime
        in: query
        description: Fetch SRLG set on the basis of time.
        style: form
        explode: true
        schema:
          type: string
      - name: srlgType
        in: query
        description: 'Filter on types of Srlgs to limit search.Values could be: auto,manual,inherited,combined,propagated, discovered.In addition manualShare, propagatedShare or combinedShare can also be used for NetworkConstructs.'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgIntentRequestV2'
        '404':
          description: SRLG not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
    post:
      tags:
      - SRLG v2
      summary: PosttriggerAssignmentOp1
      description: >+
        <h3>Description :</h3><p>This request is intended for SRLG(s) Batch Operations.<br/>AutoAssignment ,Clear AutoAssignment ,Propagation ,Supported6500Version ,WriteToNetwork ,PropagateShareSrlg ,ClearPropgatedShareSrlg ,Audit & Reconcile of Fb Profile, Clear Manual Assignment. API returns Job Id in response which can be used to track the job status.</p><br/><p><h3>Schema Description: </h3><strong>op: </strong>Operation (auto_assign,clear_auto_assign,propagate,write_to_network,propagate_share_srlg,clear_propagated_share_srlg,audit_fb_profile,clear_manual_assign)<br/><strong>resourceType: </strong> fres, networkConstructs, equipment/equipments,tpes <br/><strong>resourceTypes: </strong> fres, networkConstructs, equipment/equipments,tpes (comma separated, only for clear_manual_assign) <br/><strong>resourceId: </strong> Id of the resource<br/><strong>resourceName: </strong> Name of resource<br/><strong>riskType: </strong> Add/Drop Bank,ROADM Degree,etc<br/><strong>region: </strong> Subnetwork/region for which operation needs to be carried out<br/><strong>subNetwork: </strong> SubNetwork for which operation needs to be carried out<br/><strong>opaque: </strong> Opaque SRLG value (only used for clear_manual_assign)<br/><strong>structured: </strong> Structured SRLG value (only used for clear_manual_assign)<br/></p><br/><p>Here are some example requests:</p>

        ```json

        AUTO-ASSIGNMENT


        {
          "data": {
              "op": "auto_assign",
            "attributes": {
              "resourceType": "networkConstructs"
            }
          }
        }


        CLEAR-AUTOASSIGNMENT


        {
          "data": {
              "op": "clear_auto_assign",
            "attributes": {
              "resourceType": "networkConstructs"
            }
          }
        }


        PROPAGATION


        {
          "data": {
              "op": "propagate",
            "attributes": {
              "resourceId": "8188858458035332238",
              "resourceType": "fres"
            }
          }
        }


        WRITE TO NETWORK


        {
          "data": {
              "op": "write_to_network",
            "attributes": {
              "resourceId": "f1a543f5-a2c5-349b-85dd-e298fcf716e4",
              "resourceType": "networkConstructs"
            }
          }
        }


        PROPAGATE SHARE SRLG


        {
          "data": {
            "op": "propagate_share_srlg",
            "attributes": {
              "resourceType": "networkConstructs",
              "resourceId": "string",
             "resourceName": "string",
              "region": "string"
              "subNetwork": "string",
            }
          }
        }


        CLEAR PROPAGATED SHARE SRLG


        {
          "data": {
            "op": "clear_propagated_share_srlg",
            "attributes": {
              "resourceType": "networkConstructs",
              "resourceId": "string",
             "resourceName": "string",
              "region": "string"
              "subNetwork": "string",
            }
          }
        }


        AUDIT & RECONCILE OF FB PROFILES


        {
          "data": {
            "op": "audit_fb_profile",
            "attributes": {
              "resourceType": "networkConstructs",
              "resourceId": "string",
             "resourceName": "string",
              "region": "string"
              "subNetwork": "string",
             "reconcile": true
            }
          }
        }


        CLEAR MANUAL ASSIGNMENT


        {
          "data": {
            "op": "clear_manual_assign",
            "attributes": {
              "resourceTypes": "networkConstructs,fres,tpes,equipments",
              "region": "string",
              "subNetwork": "string",
              "opaque": "string",
              "structured": {
                 "riskType": "External Risk",
                 "Region": "Subnetwork1"
                 "riskValue": "1"
               }
            }
          }
        }

      operationId: PosttriggerAssignmentOp13
      parameters: []
      requestBody:
        description: SRLG Assignment Job request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgManualOpRequest'
              - description: SRLG Assignment Job request
        required: true
      responses:
        '202':
          description: SRLG Job Triggered.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgJobStatusBO'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '423':
          description: Another SRLG Job is already running.
          headers: {}
          content: {}
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - SRLG v2
      summary: PutputSRLG2
      description: >-
        <h3>Description:</h3><p>This API is intended for manual input of SRLG(s) on resources.<br/><h3>Description of the Schema:<br/></h3>Minimally following attributes need to be provided.</p><br/><p><strong>resourceId:</strong>  Id of the resource<br/><strong>resourceType:</strong> fres, networkConstructs, equipment/equipments, tpes  <br/><strong>srlgSet:</strong> Is an object of plannedStartDate and manual/manualShare srlg object. The date format is ie. “YYYY-MM-DDTHH:MM:SS.SSSZ”</p><br/><p>Here is an example request:</p>

        ```json

        {
          "data": {
            "attributes": {
              "resourceId": "2000925292613460342",
              "resourceType": "fres",
              "srlgSet": [
                {
                  "manual": {
                    "srlgStructuredValues": [
                      {
                        "subNetwork": "NewYorkRegion",
                        "riskType": "Conduit",
                        "riskValue": 80023
                      }
                    ]
                  }
                },
                {
                  "plannedStartDate": "2018-09-26T10:30:01.607413Z",
                  "manual": {
                    "srlgValues": [
                      "59520495"
                    ]
                  }
                }
              ]
            }
          }
        }
      operationId: PutputSRLG2
      parameters: []
      requestBody:
        description: SRLG request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgIntentRequestV2'
              - description: SRLG request
        required: true
      responses:
        '200':
          description: SRLG updated
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Entity not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /ifd/api/v2/srlg/externalSRLGs:
    get:
      tags:
      - SRLG v2
      summary: GetgetExternalSrlgsfromLabel1
      description: <h3>Description:</h3><br/><p>This API can be used to query external assigned Srlgs assigned from pool.If no parameters are given.It will retrieve all records.</p><br/>
      operationId: GetgetExternalSrlgsfromLabel13
      parameters:
      - name: userLabel
        in: query
        description: Label used for reference while assigning SRLG
        style: form
        explode: true
        schema:
          type: string
      - name: isStructured
        in: query
        description: isStructured (Y/N) Srlg Values needs to be shown in Structured Form or not
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: offset
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: limit
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: External SRLGs returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlgList'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: External SRLGs not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - SRLG v2
      summary: PosttriggerExternalPoolOp1
      description: >+
        <h3>Description :</h3><p>This request is intended for External SRLG Pool Operations(Assign and Release External Srlg From Pool)</p><br/><h3>Description of the Schema:</h3><p><strong>op :</strong>Type of Operation (assign_external_srlg, release_external_srlg)<br/><strong>label :</strong> Any label used for reference<br/><strong>riskType :</strong> One of the RiskType Value given while setting SRLG Format <br/><strong>Region :</strong> Region for Srlg Value (Subnetwork)<br/><strong>id :</strong> Id for SRLG Value to release<br/></p><br/><p>Here are some example requests:</p>


        ```json

        GET AVAILABLE SRLG VALUE :-


        {
          "data": {
              "op": "assign_external_srlg",
              "type": "externalSRLGs",
            "attributes": {
              "label": "User_Label",
            "srlgFields": {
              "riskType": "External Risk",
              "Region": "Subnetwork1"
            }
            }
          }
        }


        RELEASE SRLG VALUE :-


        {
          "data": {
              "op": "release_external_srlg",
              "type": "externalSRLGs",
            "attributes": {
              "id": "srlgValue"
            }
          }
        }

      operationId: PosttriggerExternalPoolOp13
      parameters: []
      requestBody:
        description: External SRLG Pool Operation Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ExternalSrlgPoolRequest'
              - description: External SRLG Pool Operation Request
        required: true
      responses:
        '201':
          description: SRLG Value from External Pool Assigned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlg'
        '202':
          description: External SRLG Pool Release Job Triggered
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlgPoolResetResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v2/srlg/externalSRLGs/{extSRLGId}:
    get:
      tags:
      - SRLG v2
      summary: GetgetExternalSrlgFromId1
      description: <h3>Description:</h3><br/><p>This API provides functionality to query for specific External srlg value.</p><br/>
      operationId: GetgetExternalSrlgFromId13
      parameters:
      - name: extSRLGId
        in: path
        description: External Srlg Value
        required: true
        style: simple
        schema:
          type: string
      - name: isStructured
        in: query
        description: isStructured (Y/N)  Srlg Values needs to be shown as structured or not.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: External SRLGs returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSrlg'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: External SRLGs not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v2/srlg/job/status:
    get:
      tags:
      - SRLG v2
      summary: GetjobOpStatus1
      description: <h3>Description:</h3><br/><p>This API provides functionality to get the Srlg Batch Operation's jobs status using different parameters.</p><br/><strong>*Provide atleast one of the following Parameters*</strong><p><ul><li>JobType<br/></li><li>JobId<br/></li><li>JobStatus<br/></li></ul><br/></p><br/>
      operationId: GetjobOpStatus13
      parameters:
      - name: jobId
        in: query
        description: Id of Job/Srlg Operation
        style: form
        explode: true
        schema:
          type: string
      - name: jobType
        in: query
        description: 'Type of Job/Srlg Operation.Values could be: auto_assign,clear_auto_assign,write_to_network,propagate,assign_external_srlg, release_external_srlg, propagate_share_srlg, clear_propagated_share_srlg, audit_fb_profile, clear_manual_assign.'
        style: form
        explode: true
        schema:
          type: string
      - name: jobStatus
        in: query
        description: 'Status of Job/Srlg Operation.Values could be: in_progress,completed,failed.'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgManualJobOpResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v2/srlg/job/{jobId}/details:
    get:
      tags:
      - SRLG v2
      summary: GetjobOpStatusDetails1
      description: <h3>Description:</h3><br/><p>This API provides details about the srlg job operation status.Job id obtained from batch operation response needs to be used for tracking srlg operation.</p><br/>
      operationId: GetjobOpStatusDetails13
      parameters:
      - name: jobId
        in: path
        description: Id of Job/Srlg Operation for which details needs to be searched
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgManualJobDetailsOpResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v2/srlg/srlgMismatch:
    get:
      tags:
      - SRLG v2
      summary: GetgetSrlgMismatchResources1
      description: <h3>Description:</h3><br/><p>This API helps to query about the mismatch of Srlg Values present on resources.<br/></p><br/>
      operationId: GetgetSrlgMismatchResources13
      parameters:
      - name: ncId
        in: query
        description: NetworkConstruct id for which srlg mismatched resource to be found.No value indicates find for all NetworkConstructs
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: 'Allowed value : tpes'
        style: form
        explode: true
        schema:
          type: string
      - name: resourceId
        in: query
        description: resourceId if in particular
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgMismatchResponseV2'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v2/srlg/{srlgValue}/assignmentDetails:
    get:
      tags:
      - SRLG v2
      summary: GetgetResourcesFromSrlgValue1
      description: <h3>Description:</h3><br/><p>This API provides search capability to search resources for Srlg Values assigned on them.Different filters can be used to get details.</p><br/>
      operationId: GetgetResourcesFromSrlgValue13
      parameters:
      - name: srlgValue
        in: path
        description: SrlgValue for which search is to be performed
        required: true
        style: simple
        schema:
          type: string
      - name: srlgType
        in: query
        description: Type of assignment (manual,auto,inherited,propagated,discovered,manualShare,propagatedShare). If no value provided lookup will be done for all types.
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: Resource types on which SRLG assignment to be searched (fres,tpes,networkConstructs,equipments).equipment is also accepted. If no value provided lookup will be done for all types.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgResourceResponseV2'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v3/srlg:
    get:
      tags:
      - SRLG v3
      summary: GetgetSRLG3
      description: <br/><h3>Description:</h3><p>This API provides functionality to get the details of srlg on resources using different parameters.</p><br/>
      operationId: GetgetSRLG3
      parameters:
      - name: resourceId
        in: query
        description: Id of the Resource whose details needs to be searched
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: 'Resource Type: fres, networkConstructs, equipments, tpes values.'
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: isStructured
        in: query
        description: 'Is Structured: (Y or N) Srlg Values needs to be shown in Structured Form or not'
        style: form
        explode: true
        schema:
          type: string
      - name: plannedStartTime
        in: query
        description: Fetch SRLG set on the basis of time.
        style: form
        explode: true
        schema:
          type: string
      - name: srlgType
        in: query
        description: 'Filter on types of Srlgs to limit search.Values could be: auto,manual,inherited,combined,propagated, discovered.In addition manualShare, propagatedShare or combinedShare can also be used for NetworkConstructs.'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgIntentResponseV3'
        '404':
          description: SRLG not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlg/associatedSrlgs:
    get:
      tags:
      - SRLG v3
      summary: GetgetSrlgAssociations1
      description: <h3>Description:</h3><br/><p>Following API provides details of SRLGs associated with given resource.Filters can be used to get details.</p><br/>
      operationId: GetgetSrlgAssociations13
      parameters:
      - name: resourceId
        in: query
        description: Id of the Resource for which associated SRLG details are to be fetched
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: Resource Type for which associated SRLG details are to be fetched (fres,networkConstructs,equipments,tpes values)
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: srlgSource
        in: query
        description: Filter on types of Srlgs to limit search on association (auto,manual,propagated,discovered,manualShare,propagatedShare,discoveredShare values). If nothing is given, search will return on all possible values.
        style: form
        explode: true
        schema:
          type: string
      - name: includeMetaData
        in: query
        description: Indicate if metadata for filters need to be included
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Associated SRLGs details returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociatedSrlgsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlg/job/status:
    get:
      tags:
      - SRLG v3
      summary: GetjobOpStatus2
      description: <h3>Description:</h3><br/><p>This API provides functionality to get the Srlg Batch Operation's jobs status using different parameters.</p><br/><strong>*Provide atleast one of the following Parameters*</strong><p><ul><li>JobType<br/></li><li>JobId<br/></li><li>JobStatus<br/></li></ul><br/></p><br/>
      operationId: GetjobOpStatus2
      parameters:
      - name: jobId
        in: query
        description: Id of Job/Srlg Operation
        style: form
        explode: true
        schema:
          type: string
      - name: jobType
        in: query
        description: 'Type of Job/Srlg Operation.Values could be: auto_assign,clear_auto_assign,write_to_network,propagate,assign_external_srlg, release_external_srlg, propagate_share_srlg, clear_propagated_share_srlg, audit_fb_profile.'
        style: form
        explode: true
        schema:
          type: string
      - name: jobStatus
        in: query
        description: 'Status of Job/Srlg Operation.Values could be: in_progress,completed,failed.'
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: SRLG Job Status returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgJobResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: SRLG Job not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: true
  /ifd/api/v3/srlg/srlgMismatch:
    get:
      tags:
      - SRLG v3
      summary: GetgetSrlgMismatchResources2
      description: <h3>Description:</h3><br/><p>This API helps to query about the mismatch of Srlg Values present on resources.<br/></p><br/>
      operationId: GetgetSrlgMismatchResources2
      parameters:
      - name: ncId
        in: query
        description: NetworkConstruct id for which srlg mismatched resource to be found.No value indicates find for all NetworkConstructs
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: 'Allowed value : fres'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/resourceType71'
          - description: 'Allowed value : fres'
      - name: resourceId
        in: query
        description: resourceId if in particular
        style: form
        explode: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset for the second page
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The size of a returned page. The default is 30
        style: form
        explode: true
        schema:
          type: string
          default: '30'
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgMismatchResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlg/srlgMismatch/{mismatchId}/details:
    get:
      tags:
      - SRLG v3
      summary: GetgetSrlgMismatchDetails1
      description: <h3>Description:</h3><br/><p>SRLG mismatch details<br/></p><br/>
      operationId: GetgetSrlgMismatchDetails13
      parameters:
      - name: mismatchId
        in: path
        description: Srlg mismatch Id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgMismatchDetailsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /ifd/api/v3/srlg/{srlgValue}/assignmentDetails:
    get:
      tags:
      - SRLG v3
      summary: GetgetResourcesFromSrlgValue2
      description: <h3>Description:</h3><br/><p>This API provides search capability to search resources for Srlg Values assigned on them.Different filters can be used to get details.</p><br/>
      operationId: GetgetResourcesFromSrlgValue2
      parameters:
      - name: srlgValue
        in: path
        description: SrlgValue for which search is to be performed
        required: true
        style: simple
        schema:
          type: string
      - name: srlgSource
        in: query
        description: Type of assignment (manual,auto,inherited,propagated,discovered,manualShare,propagatedShare). If no value provided lookup will be done for all types.
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: Resource types on which SRLG assignment to be searched (fres,tpes,networkConstructs,equipments). If no value provided lookup will be done for all types.
        style: form
        explode: true
        schema:
          type: string
      - name: includeMetaData
        in: query
        description: Indicate if metadata for filters need to be included
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: succeed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignmentDetailsResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/srlgformat:
    get:
      tags:
      - 997 - nsiapisrlgformat
      summary: getSrlgFormat
      description: >-
        <p>LATEST VERSION: V3</p>


        <p>This API returns Srlg Format in JSON format.</p>
      operationId: getSrlgFormat
      parameters: []
      responses:
        '200':
          description: Successfully retrieved the requested Srlg Format.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '500':
          description: Failed to retrieve the requested Srlg Format.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - 997 - nsiapisrlgformat
      summary: patchSrlgFormat
      description: >-
        <p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /

        <h3>Description :</h3><p>This request is intended for SRLG Format patch operations.<br/><p><h3>Schema Description: </h3><strong>forceUpdate: </strong>true,when Srlg Format needs to be force changed<br/><strong>isEnabled: </strong> shows if the format is enabled at present or not <br/><strong>type: </strong> Type of Srlg format(structured,opaque)<br/><strong>length: </strong> Length of Srlg Value<br/><strong>displayFormat: </strong> Display Format of Srlg Value (decimal,bit,hexadecimal,enum)<br/><strong>structure: </strong> describe various fields which forms resultant SRLG(subnetwork,risktype,riskValue)<br/></p><br/><p>Here is an example request:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "operations": [

        {

        "op": "replace",

        "forceUpdate": true,

        "attributes": {

        "isEnabled": true,

        "type": "structured",

        "length": 32,

        "displayFormat": "decimal",

        "structure": [

        {

        "name": "subNetwork",

        "displayName": "Region",

        "startPos": 4,

        "length": 5,

        "displayFormat": "enum",

        "isPoolIdentifier": true

        },

        {

        "name": "riskType",

        "displayName": "riskType",

        "startPos": 9,

        "length": 4,

        "displayFormat": "enum",

        "isPoolIdentifier": true

        },

        {

        "name": "riskValue",

        "displayName": "riskValue",

        "startPos": 13,

        "length": 20,

        "displayFormat": "decimal"

        }

        ]

        }

        }

        ]

        }

        </code></pre>
      operationId: patchSrlgFormat
      parameters: []
      requestBody:
        description: A patch request to the given format.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgFormatPatchRO'
              - description: A patch request to the given format.
        required: true
      responses:
        '202':
          description: The request is successfully processed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/srlgformat/assignableEntityConfigurations:
    get:
      tags:
      - 997 - nsiapisrlgformat
      summary: getAssignableEntityConfigurations
      description: >-
        <p>LATEST VERSION: V3</p>
         <p>This API returns Srlg Assignable Entity Configurations in JSON format.Entity Type/RiskType can be used to filter the configuration.</p>
      operationId: getAssignableEntityConfigurations
      parameters:
      - name: entityType
        in: query
        description: entityType i.e. fres,networkConstructs,equipments
        style: form
        explode: true
        schema:
          type: string
      - name: riskType
        in: query
        description: 'riskType (RiskTypes can be found from : GET /nsi/api/srlgformat/srlgFormatMappings?type=riskType)'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested Srlg assignableEntityConfigurations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignableEntityConfigurationListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested Srlg assignableEntityConfigurations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/srlgformat/assignableEntityConfigurations/{assignableEntityConfigId}:
    patch:
      tags:
      - 997 - nsiapisrlgformat
      summary: patchAssignableEntityConfig
      description: >-
        <p>LATEST VERSION: V3</p>

        <p>Upon success, code 200 is returned and the output consists of JSON objects representing the effective config criteria. Only one mapping can be given in payload for patch.

        User can only replace the entire entity config for a given entity type.<br/>

        Note: If any of the config criteria given has syntax or validation issue, system will throw Error and will not update the config</p>

        <p>Example of the payload is given below:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "entityType": "equipments",
                "filters": [
                  {
                    "riskType": "Add/Drop Bank",
                    "criteria": [
                      {
                        "name": "partNumber",
                        "values": [
                          "NTK723AA",
                          "NTK720CA"
                        ]
                      }
                    ]
                  },
                  {
                    "riskType": "Line Module",
                    "criteria": [
                      {
                        "name": "partNumber",
                        "values": [
                          "NTK762MA",
                          "NTK762EA",
                          "NTK761AA"
                        ]
                      }
                    ]
                  },
                  {
                    "riskType": "ROADM Degree",
                    "criteria": [
                      {
                        "name": "partNumber",
                        "values": [
                          "NTK722AA"
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchAssignableEntityConfig
      parameters:
      - name: assignableEntityConfigId
        in: path
        description: assignableEntityConfigId e.g. assignableEntityConfiguration::equipments
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given format.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AssignableEntityConfigPatchRO'
              - description: A patch request to the given format.
        required: true
      responses:
        '200':
          description: The assignable Entity configurations were successfully modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignableEntityConfigDataRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/srlgformat/assignableEntityConfigurations/{entityType}/riskTypes:
    get:
      tags:
      - 997 - nsiapisrlgformat
      summary: getRiskTypes
      description: >-
        <p>LATEST VERSION: V3
         <p>This API returns Srlg riskTypes in JSON format.</p>
      operationId: getRiskTypes
      parameters:
      - name: entityType
        in: path
        description: entityType i.e. fres,networkConstructs,equipments
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested Srlg riskTypes for given EntityType.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignableEntitiesListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested Srlg riskTypes for given EntityType.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/srlgformat/propagatableServiceConfigurations:
    post:
      tags:
      - 997 - nsiapisrlgformat
      summary: postSrlgPropagatableServiceConfig
      description: "<p>This API is used to post the Srlg Format propagatable service configurations to be considered.<br/>\n<p><h3>Schema Notes: </h3><strong>serviceClass: </strong>currently supported : IP, OTU,LAG <br/><strong>isPropagatableTarget: </strong>allowed only for IP service class.<br/><strong>writeToNetwork: </strong> allowed only for IP service class<br/><strong>protectionSrlgInclusion : </strong> Only for LAG service class<br/><strong>priority: </strong> Positive whole number describing order of pruning<br/><strong>Masks: </strong> Type of Masks for pruning.(Can be Opaque/Structured)<br/><strong>FieldName: </strong> should be as per configured in format(subNetwork,riskType,riskValue)<br/></p><br/>Upon success, code 201 is returned and the output consists of JSON objects representing the created service configs.<br/>\nNote: If any of the mapping payload requested to be created is present already or have syntax error, system will throw Error.</p><p>Here is an example request for structured masks in pruning config:</p><pre style='font-size: smaller'><code class='json'>{\n  \"type\": \"propagatableServiceConfiguration\", \n      \"attributes\": {\n        \"serviceDescription\": \"Ip Link\",\n        \"serviceClass\": \"IP\",\n        \"isPropagatableTarget\": true,\n        \"writeToNetwork\": true,\n        \"pruningConfig\": {\n          \"maxAllowedSrlgs\": 20,\n          \"structuredMasks\": [\n            {\n              \"priority\": 1,\n              \"fieldMasks\": [\n                {\n                  \"name\": \"riskType\",\n                  \"value\": \"Add/Drop Bank\"\n                },\n                {\n                  \"name\": \"subNetwork\",\n                  \"value\": \"EastRegion\"\n                }\n               ]\n             },\n             {\n              \"priority\": 2,\n              \"fieldMasks\": [\n                {\n                  \"name\": \"riskType\",\n                  \"value\": \"Line Module\"\n                }\n               ]\n             }\n            ]\n          }\n        }\n}</code></pre><p>or Another example request for opaque masks in pruning config:</p><pre style='font-size: smaller'><code class='json'>{\n  \"type\": \"propagatableServiceConfiguration\", \n      \"attributes\": {\n        \"serviceDescription\": \"Ip Link\",\n        \"serviceClass\": \"IP\",\n        \"isPropagatableTarget\": true,\n        \"writeToNetwork\": true,\n        \"pruningConfig\": {\n          \"maxAllowedSrlgs\": 20,\n          \"opaqueMasks\": [\n            \"25165830\",\n            \"25165828\"\n            ]\n          }\n        }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: postSrlgPropagatableServiceConfig
      parameters: []
      requestBody:
        description: A Post request to add new name/value definitions for srlg propagatable service configurations
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
              - description: A Post request to add new name/value definitions for srlg propagatable service configurations
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
        '201':
          description: The propagatable service configs are successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified config
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapisrlgformat
      summary: deleteSrlgPropagationServiceConfig
      description: "<p>This API can be used to delete any existing Srlg Propagatable Service Configurations defined.\n\nUpon success, code 200 is returned and the output consists of JSON objects representing the deleted Configurations. <br/>\nNote: If any of the configurations requested to be deleted is not present, system will throw Error</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"id\": \"propagatableServiceConfiguration::IP\", \n  \"type\": \"propagatableServiceConfiguration\" \n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: deleteSrlgPropagationServiceConfig
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The propagatable service config were successfully deleted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfiguration'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified configs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/srlgformat/propagatableServiceConfigurations/{propagatableServiceConfigId}:
    patch:
      tags:
      - 997 - nsiapisrlgformat
      summary: patchPropagatableEntityConfig
      description: >-
        <p>Upon success, code 200 is returned and the output consists of JSON objects representing the effective config criteria

        <p><h3>Schema Notes: </h3><strong>serviceClass: </strong>currently supported : IP, OTU,LAG <br/><strong>isPropagatableTarget: </strong>allowed only for IP service class.<br/><strong>writeToNetwork: </strong> allowed only for IP service class<br/><strong>protectionSrlgInclusion : </strong> Only for LAG service class<br/><strong>priority: </strong> Positive whole number describing order of pruning<br/><strong>Masks: </strong> Type of Masks for pruning.(Can be Opaque/Structured)<br/><strong>FieldName: </strong> should be as per configured in format(subNetwork,riskType,riskValue)<br/></p><br/>

        Note: If any of the config criteria given has syntax or validation issue, system will throw Error and will not update the config</p><p>Example of the payload is given below:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "serviceDescription": "Ip Link",
                "serviceClass": "IP",
                "isPropagatableTarget": true,
                "writeToNetwork": true,
                "pruningConfig": {
                  "maxAllowedSrlgs": 20,
                  "structuredMasks": [
                    {
                      "priority": 1,
                      "fieldMasks": [
                        {
                          "name": "riskType",
                          "value": "Add/Drop Bank"
                        },
                        {
                          "name": "subNetwork",
                          "value": "EastRegion"
                        }
                       ]
                     },
                     {
                      "priority": 2,
                      "fieldMasks": [
                        {
                          "name": "riskType",
                          "value": "Line Module"
                        }
                       ]
                     }
                    ]
                  }
                }
            }
          ]
        }</code></pre><p>or Another example request for opaque masks in pruning:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "serviceDescription": "Ip Link",
                "serviceClass": "IP",
                "isPropagatableTarget": true,
                "writeToNetwork": true,
                "pruningConfig": {
                  "maxAllowedSrlgs": 20,
                  "opaqueMasks": [
                    "25165830",
                    "25165828"
                    ]
                  }
                }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: patchPropagatableEntityConfig
      parameters:
      - name: propagatableServiceConfigId
        in: path
        description: propagatableServiceConfigId e.g. propagatableServiceConfiguration::IP
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given format.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PropagatableServiceConfigPatchRO'
              - description: A patch request to the given format.
        required: true
      responses:
        '200':
          description: The propagatable Entity configurations were successfully modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden to access specified Config
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/srlgformat/srlg/transform:
    post:
      tags:
      - 997 - nsiapisrlgformat
      summary: transformSrlg
      description: >-
        <p>LATEST VERSION: V4<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /


        NOTE : Upon success, code 200 is returned and the output consists of JSON objects representing the srlg values in opaque/structured format.

        If any of the srlg value to be transformed is not as per Srlg format defined system will throw Error with code 400 : Bad Request.<br/>

        <p>Here is an example request for transforming Opaque Values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgValues": [

        "202375169",

        "202375170"

        ]

        }

        }

        </code></pre>


        <p>Here is an example request for transforming Structured Values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgStructuredValues": [

        {
         "riskValue": "3","riskType": "Photonic Node","Region": "subNetwork1"},
        {
         "riskValue": "2","riskType": "Photonic Node","Region": "subNetwork1"}
        ]

        }

        }

        </code></pre>
      operationId: transformSrlg
      parameters: []
      requestBody:
        description: A post request to transform Srlg value.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgValuesRO'
              - description: A post request to transform Srlg value.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgValuesRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/srlgformat/srlg/validate:
    post:
      tags:
      - 997 - nsiapisrlgformat
      summary: validateSrlg
      description: >-
        <p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /

        NOTE : Upon success, code 200 is returned and the output consists of JSON objects representing the srlg values in opaque/structured format.<br/>

        If any of the srlg value to be validated is not as per Srlg format defined system will throw Error with code 500 : Internal Server Error.</p>


        <p>Here is an example request for Validating Opaque Value:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgValues": [

        "202375169"

        ]

        }

        }

        </code></pre>


        <p>Here is an example request for Validating Structured Value:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgStructuredValues": [

        {
         "riskValue": "3","riskType": "Photonic Node","Region": "subNetwork1"}
        ]

        }

        }

        </code></pre>
      operationId: validateSrlg
      parameters: []
      requestBody:
        description: A post request to validate SRLG.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgValuesRO'
              - description: A post request to validate SRLG.
        required: true
      responses:
        '200':
          description: Supplied SRLG Value/s are valid as per configured SRLG format
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgValuesRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/srlgformat/srlgAutoAssignment:
    put:
      tags:
      - 997 - nsiapisrlgformat
      summary: setSrlgAutoAssignmentBehavior
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: setSrlgAutoAssignmentBehavior
      parameters: []
      requestBody:
        description: The desired Auto-assignment behavior
        content:
          text/plain:
            schema:
              type: boolean
              description: The desired Auto-assignment behavior
        required: true
      responses:
        '202':
          description: The request is successfully processed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/srlgformat/srlgFormatMappings:
    get:
      tags:
      - 997 - nsiapisrlgformat
      summary: getSrlgFormatMappings
      description: >-
        <p>LATEST VERSION: V3
         <br/><p>This API returns Srlg Format Mappings in JSON format.If no value for type filter will be given,all types will be considered.</p>
      operationId: getSrlgFormatMappings
      parameters:
      - name: type
        in: query
        description: type i.e. riskType, subNetwork
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested Srlg Format.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested Srlg Format Mappings.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 997 - nsiapisrlgformat
      summary: postSrlgFormatMappings
      description: >-
        <p>LATEST VERSION: V3</p>

        <p>This API is used to post the Srlg Format mappings to be considered.<br/>

        Upon success, code 201 is returned and the output consists of JSON objects representing the created mappings. More than one maping can be given in payload for creation at a time<br/>

        Note: If any of the mapping payload requested to be created is present already or have syntax error, system will throw Error with list of validation errors</p><p>All the attributes other than identifiers and types and attribute(name, value pair)  will be ignored. Note: system will always auto-generate the id</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": [
            {
              "type": "subNetwork",
              "attributes": {
                "name": "network1",
                "value": "1"
              }
            },
            {
              "type": "subNetwork",
              "attributes": {
                "name": "network2",
                "value": "2"
              }
            },
            {
              "type": "riskType",
              "attributes": {
                "name": "riskType1",
                "value": "1"
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: postSrlgFormatMappings
      parameters: []
      requestBody:
        description: A patch request to the given format.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgFormatMappingListRO'
              - description: A patch request to the given format.
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '201':
          description: The request is successfully processed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapisrlgformat
      summary: deleteSrlgFormatMappings
      description: >-
        <p>LATEST VERSION: V3</p>

        <p>This API can be used to delete any existing Srlg Format mappings defined.


        Upon success, code 200 is returned and the output consists of JSON objects representing the deleted mappings. More than one maping can be given in payload for deletion at a time.<br/>

        Note: If any of the mapping requested to be deleted is not present, system will throw Error with list of validation errors</p><p>All the attributes other than identifiers and types will be ignored.</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": [
            {
              "id": "subNetwork::network1",
              "type": "subNetwork"
            },
            {
              "id": "subNetwork::network2",
              "type": "subNetwork"
            },
            {
              "id": "riskType::riskType1",
              "type": "riskType"
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: deleteSrlgFormatMappings
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The mappings were successfully deleted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/srlgformat/srlgPropagation:
    put:
      tags:
      - 997 - nsiapisrlgformat
      summary: setSrlgPropagationBehavior
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: setSrlgPropagationBehavior
      parameters: []
      requestBody:
        description: The desired propagation behavior
        content:
          text/plain:
            schema:
              type: boolean
              description: The desired propagation behavior
        required: true
      responses:
        '202':
          description: The request is successfully processed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/srlgformat:
    get:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: GetgetSrlgFormat
      description: <p>This API returns Srlg Format in JSON format.</p>
      operationId: GetgetSrlgFormat
      parameters: []
      responses:
        '200':
          description: Successfully retrieved the Srlg Format.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '500':
          description: Failed to retrieve the requested Srlg Format.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    patch:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PatchpatchSrlgFormat
      description: >
        <p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /

        <h3>Description :</h3><p>This request is intended for SRLG Format patch operations.<br/><p><h3>Schema Description: </h3><strong>forceUpdate: </strong>true,when Srlg Format needs to be force changed<br/><strong>isEnabled: </strong> shows if the format is enabled at present or not <br/><strong>type: </strong> Type of Srlg format(structured,opaque)<br/><strong>length: </strong> Length of Srlg Value<br/><strong>displayFormat: </strong> Display Format of Srlg Value (decimal,bit,hexadecimal,enum)<br/><strong>structure: </strong> describe various fields which forms resultant SRLG(subnetwork,risktype,riskValue)<br/></p><br/><p>Here is an example request:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "operations": [

        {

        "op": "replace",

        "forceUpdate": true,

        "attributes": {

        "isEnabled": true,

        "type": "structured",

        "length": 32,

        "displayFormat": "decimal",

        "structure": [

        {

        "name": "subNetwork",

        "displayName": "Region",

        "startPos": 4,

        "length": 5,

        "displayFormat": "enum",

        "isPoolIdentifier": true

        },

        {

        "name": "riskType",

        "displayName": "riskType",

        "startPos": 9,

        "length": 4,

        "displayFormat": "enum",

        "isPoolIdentifier": true

        },

        {

        "name": "riskValue",

        "displayName": "riskValue",

        "startPos": 13,

        "length": 20,

        "displayFormat": "decimal"

        }

        ]

        }

        }

        ]

        }
      operationId: PatchpatchSrlgFormat
      parameters: []
      requestBody:
        description: A patch request to the given format.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgFormatPatchRO'
              - description: A patch request to the given format.
        required: true
      responses:
        '202':
          description: The request is accepted and is being handled on backend server
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/srlgformat/assignableEntityConfigurations:
    get:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: GetgetAssignableEntityConfigurations
      description: <p>This API returns Srlg Assignable Entity Configurations in JSON format.Entity Type/RiskType can be used to filter the configuration.</p>
      operationId: GetgetAssignableEntityConfigurations
      parameters:
      - name: entityType
        in: query
        description: entityType i.e. fres,networkConstructs,equipments
        style: form
        explode: true
        schema:
          type: string
      - name: riskType
        in: query
        description: 'riskType (RiskTypes can be found from : GET /nsi/api/srlgformat/srlgFormatMappings?type=riskType)'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested Srlg assignableEntityConfigurations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignableEntityConfigurationListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested Srlg assignableEntityConfigurations.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/srlgformat/assignableEntityConfigurations/{assignableEntityConfigId}:
    patch:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PatchpatchAssignableEntityConfig
      description: >-
        <p>Upon success, code 200 is returned and the output consists of JSON objects representing the effective config criteria. Only one mapping can be given in payload for patch.

        User can only replace the entire entity config for a given entity type.<br/>

        Note: If any of the config criteria given has syntax or validation issue, system will throw Error and will not update the config</p><p>Example of the payload is given below:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "entityType": "equipments",
                "filters": [
                  {
                    "riskType": "Add/Drop Bank",
                    "criteria": [
                      {
                        "name": "partNumber",
                        "values": [
                          "NTK723AA",
                          "NTK720CA"
                        ]
                      }
                    ]
                  },
                  {
                    "riskType": "Line Module",
                    "criteria": [
                      {
                        "name": "partNumber",
                        "values": [
                          "NTK762MA",
                          "NTK762EA",
                          "NTK761AA"
                        ]
                      }
                    ]
                  },
                  {
                    "riskType": "ROADM Degree",
                    "criteria": [
                      {
                        "name": "partNumber",
                        "values": [
                          "NTK722AA"
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchAssignableEntityConfig
      parameters:
      - name: assignableEntityConfigId
        in: path
        description: assignableEntityConfigId e.g. assignableEntityConfiguration::equipments
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given format.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AssignableEntityConfigPatchRO'
              - description: A patch request to the given format.
        required: true
      responses:
        '200':
          description: The assignable Entity configurations were successfully modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignableEntityConfigDataRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/srlgformat/assignableEntityConfigurations/{entityType}/riskTypes:
    get:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: GetgetRiskTypes
      description: <p>This API returns Srlg riskTypes in JSON format.</p>
      operationId: GetgetRiskTypes
      parameters:
      - name: entityType
        in: path
        description: entityType i.e. fres,networkConstructs,equipments
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested Srlg Srlg riskTypes for given EntityType.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgAssignableEntitiesListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested Srlg Srlg riskTypes for given EntityType.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/srlgformat/propagatableServiceConfigurations:
    post:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PostpostSrlgPropagatableServiceConfig
      description: "<p>This API is used to post the Srlg Format propagatable service configurations to be considered.<br/>\n<br/><p><h3>Schema Notes: </h3><strong>serviceClass: </strong>currently supported : IP, OTU,LAG <br/><strong>isPropagatableTarget: </strong>allowed only for IP service class.<br/><strong>writeToNetwork: </strong> allowed only for IP service class<br/><strong>protectionSrlgInclusion : </strong> Only for LAG service class<br/><strong>priority: </strong> Positive whole number describing order of pruning<br/><strong>Masks: </strong> Type of Masks for pruning.(Can be Opaque/Structured)<br/><strong>FieldName: </strong> should be as per configured in format(subNetwork,riskType,riskValue)<br/></p><br/>Upon success, code 201 is returned and the output consists of JSON objects representing the created service config.<br/>\nNote: If any of the service config requested to be created is present already or have syntax error, system will throw Error.</p><p>Here is an example request for structured masks:</p><pre style='font-size: smaller'><code class='json'>{\n  \"type\": \"propagatableServiceConfiguration\", \n      \"attributes\": {\n        \"serviceDescription\": \"Ip Link\",\n        \"serviceClass\": \"IP\",\n        \"isPropagatableTarget\": true,\n        \"writeToNetwork\": true,\n        \"pruningConfig\": {\n          \"maxAllowedSrlgs\": 20,\n          \"structuredMasks\": [\n            {\n              \"priority\": 1,\n              \"fieldMasks\": [\n                {\n                  \"name\": \"riskType\",\n                  \"value\": \"Add/Drop Bank\"\n                },\n                {\n                  \"name\": \"subNetwork\",\n                  \"value\": \"EastRegion\"\n                }\n               ]\n             },\n             {\n              \"priority\": 2,\n              \"fieldMasks\": [\n                {\n                  \"name\": \"riskType\",\n                  \"value\": \"Line Module\"\n                }\n               ]\n             }\n            ]\n          }\n        }\n\n}</code></pre><p>or Another example request for opaque masks in pruning:</p><pre style='font-size: smaller'><code class='json'>{\n  \"type\": \"propagatableServiceConfiguration\", \n      \"attributes\": {\n        \"serviceDescription\": \"Ip Link\",\n        \"serviceClass\": \"IP\",\n        \"isPropagatableTarget\": true,\n        \"writeToNetwork\": true,\n        \"pruningConfig\": {\n          \"maxAllowedSrlgs\": 20,\n          \"opaqueMasks\": [\n            \"25165830\",\n            \"25165828\"\n            ]\n          }\n        }\n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: PostpostSrlgPropagatableServiceConfig
      parameters: []
      requestBody:
        description: A Post request to add new name/value definitions for srlg propagatable service configurations
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
              - description: A Post request to add new name/value definitions for srlg propagatable service configurations
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
        '201':
          description: The propagatable service configs are successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified config
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: DeletedeleteSrlgPropagationServiceConfig
      description: "<p>This API can be used to delete any existing Srlg Propagatable Service Configurations defined.\n\nUpon success, code 200 is returned and the output consists of JSON objects representing the deleted Configurations.<br/>\nNote: If any of the configurations requested to be deleted is not present, system will throw Error & will not delete any configuration</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{\n  \"id\": \"propagatableServiceConfiguration::IP\", \n  \"type\": \"propagatableServiceConfiguration\" \n}</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /"
      operationId: DeletedeleteSrlgPropagationServiceConfig
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The configs were successfully deleted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfiguration'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified configs
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/srlgformat/propagatableServiceConfigurations/{propagatableServiceConfigId}:
    patch:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PatchpatchPropagatableEntityConfig
      description: >-
        <p>Upon success, code 200 is returned and the output consists of JSON objects representing the effective config criteria

        <p><h3>Schema Notes: </h3><strong>serviceClass: </strong>currently supported : IP, OTU,LAG <br/><strong>isPropagatableTarget: </strong>allowed only for IP service class.<br/><strong>writeToNetwork: </strong> allowed only for IP service class<br/><strong>protectionSrlgInclusion : </strong> Only for LAG service class<br/><strong>priority: </strong> Positive whole number describing order of pruning<br/><strong>Masks: </strong> Type of Masks for pruning.(Can be Opaque/Structured)<br/><strong>FieldName: </strong> should be as per configured in format(subNetwork,riskType,riskValue)<br/></p><br/>

        Note: If any of the config criteria given has syntax or validation issue, system will throw Error and will not update the config</p><p>Example of the payload is given below:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "serviceDescription": "Ip Link",
                "serviceClass": "IP",
                "isPropagatableTarget": true,
                "writeToNetwork": true,
                "pruningConfig": {
                  "maxAllowedSrlgs": 20,
                  "structuredMasks": [
                    {
                      "priority": 1,
                      "fieldMasks": [
                        {
                          "name": "riskType",
                          "value": "Add/Drop Bank"
                        },
                        {
                          "name": "subNetwork",
                          "value": "EastRegion"
                        }
                       ]
                     },
                     {
                      "priority": 2,
                      "fieldMasks": [
                        {
                          "name": "riskType",
                          "value": "Line Module"
                        }
                       ]
                     }
                    ]
                  }
                }
            }
          ]
        }</code></pre><p>or Another example request for opaque masks in pruning:</p><pre style='font-size: smaller'><code class='json'>{
          "operations": [
            {
              "op": "replace",
              "attributes": {
                "serviceDescription": "Ip Link",
                "serviceClass": "IP",
                "isPropagatableTarget": true,
                "writeToNetwork": true,
                "pruningConfig": {
                  "maxAllowedSrlgs": 20,
                  "opaqueMasks": [
                    "25165830",
                    "25165828"
                    ]
                  }
                }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PatchpatchPropagatableEntityConfig
      parameters:
      - name: propagatableServiceConfigId
        in: path
        description: propagatableServiceConfigId e.g. propagatableServiceConfiguration::IP
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A patch request to the given format.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PropagatableServiceConfigPatchRO'
              - description: A patch request to the given format.
        required: true
      responses:
        '200':
          description: The propagatable Entity configurations were successfully modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgPropagatableServiceConfigDataRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden to access specified Config
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/srlgformat/srlg/transform:
    post:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PosttransformSrlg
      description: >-
        <p><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /

        NOTE : Upon success, code 200 is returned and the output consists of JSON objects representing the srlg values in opaque/structured format<br/>

        If any of the srlg value to be transformed is not as per Srlg format defined system will throw Error with code 400 : Bad Request.</p>


        <p>Here is an example request for transforming Opaque Values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgValues": [

        "202375169",

        "202375170"

        ]

        }

        }

        </code></pre>


        <p>Here is an example request for transforming Structured Values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgStructuredValues": [

        {
         "riskValue": "3","riskType": "Photonic Node","Region": "subNetwork1"},
        {
         "riskValue": "2","riskType": "Photonic Node","Region": "subNetwork1"}
        ]

        }

        }

        </code></pre>
      operationId: PosttransformSrlg
      parameters: []
      requestBody:
        description: A post request to transform Srlg value
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgValuesRO'
              - description: A post request to transform Srlg value
        required: true
      responses:
        '200':
          description: Input is successfully translated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgValuesRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/srlgformat/srlg/validate:
    post:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PostvalidateSrlg
      description: >-
        <p><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /

        NOTE : Upon success, code 200 is returned and the output consists of JSON objects representing the srlg values in opaque/structured format<br/>

        If any of the srlg value to be validated is not as per Srlg format defined system will throw Error with code 500 : Internal Server Error.</p>


        <p>Here is an example request for Validating Opaque Values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgValues": [

        "202375169",

        "202375170"

        ]

        }

        }

        </code></pre>


        <p>Here is an example request for Validating Structured Values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgStructuredValues": [

        {
         "riskValue": "3","riskType": "Photonic Node","Region": "subNetwork1"}
        ]

        }

        }

        </code></pre>
      operationId: PostvalidateSrlg
      parameters: []
      requestBody:
        description: A post request to validate SRLG.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgValuesRO'
              - description: A post request to validate SRLG.
        required: true
      responses:
        '200':
          description: Supplied SRLG Value/s are valid as per configured SRLG format
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgValuesRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v3/srlgformat/srlgAutoAssignment:
    put:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PutsetSrlgAutoAssignmentBehavior
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutsetSrlgAutoAssignmentBehavior
      parameters: []
      requestBody:
        description: The desired Srlg auto assignment behavior
        content:
          text/plain:
            schema:
              type: boolean
              description: The desired Srlg auto assignment behavior
        required: true
      responses:
        '202':
          description: The request is successfully processed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v3/srlgformat/srlgFormatMappings:
    get:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: GetgetSrlgFormatMappings
      description: <p>This API returns Srlg Format Mappings in JSON format.If no value for type filter will be given,all types will be considered.</p>
      operationId: GetgetSrlgFormatMappings
      parameters:
      - name: type
        in: query
        description: type i.e. riskType, subNetwork
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the requested Srlg Format.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '400':
          description: Invalid value specified for a query parameter, or an invalid query parameter is specified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to retrieve the requested Srlg Format Mappings.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PostpostSrlgFormatMappings
      description: >-
        <p>This API is used to post the Srlg Format mappings to be considered.<br/>

        Upon success, code 201 is returned and the output consists of JSON objects representing the created mappings. More than one maping can be given in payload for creation at a time<br/>

        Note: If any of the mapping payload requested to be created is present already or have syntax error, system will throw Error with list of validation errors</p><p>All the attributes other than identifiers and types and attribute(name, value pair)  will be ignored. Note: system will always auto-generate the id</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": [
            {
              "type": "subNetwork",
              "attributes": {
                "name": "network1",
                "value": "1"
              }
            },
            {
              "type": "subNetwork",
              "attributes": {
                "name": "network2",
                "value": "2"
              }
            },
            {
              "type": "riskType",
              "attributes": {
                "name": "riskType1",
                "value": "1"
              }
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: PostpostSrlgFormatMappings
      parameters: []
      requestBody:
        description: A Post request to add new name/value definitions for SrlgFormatMappings
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgFormatMappingListRO'
              - description: A Post request to add new name/value definitions for SrlgFormatMappings
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '201':
          description: The mapping definitions are successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: DeletedeleteSrlgFormatMappings
      description: >-
        <p>This API can be used to delete any existing Srlg Format mappings defined.


        Upon success, code 200 is returned and the output consists of JSON objects representing the deleted mappings. More than one maping can be given in payload for deletion at a time<br/>

        Note: If any of the mapping requested to be deleted is not present, system will throw Error with list of validation errors and will not delete any mapping</p><p>All the attributes other than identifiers and types will be ignored.</p><p>Here is an example request:</p><pre style='font-size: smaller'><code class='json'>{
          "data": [
            {
              "id": "subNetwork::network1",
              "type": "subNetwork"
            },
            {
              "id": "subNetwork::network2",
              "type": "subNetwork"
            },
            {
              "id": "riskType::riskType1",
              "type": "riskType"
            }
          ]
        }</code></pre><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /
      operationId: DeletedeleteSrlgFormatMappings
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: The mappings were successfully deleted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatMappingListRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /nsi/api/v3/srlgformat/srlgPropagation:
    put:
      tags:
      - 997 - nsiapiv3srlgformat
      summary: PutsetSrlgPropagationBehavior
      description: '<p>LATEST VERSION: V3<p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /'
      operationId: PutsetSrlgPropagationBehavior
      parameters: []
      requestBody:
        description: The desired propagation behavior
        content:
          text/plain:
            schema:
              type: boolean
              description: The desired propagation behavior
        required: true
      responses:
        '202':
          description: The request is successfully processed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SrlgFormatRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: true
  /nsi/api/v4/srlgformat/srlg/transform:
    post:
      tags:
      - 997 - nsiapiv4srlgformat
      summary: PosttransformSrlg1
      description: >-
        <p><p>The following characters are not supported in any id values, userData keys or identifier keys: { } : ? /


        NOTE : Upon success, code 200 is returned and the output consists of JSON objects representing thesrlg values in opaque/structured format

        If any of the srlg value to be transformed is not as per Srlg format defined system will throw Error with code 400 : Bad Request.


        <p>Here is an example request for transforming Opaque Values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgValues": [

        "202375169",

        "202375170"

        ]

        }

        }

        </code></pre>


        <p>Here is an example request for transforming Structured values:</p>

         <pre style='font-size: smaller'><code class='json'>{
        "data": {

        "srlgStructuredValues": [

        {
         "riskValue": "3","riskType": "Photonic Node","Region": "subNetwork1"},
        {
         "riskValue": "2","riskType": "Photonic Node","Region": "subNetwork1"}
        ]

        }

        }

        </code></pre>
      operationId: PosttransformSrlg1
      parameters: []
      requestBody:
        description: A post request to transform Srlg value
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgValuesRO'
              - description: A post request to transform Srlg value
        required: true
      responses:
        '200':
          description: Input is successfully translated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransformedSrlgValuesRO'
        '400':
          description: Invalid input supplied
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access specified Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error (error message provided)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/srlgpool:
    post:
      tags:
      - 997 - nsiapisrlgpool
      summary: performExternalSRLGOperation
      description: API to get next available SRLG or release SRLG for external pool.
      operationId: performExternalSRLGOperation
      parameters: []
      requestBody:
        description: SRLGPoolOperation specifies operation to be performed on External Pool.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgValuesRO'
              - description: SRLGPoolOperation specifies operation to be performed on External Pool.
        required: true
      responses:
        '200':
          description: Sucessfully generated next SRLG for external pool.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSRLGRO'
        '201':
          description: Successfully released SRLG from external pool.
          headers: {}
          content: {}
        '400':
          description: Invalid value specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access External Pool
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to assign/release SRLG to/from external pool.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /nsi/api/v1/srlgpool:
    post:
      tags:
      - 997 - nsiapiv1srlgpool
      summary: PostperformExternalSRLGOperation
      description: API to get next available SRLG or release SRLG for external pool.
      operationId: PostperformExternalSRLGOperation
      parameters: []
      requestBody:
        description: SRLGPoolOperation specifies operation to be performed on External Pool.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrlgValuesRO'
              - description: SRLGPoolOperation specifies operation to be performed on External Pool.
        required: true
      responses:
        '200':
          description: Sucessfully generated next SRLG for external pool.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalSRLGRO'
        '201':
          description: Successfully released SRLG from external pool.
          headers: {}
          content: {}
        '400':
          description: Invalid value specified.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
        '403':
          description: Forbidden to access External Pool
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Failed to assign/release SRLG to/from external pool.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsRO'
      deprecated: false
  /submarine/api/v1/srs/scanRepeaters:
    get:
      tags:
      - Manage repeaters scan
      summary: GetScanDetails
      description: >
        Use this API to fetch the scan details for a particular scan.


        Prerequisite: SRS scan must exist for specified scan id.
      operationId: GetScanDetails
      parameters:
      - name: scanId
        in: query
        description: Scan Id of a particular scan
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: rptr_sys_family
        in: query
        description: Family type of the repeater system
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: band
        in: query
        description: Scan data of given band, applicable for FAMILY_D
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved scan details.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanDetailsData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ScanDetailsData'
        '400':
          description: Bad request. Invalid parameters, could not find scanId parameter.
          headers: {}
          content: {}
        '500':
          description: Retrieval of scan data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Manage repeaters scan
      summary: Initatiatenewscan
      description: >
        Use this API to start/view a submarine scan.


        Prerequisite: NE must be enrolled with ISS/OSIC card.
      operationId: Initatiatenewscan
      parameters:
      - name: ncId
        in: query
        description: NC ID of Network element
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Scan params needed to initiate the scan.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SubmarineApiV1SrsScanRepeatersRequest'
              - description: Scan params needed to initiate the scan.
        required: true
      responses:
        '200':
          description: Scan successfully initiated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters, could not find ncId parameter.
          headers: {}
          content: {}
        '500':
          description: Scan initiation failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Manage repeaters scan
      summary: DeleteScanRecord
      description: >
        Use this API to delete the scan record for a particular scanid.


        Prerequisite: Scan record must exist for specified scanId.
      operationId: DeleteScanRecord
      parameters: []
      responses:
        '200':
          description: Successfully deleted scan record.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters, could not find scanId parameter.
          headers: {}
          content: {}
        '500':
          description: Deletion of scan record failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/historyScans:
    get:
      tags:
      - History scans
      summary: GetHistoryscandetails
      description: "Use this API to fetch the scan history data.\n\nPrerequisite: \n"
      operationId: GetHistoryscandetails
      parameters:
      - name: ncId
        in: query
        description: ncId of the NE for which history scans need to be retrieved
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved history scans.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanHistoryData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ScanHistoryData'
        '400':
          description: Bad request. Invalid parameters, could not find ncId parameter.
          headers: {}
          content: {}
        '500':
          description: Retrieval of scan history data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/scheduleScan:
    get:
      tags:
      - Schedule scans
      summary: GetScheduleDetails
      description: >
        Use this API to fetch the Schedule scan details for a particular scan.


        Prerequisite: SRS Schedule Scan must exist for specified Schedule scan id.
      operationId: GetScheduleDetails
      parameters:
      - name: scheduleId
        in: query
        description: Scan Id of a particular scan
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: NC Id of a particular scan
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved Scheduled Scan data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleScandata'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ScheduleScandata'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Retrieval of Scheduled scan data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Schedule scans
      summary: Scheduleascan
      description: >
        Use this API to view a submarine Scheduled scan.


        Prerequisite: NE must be enrolled with ISS/OSIC card.
      operationId: Scheduleascan
      parameters: []
      requestBody:
        description: Scan parameters to be Scheduled
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SubmarineApiV1SrsScheduleScanRequest'
              - description: Scan parameters to be Scheduled
        required: true
      responses:
        '200':
          description: Scan successfully scheduled.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content: {}
        '500':
          description: Scan Schedule failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Schedule scans
      summary: DeleteScheduleScanRecord
      description: >
        Use this API to delete the Scheduled scan record for a particular Schedule ID.


        Prerequisite: Schedule Scan record must exist for specified scheduleId.
      operationId: DeleteScheduleScanRecord
      parameters: []
      responses:
        '200':
          description: Successfully deleted scan record.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters, could not find Schedule scanId parameter.
          headers: {}
          content: {}
        '500':
          description: Deletion of Schedule Scan record failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/configUbmd2Loss:
    get:
      tags:
      - Configuration loss
      summary: GetconfiglossDetails
      description: Use this API to configure UBMD2 loss for each repeater system.
      operationId: GetconfiglossDetails
      parameters:
      - name: ncId
        in: query
        description: ncId of the network element
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: facilityAid
        in: query
        description: Family type of repeater system
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved configure loss data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigureLossData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ConfigureLossData'
        '400':
          description: Bad request. Invalid parameters, could not find ncId,facId parameter.
          headers: {}
          content: {}
        '500':
          description: Retrieval of config loss data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Configuration loss
      summary: ConfigureUBMD2loss
      description: Use this API to configure UBMD2 loss data
      operationId: ConfigureUBMD2loss
      parameters: []
      requestBody:
        description: Config loss parameters for specified repeater system.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SubmarineApiV1SrsConfigUbmd2LossRequest'
              - description: Config loss parameters for specified repeater system.
        required: true
      responses:
        '200':
          description: Scan successfully initiated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters, could not find ncId parameter.
          headers: {}
          content: {}
        '500':
          description: Scan initiation failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/scanThreshold:
    get:
      tags:
      - Set baseline scan
      summary: Getbaselinedetails
      description: Use this api to set baseline of a scan for each repeater system.
      operationId: Getbaselinedetails
      parameters:
      - name: scanId
        in: query
        description: scanId of the scan to be baselined
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved baseline data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Baselinedetails'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Baselinedetails'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Set baseline scan
      summary: Savebaselinedetails
      description: Use this API to set baseline of a scan for each repeater system.
      operationId: Savebaselinedetails
      parameters: []
      requestBody:
        description: Baseline parameters to be saved
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SubmarineApiV1SrsScanThresholdRequest'
              - description: Baseline parameters to be saved
        required: true
      responses:
        '200':
          description: Baseline successfully saved.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content: {}
        '500':
          description: Scan Schedule failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/upload:
    post:
      tags:
      - Import
      summary: Importscanresult,cablesystem,repeatersystemandsltefiles
      description: "Use this API to import scan result, cable system, repeater system and slte files.\n\nPrerequisite: \n"
      operationId: Importscanresult,cablesystem,repeatersystemandsltefiles
      parameters:
      - name: name
        in: query
        description: Name of the Cable system. Field applicable only while importing repeater system file or slte system file
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - importType
              - file
              type: object
              properties:
                importType:
                  type: string
                  description: "Type of file to be imported\n 1) 'Scan Details' to import scan results\n 2) 'cableSystem' to import cable system file\n 3) 'repeaterSystem' to import repeater system file \n 4) 'slteSystem' to import SLTE"
                file:
                  type: string
                  description: The file which has to be imported
                  format: binary
                reImport:
                  type: string
                  description: >-
                    To enable or disable reimport check
                     1) 'True' to enable reimport check
                     2) 'False' to disable reimport check
        required: false
      responses:
        '200':
          description: All the files have been successfully imported
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '202':
          description: Some of the files could not be imported
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '409':
          description: Already imported
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '500':
          description: Import failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    get:
      tags:
      - Cable System Details
      summary: Getcablesystem,repeatersystem,sltedetails
      description: Use this API to fetch cable system, repeater system, slte details
      operationId: Getcablesystem,repeatersystem,sltedetails
      parameters:
      - name: detailsType
        in: query
        description: >-
          Type of data to be fetched
           1) 'cableSystem' to fetch cable system details
           2) 'repeaterSystem' to fetch repeater system details
           3) 'slteSystem' to fetch SLTE details
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Cable system name. Should be used while fetching repeater data or slte data
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cablesystemdetails'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Cablesystemdetails'
        '400':
          description: Request failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '500':
          description: Request failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    delete:
      tags:
      - Delete repeater, slte and cable descriptor files
      summary: Deleterepeater,slteandcabledescriptorfiles
      description: >
        Use this API to delete the repeater system, slte system or cable system file.


        Prerequisite: Cable system, slte system file must have been imported.
      operationId: Deleterepeater,slteandcabledescriptorfiles
      parameters:
      - name: deleteType
        in: query
        description: "Type of the descriptor file to be deleted\n 1) 'repeaterSystem' to delete repeater system file \n 2) 'slteSystem' to delete slte system file \n 3) 'cableSystem' to delete cable system file"
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted descriptor file record.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters, could not delete descriptor files.
          headers: {}
          content: {}
        '500':
          description: Deletion of descriptor file failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/export:
    post:
      tags:
      - Export
      summary: Exportdata
      description: "Use this API to export scan data.\n\nPrerequisite: \n"
      operationId: Exportdata
      parameters:
      - name: export_all
        in: query
        description: If true all scans will be Exported
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        description: Scan Ids of the scans to be exported
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AlarmQueryList'
              - description: Scan Ids of the scans to be exported
        required: true
      responses:
        '200':
          description: All the files have been successfully exported
          headers: {}
          content: {}
        '500':
          description: Export failed
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/cableSystemDetails:
    get:
      tags:
      - Cable system Details
      summary: Getcablesystemtopologyview,attributesandrepeatersdetails
      description: >
        Use this API to fetch cable system topology, attributes and repeaters details.


        Prerequisite: Cable system, repeater and slte descriptor files should be imported.
      operationId: Getcablesystemtopologyview,attributesandrepeatersdetails
      parameters:
      - name: resourceType
        in: query
        description: >-
          Tab name inside topology page.
           1) 'Topology' to view topology details
           2) 'Attributes' to view cable attribute details
           3) 'Repeater' to view repeater details
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: cableSystem
        in: query
        description: Cable system name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: cableStation
        in: query
        description: Enter cable station to query Topology or Repeaters
        style: form
        explode: true
        schema:
          type: string
      - name: segment
        in: query
        description: Enter segment to query Repeater
        style: form
        explode: true
        schema:
          type: string
      - name: customer
        in: query
        description: Enter customer name to query Topology or Repeater
        style: form
        explode: true
        schema:
          type: string
      - name: fiberPair
        in: query
        description: Enter fiber pair to query Repeater or Topology
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/topologyDataorattributesorrepeaters'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/topologyDataorattributesorrepeaters'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Retrieval of data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/srs/trendData:
    get:
      tags:
      - Trend view
      summary: Gettrenddetails
      description: Get trend details for family A, B, C and D type repeaters
      operationId: Gettrenddetails
      parameters:
      - name: scanId
        in: query
        description: Scan Id of a scan
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: repeaterAddress
        in: query
        description: Address of the repeater
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: startTime
        in: query
        description: Start time, valid time format is YYYY-MM-DDTHH:MM:SSZ
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: endTime
        in: query
        description: End Time, valid time format is YYYY-MM-DDTHH:MM:SSZ
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: band
        in: query
        description: Band Type, Required for FAMILY_D
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/band1'
          - description: Band Type, Required for FAMILY_D
      responses:
        '200':
          description: Successfully retrieved Trends data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trendsData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/trendsData'
        '400':
          description: Bad request. Invalid parameters.
          headers: {}
          content: {}
        '500':
          description: Retrieval of Trends data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/wetplant/components:
    get:
      tags:
      - Wetplant Components
      summary: Getwetplantdetails
      description: Use this API to get wetplant components and their optical powers details like opm history and opm current data.
      operationId: Getwetplantdetails
      parameters:
      - name: resourceType
        in: query
        description: >-
          Type of resource
           1) 'opmDetails' to get the components data
           2) 'opmHistory' to get the historical data
           3) 'opmCurrent' to get the current opm data
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: cableSystem
        in: query
        description: Name of the cable system
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: temsServer
        in: query
        description: IP Address of Tems Server, required when resourceType is either 'opmCurrent' or 'opmHistory'
        style: form
        explode: true
        schema:
          type: string
      - name: componentName
        in: query
        description: Name of component, required when resourceType is either 'opmCurrent' or 'opmHistory'
        style: form
        explode: true
        schema:
          type: string
      - name: fromDate
        in: query
        description: Date and time from when the data is required, valid format is YYYY-MM-DDTHH:MM:SSZ, required when resourceType is 'opmHistory'
        style: form
        explode: true
        schema:
          type: string
      - name: toDate
        in: query
        description: Date and time upto which the data is required, valid format is YYYY-MM-DDTHH:MM:SSZ, required when resourceType is 'opmHistory'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved requested data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wetplantData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/wetplantData'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '500':
          description: Failed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
      deprecated: false
    delete:
      tags:
      - 'Delete optical power data '
      summary: Deleteopticalpowerdata
      description: >
        Use this API to delete the optical power data of all wetplant components for given cable system.
      operationId: Deleteopticalpowerdata
      parameters:
      - name: cableSystem
        in: query
        description: Cable system name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted optical power data.
          headers: {}
          content: {}
        '400':
          description: Bad request. Invalid parameters, could not delete optical power data.
          headers: {}
          content: {}
        '500':
          description: Deletion of optical power data failed, error message provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /submarine/api/v1/spectrumSharingApp:
    get:
      tags:
      - Spectrum Sharing
      summary: Getterminaldata
      description: Use this API to fetch the spectrum sharing terminal data for all the supported network elements.
      operationId: Getterminaldata
      parameters: []
      responses:
        '200':
          description: Successfully retrieved terminal data details.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpectrumSharingTerminalData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/SpectrumSharingTerminalData'
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Retrieval of terminal data failed, error message provided in logs and response.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RequestFailed161'
      deprecated: false
  /submarine/api/v1/spectrumSharingDetails:
    post:
      tags:
      - Spectrum Sharing
      summary: Getdetailsforaspectrumsharingterminal
      description: >
        Use this API to fetch the customer and common path details for a spectrum sharing terminal


        Prerequisite: Spectrum Sharing Terminal must exist.
      operationId: Getdetailsforaspectrumsharingterminal
      parameters: []
      requestBody:
        description: Spectrum sharing details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/spectrumSharingDetails'
              - description: Spectrum sharing details
        required: true
      responses:
        '200':
          description: Successfully retrieved spectrum sharing details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpectrumSharingTerminalDetails'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/SpectrumSharingTerminalDetails'
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: SST details request failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Failed21'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Failed21'
      deprecated: false
  /submarine/api/v1/provisionSpectrum:
    post:
      tags:
      - Provision Spectrum
      summary: Provisionspectrumforacustomer
      description: Use this API to provision spectrum on SMD and WSS card.
      operationId: Provisionspectrumforacustomer
      parameters: []
      requestBody:
        description: Provision spectrum
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/provisionSpectrum'
              - description: Provision spectrum
        required: true
      responses:
        '200':
          description: Spectrum successfully provisioned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Provision spectrum request failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Failed21'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Failed21'
      deprecated: false
    get:
      tags:
      - Provision Spectrum
      summary: GetavailableCHCindexandfrequencyrange
      description: Use this API to get available CHC index and frequency range
      operationId: GetavailableCHCindexandfrequencyrange
      parameters:
      - name: ncId
        in: query
        description: Network construct id
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: smdAid
        in: query
        description: 'SMD card AID, eg: SMD-1-2 where 1 is shelf and 2 is slot'
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: wssAid
        in: query
        description: 'WSS card AID, eg: WSSOPM-1-10 where 1 is shelf and 10 is slot'
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: wssToSmdPort
        in: query
        description: WSS port connected to SMD
        style: form
        explode: true
        schema:
          type: string
      - name: wssToAsePort
        in: query
        description: WSS port connected to SMD
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved requested data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/provisionSpectrumData'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/provisionSpectrumData'
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Request failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Failed21'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Failed21'
      deprecated: false
    delete:
      tags:
      - Provision Spectrum
      summary: Removespectrumforacustomer
      description: Use this API to remove spectrum on SMD and WSS card.
      operationId: Removespectrumforacustomer
      parameters: []
      responses:
        '200':
          description: Spectrum is removed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Remove spectrum request failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Failed21'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Failed21'
      deprecated: false
  /submarine/api/v1/spectrumFacility:
    post:
      tags:
      - Spectrum Facility
      summary: FetchNMCCdetails
      description: Use this API to fetch the NMCC details.
      operationId: FetchNMCCdetails
      parameters: []
      requestBody:
        description: NMCC details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/facilityRequest'
              - description: NMCC details
        required: true
      responses:
        '200':
          description: Successfully retrieved NMCC details
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NMCCdetails'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NMCCdetails'
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Request failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Failed21'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Failed21'
      deprecated: false
    put:
      tags:
      - Spectrum Facility
      summary: UpdateswitchselectorofCHC
      description: Use this API to update switch selector
      operationId: UpdateswitchselectorofCHC
      parameters: []
      requestBody:
        description: Update switch selector
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/updateSwsel'
              - description: Update switch selector
        required: true
      responses:
        '200':
          description: Successfully updated switch selector of WSS CHC.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '400':
          description: Bad request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BadRequest111'
        '500':
          description: Request failed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Failed21'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Failed21'
      deprecated: false
  /tdc/api/v1/configProperties:
    get:
      tags:
      - tdcapiv1configProperties
      summary: getAllProps
      description: Retrieve all properties.
      operationId: getAllProps
      parameters: []
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropResponseRo'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - tdcapiv1configProperties
      summary: createUpdateProp
      description: Add/update a property by property name.
      operationId: createUpdateProp
      parameters: []
      requestBody:
        description: Property create/update request.<p>Name of the attributes holds the new/to-be-updated property name.<p>Value of the attributes holds the new/to-be-updated property value.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PropRequestRo'
              - description: Property create/update request.<p>Name of the attributes holds the new/to-be-updated property name.<p>Value of the attributes holds the new/to-be-updated property value.
        required: true
      responses:
        '200':
          description: request is accepted for updating
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropResponseRo'
        '201':
          description: request is accepted for adding
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropResponseRo'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/configProperties/{propertyName}:
    get:
      tags:
      - tdcapiv1configProperties
      summary: getPropValueByName
      description: Retrieve property by property name.
      operationId: getPropValueByName
      parameters:
      - name: propertyName
        in: path
        description: Property name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropResponseRo'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - tdcapiv1configProperties
      summary: deletePropByName
      description: Delete a property by property name.
      operationId: deletePropByName
      parameters:
      - name: propertyName
        in: path
        description: property name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: request is accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropResponseRo'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/diag/fiberloss:
    get:
      tags:
      - tdcapiv1diagfiberloss
      summary: getFiberLossData
      description: This API retrieves the measured fiber loss data on per uni-directional links along the specified service path. <p>.
      operationId: getFiberLossData
      parameters:
      - name: freIds
        in: query
        description: One or multiple service or link FRE id(s) separated by comma.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '202':
          description: Request accepted.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiberLossResponse'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/diag/pms/prfbers:
    get:
      tags:
      - tdcapiv1diagpmsprfbers
      summary: checkPrefecBer
      description: This API tests pre-FEC BER values at service endpoints against failed thresholds. <p>
      operationId: checkPrefecBer
      parameters:
      - name: freIds
        in: query
        description: Test pre-FEC BER for the given list of service freIds
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: failThreshold
        in: query
        description: The Pre-FEC BER Signal Fail Threshold
        required: true
        style: form
        explode: true
        schema:
          type: number
          format: double
      - name: degradeThreshold
        in: query
        description: (Optional) The Pre-FEC BER Signal Degrade Threshold
        style: form
        explode: true
        schema:
          type: number
          format: double
      - name: resetIdf
        in: query
        description: (Optional) Test Pre-FEC BER with reset untimed IDF (default false). If reset, MCP will reset untimed IDF 15 Secs after service channel becomes DOC managed, wait for another 15 sec and then retrieve pre-FEC BER data from untimed bin for the test;Otherwise, MCP will retrieve pre-FEC BER data from untimed bin directly for the test
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PmDiagResponse'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/diag/pms/prfbers/complex:
    get:
      tags:
      - tdcapiv1diagpmsprfbers
      summary: testPrefecBer
      description: This API tests pre-FEC BER values at service endpoints against target thresholds. <p>
      operationId: testPrefecBer
      parameters:
      - name: freId
        in: query
        description: The freId of a service or infrastructure link
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: targetThreshold
        in: query
        description: The Pre-FEC BER target threshold
        required: true
        style: form
        explode: true
        schema:
          type: number
          format: double
      responses:
        '200':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BerComplexResponse'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/diag/spectral:
    get:
      tags:
      - tdcapiv1diagspectral
      summary: getSpectralDiagData
      description: This API retrieves spectral data which describes the spectral usage at OTSi layer along the specified service path. <p>The spectral data are presented in the TPE as <I>usedCapacity<I>.
      operationId: getSpectralDiagData
      parameters:
      - name: freIds
        in: query
        description: One or multiple service FRE id(s) separated by comma.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '202':
          description: Request accepted.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpectralResponse'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/diag/spectral/allocations:
    get:
      tags:
      - tdcapiv1diagspectral
      summary: getSpectralAllocData
      description: This API retrieves spectral allocation data which describes the spectrum usage at OTSi layer for each roadm lines along service path. <p>The spectral allocation data are presented in photonic services as <I>photonicSpectrumPackage<I>.
      operationId: getSpectralAllocData
      parameters:
      - name: freIds
        in: query
        description: One or multiple service FRE id(s) separated by comma.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '202':
          description: Request accepted.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpectralAllocRo'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/operationalStatus:
    get:
      tags:
      - tdcapiv1operationalStatus
      summary: getOperStatus
      description: Retrieve operational status.
      operationId: getOperStatus
      parameters:
      - name: freId
        in: query
        description: A service FRE id.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: osTypeString
        in: query
        description: Type of operational status
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/osTypeString1'
          - description: Type of operational status
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperStatusResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/pageLoad/load:
    get:
      tags:
      - tdcapiv1pageLoad
      summary: getPageLoadInformation
      description: <p>This API is designed to identify what diagnostic test types are supported on a selected service/tunnel for <u>blueplanet</u> UI component to use.<p>The test capabilities includes:<ul><li>Supporting diagnostic test types and the test type description text<li>Service endpoints of each supporting test type:<ul><li> for CFM service, the service endpoint(s) with MEP configured will be included<li> for MPLS service, the PW(s) service endpoint(s) will be included, as well as the service endpoints of the LSP tunnel(s) which the PW(s) is configured on<li> for LSP tunnel, the LSP service endpoints will be included, as well as the service endpoint(s) of the PW(s) which are configured on this tunnel.</ul><li>The name and range of the supporting test parameters per NE of the service endpoint</ul>.
      operationId: getPageLoadInformation
      parameters:
      - name: freId
        in: query
        description: FRE id
        style: form
        explode: true
        schema:
          type: string
      - name: includedInformation
        in: query
        description: Included information. Allowable values are testCapabilities, ccStatus, lspOperationalStatus, pwOperationalStatus, tdmStatus, itsCapabilities(comma separated for multiple)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCapabilitiesRo'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests:
    get:
      tags:
      - tdcapiv1tests
      summary: getTestList
      description: Retrieve test results list.
      operationId: getTestList
      parameters:
      - name: testType
        in: query
        description: Optional, test type
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/testType11'
          - description: Optional, test type
      - name: freId
        in: query
        description: Optional, service FRE id
        style: form
        explode: true
        schema:
          type: string
      - name: tpeIds
        in: query
        description: Optional, One or multiple test point TPE id(s) separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: ncIds
        in: query
        description: Optional, One or multiple test network construct id(s) separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: userAnnotation
        in: query
        description: Optional, partial or full user annotation
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestListRo'
        '400':
          description: Test type is not supported
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/Description:
    get:
      tags:
      - tdcapiv1tests
      summary: getTestCapabilities
      description: <p>This API is designed to identify what diagnostic test types are supported on a selected service/tunnel for <u>blueplanet</u> UI component to use.<p>The test capabilities includes:<ul><li>Supporting diagnostic test types and the test type description text<li>Service endpoints of each supporting test type:<ul><li> for CFM service, the service endpoint(s) with MEP configured will be included<li> for MPLS service, the PW(s) service endpoint(s) will be included, as well as the service endpoints of the LSP tunnel(s) which the PW(s) is configured on<li> for LSP tunnel, the LSP service endpoints will be included, as well as the service endpoint(s) of the PW(s) which are configured on this tunnel.<li> for L3 service, the service endpoint(s) ?? will be included</ul><li>The name and range of the supporting test parameters per NE of the service endpoint</ul>.
      operationId: getTestCapabilities
      parameters:
      - name: freId
        in: query
        description: FRE id
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCapabilitiesRo'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/DescriptionL3:
    get:
      tags:
      - tdcapiv1tests
      summary: getTestCapabilitiesL3
      description: <p>This API is designed to identify what diagnostic test types are supported on a selected tunnel of L3 for <u>blueplanet</u> UI component to use.<p>The test capabilities includes:<ul><li>Supporting diagnostic test types and the test type description text<li>Service endpoints of each supporting test type:<ul><li> for SR Tunnel, the result would be returned from a schema file as there is no FreId exist on NSI</ul><li>The name and range of the supporting test parameters per NE of the service endpoint</ul>.
      operationId: getTestCapabilitiesL3
      parameters:
      - name: operationType
        in: query
        description: Operation Type
        style: form
        explode: true
        schema:
          type: string
      - name: ncId
        in: query
        description: Optional, NC id
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCapabilitiesRo'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/benchmarkOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startBmTest
      description: Start a benchmark test
      operationId: startBmTest
      parameters: []
      requestBody:
        description: Test request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BmTestRo'
              - description: Test request
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Testing resource is under testing or device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/cfmOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startCfmTest
      description: 'Start a CFM test: linktrace, loopback'
      operationId: startCfmTest
      parameters: []
      requestBody:
        description: CFM test request.<p>Options for type are loopback, linktrace.<p>Options for idType of remotePoint are macAddress, tpes, mepId.<p>Keys of testParameters for loopback are count, data, interval, priority and timeout.<p>Keys of testParameters for linktrace are priority and ttl.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CfmTestRo'
              - description: CFM test request.<p>Options for type are loopback, linktrace.<p>Options for idType of remotePoint are macAddress, tpes, mepId.<p>Keys of testParameters for loopback are count, data, interval, priority and timeout.<p>Keys of testParameters for linktrace are priority and ttl.
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Testing resource is under testing or device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/itsInjectError:
    post:
      tags:
      - tdcapiv1tests
      summary: itsInjectError
      description: Inject Error on running Integrated Test Set test
      operationId: itsInjectError
      parameters: []
      requestBody:
        description: Inject Error request.<p>Values for errorType are Bit Error, LF and RF.<p>Values for errorOperation are start and stop.<p>Values for errorPoint are GENA and GENB.<p>Values for errorRate are single and continuous.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ItsInjectErrorRo'
              - description: Inject Error request.<p>Values for errorType are Bit Error, LF and RF.<p>Values for errorOperation are start and stop.<p>Values for errorPoint are GENA and GENB.<p>Values for errorRate are single and continuous.
        required: true
      responses:
        '202':
          description: Inject Error request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/itsOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startItsTest
      description: 'Start a Integrated Test Set test: raceTrack, testSet, networkMode.'
      operationId: startItsTest
      parameters: []
      requestBody:
        description: Integrated Test Set test request.<p>Options for type are raceTrack, testSet, networkMode.<p>Keys of raceTrack localTpeData are tpeId, berThreshold, duration, monaPattern, genbPattern, , monaBerThreshold, layerRate, loopback and cardType.<p>Keys of raceTrack remoteTpeData are tpeId, layerRate, loopback and cardType.<p>Keys of testSet localTpeData are tpeId, monaBerThreshold, duration, monaPattern, genaPattern, layerRate and cardType.<p>Keys of testSet remoteTpeData are tpeId, layerRate and cardType.<p>Keys of networkMode localTpeData are tpeId, monbBerThreshold, duration, monbPattern, genbPattern, layerRate and cardType.<p>Keys of networkMode remoteTpeData are tpeId, layerRate and cardType.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ItsOperationRo'
              - description: Integrated Test Set test request.<p>Options for type are raceTrack, testSet, networkMode.<p>Keys of raceTrack localTpeData are tpeId, berThreshold, duration, monaPattern, genbPattern, , monaBerThreshold, layerRate, loopback and cardType.<p>Keys of raceTrack remoteTpeData are tpeId, layerRate, loopback and cardType.<p>Keys of testSet localTpeData are tpeId, monaBerThreshold, duration, monaPattern, genaPattern, layerRate and cardType.<p>Keys of testSet remoteTpeData are tpeId, layerRate and cardType.<p>Keys of networkMode localTpeData are tpeId, monbBerThreshold, duration, monbPattern, genbPattern, layerRate and cardType.<p>Keys of networkMode remoteTpeData are tpeId, layerRate and cardType.
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/ldpOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startLdpTest
      description: 'Start a LDP test: ping'
      operationId: startLdpTest
      parameters: []
      requestBody:
        description: LDP test request.<p>Options for type are ping<p>Keys of testParameters for ping are count, encapType, packetSize, replyMode, timeout ,ncId and ttl.<p>Keys of testParameters for traceroute are encapType, replyMode, timeout ,ncId and ttl.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LdpTestRo'
              - description: LDP test request.<p>Options for type are ping<p>Keys of testParameters for ping are count, encapType, packetSize, replyMode, timeout ,ncId and ttl.<p>Keys of testParameters for traceroute are encapType, replyMode, timeout ,ncId and ttl.
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/loopbackOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startLbTest
      description: Start a photonics loopback test
      operationId: startLbTest
      parameters: []
      requestBody:
        description: Loopback test request.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LbTestRo'
              - description: Loopback test request.
        required: true
      responses:
        '200':
          description: Start test request completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/lspOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startLspTest
      description: 'Start a LSP test: ping, traceroute'
      operationId: startLspTest
      parameters: []
      requestBody:
        description: LSP test request.<p>Options for type are ping, traceroute.<p>Keys of testParameters for ping are count, encapType, packetSize, replyMode, timeout and ttl.<p>Keys of testParameters for traceroute are encapType, replyMode, timeout and ttl.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LspTestRo'
              - description: LSP test request.<p>Options for type are ping, traceroute.<p>Keys of testParameters for ping are count, encapType, packetSize, replyMode, timeout and ttl.<p>Keys of testParameters for traceroute are encapType, replyMode, timeout and ttl.
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/pwOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startPwTest
      description: 'Start a Pseudowire test: ping'
      operationId: startPwTest
      parameters: []
      requestBody:
        description: Pseudowire test request.<p>Options for type are ping and traceroute.<p>Keys of testParameters are count, encapType, packetSize, replyMode, segment, and timeout.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LspTestRo'
              - description: Pseudowire test request.<p>Options for type are ping and traceroute.<p>Keys of testParameters are count, encapType, packetSize, replyMode, segment, and timeout.
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/reflectorOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: reflectorOp
      description: Create/Delete Reflector
      operationId: reflectorOp
      parameters: []
      requestBody:
        description: Reflector Operation request.<p>Options for type are create, delete.<p>Mandatory key is type and reflectorId.<p>Keys of reflectorParameters are reflectorType, reflectionLevel and testMode.<p>reflectorParameters are not required for delete
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ReflectorOperationRo'
              - description: Reflector Operation request.<p>Options for type are create, delete.<p>Mandatory key is type and reflectorId.<p>Keys of reflectorParameters are reflectorType, reflectionLevel and testMode.<p>reflectorParameters are not required for delete
        required: true
      responses:
        '202':
          description: Reflector Operation request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/srOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startSrTest
      description: 'Start a SR test: ping, traceroute'
      operationId: startSrTest
      parameters: []
      requestBody:
        description: SR test request.<p>Options for type are ping, traceroute.<p>Keys of testParameters for ping are count, encapType, packetSize, replyMode, timeout ,ncId and ttl.<p>Keys of testParameters for traceroute are encapType, replyMode, timeout ,ncId and ttl.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrTestRo'
              - description: SR test request.<p>Options for type are ping, traceroute.<p>Keys of testParameters for ping are count, encapType, packetSize, replyMode, timeout ,ncId and ttl.<p>Keys of testParameters for traceroute are encapType, replyMode, timeout ,ncId and ttl.
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/srPolicyOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startSrPolicyTest
      description: 'Start a VRF test: ping'
      operationId: startSrPolicyTest
      parameters: []
      requestBody:
        description: SRPOLICY test request.<p>Options for type are ping. <p>Keys of testParameters for ping are policy name, packetSize,count, interval, timeout and ttl.<p>
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SrPolicyTestRo'
              - description: SRPOLICY test request.<p>Options for type are ping. <p>Keys of testParameters for ping are policy name, packetSize,count, interval, timeout and ttl.<p>
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/tdmOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startTdmTest
      description: Start a tdm test
      operationId: startTdmTest
      parameters: []
      requestBody:
        description: Test request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TdmLbTestRo'
              - description: Test request
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Testing resource is under testing or device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/vrfOperations:
    post:
      tags:
      - tdcapiv1tests
      summary: startVrfTest
      description: 'Start a VRF test: ping'
      operationId: startVrfTest
      parameters: []
      requestBody:
        description: VRF test request.<p>Options for type are ping. <p>Keys of testParameters for ping are Vrf Id, dest Prefix IP Address, packetSize, timeout and ttl.<p>
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/VrfTestRo'
              - description: VRF test request.<p>Options for type are ping. <p>Keys of testParameters for ping are Vrf Id, dest Prefix IP Address, packetSize, timeout and ttl.<p>
        required: true
      responses:
        '202':
          description: Start test request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Testing resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Device is LOA
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/{testId}:
    get:
      tags:
      - tdcapiv1tests
      summary: getTestRecordById
      description: Retrieve test record for a specific testId
      operationId: getTestRecordById
      parameters:
      - name: testId
        in: path
        description: test identifier
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '404':
          description: Test is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/{testId}/cancel:
    delete:
      tags:
      - tdcapiv1tests
      summary: cancelInProgressTest
      description: Cancel an in progress test
      operationId: cancelInProgressTest
      parameters:
      - name: testId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Test cancelled
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '202':
          description: Test cancelled
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultsRo'
        '400':
          description: Test not cancelled
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Test is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/its/itsConfiguration:
    post:
      tags:
      - tdcapiv1testsits
      summary: configure
      description: Configures Integrated Test Set configuration
      operationId: configure
      parameters: []
      requestBody:
        description: Integrated Test Set configuration request.<p>Options for type are raceTrack, testSet, networkMode.<p>Mandatory key of localTpeData is tpeId and optional keys are berThreshold, duration, loopback, monaBerThreshold, monbBerThreshold, monaPattern, monbPattern, genaPattern and genbPattern.<p>Mandatory key of remoteTpeData is tpeId and optional keys are loopback, monbBerThreshold, monbPattern and genbPattern.One of the optional key is mandatory either from localTpeData or remoteTpeData
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ItsOperationRo'
              - description: Integrated Test Set configuration request.<p>Options for type are raceTrack, testSet, networkMode.<p>Mandatory key of localTpeData is tpeId and optional keys are berThreshold, duration, loopback, monaBerThreshold, monbBerThreshold, monaPattern, monbPattern, genaPattern and genbPattern.<p>Mandatory key of remoteTpeData is tpeId and optional keys are loopback, monbBerThreshold, monbPattern and genbPattern.One of the optional key is mandatory either from localTpeData or remoteTpeData
        required: true
      responses:
        '202':
          description: Configuration request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItsTestRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/its/itsDescription:
    get:
      tags:
      - tdcapiv1testsits
      summary: getItsTestDescription
      description: Retrieve Integrated Test Set Description data.
      operationId: getItsTestDescription
      parameters:
      - name: freId
        in: query
        description: service FRE id
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: testType
        in: query
        description: test type options are raceTrack, testSet, networkMode
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: request is OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItsTestRo'
        '400':
          description: Test type is not supported
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v1/tests/its/itsUnconfiguration:
    post:
      tags:
      - tdcapiv1testsits
      summary: unConfigure
      description: Unconfigures Integrated Test Set configuration
      operationId: unConfigure
      parameters: []
      requestBody:
        description: Integrated Test Set unconfiguration request.<p>Options for type are raceTrack, testSet, networkMode.<p>Mandatory key of localTpeData & remoteTpeData is tpeId.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ItsOperationRo'
              - description: Integrated Test Set unconfiguration request.<p>Options for type are raceTrack, testSet, networkMode.<p>Mandatory key of localTpeData & remoteTpeData is tpeId.
        required: true
      responses:
        '202':
          description: Unconfiguration request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItsTestRo'
        '400':
          description: Invalid input
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v2/diag/operMeas:
    post:
      tags:
      - tdcapiv2diagoperMeas
      summary: startRouteDiag
      description: This API retrieves current and most recent operational measurements at client layer and supporting line layers of service endpoints
      operationId: startRouteDiag
      parameters: []
      requestBody:
        description: Request for operational measurements data  for a full route
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OperMeasRouteRequest'
              - description: Request for operational measurements data  for a full route
        required: true
      responses:
        '202':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperMeasRO'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v2/diag/operMeas/facilities:
    post:
      tags:
      - tdcapiv2diagoperMeas
      summary: startFacilityDiag
      description: This API retrieves historical operational measurements data for a given facility on a given Network Element
      operationId: startFacilityDiag
      parameters: []
      requestBody:
        description: Operational Measurement (facility) request data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OperMeasFacRequest'
              - description: Operational Measurement (facility) request data
        required: true
      responses:
        '202':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperMeasRO'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v2/diag/operMeas/latency/facilities:
    post:
      tags:
      - tdcapiv2diagoperMeas
      summary: startLatencyFacilityDiag
      description: This API retrieves latency data for a given resource ID on a given Network Element
      operationId: startLatencyFacilityDiag
      parameters: []
      requestBody:
        description: Operational Measurement (facility) request data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OperMeasLatencyRequest'
              - description: Operational Measurement (facility) request data
        required: true
      responses:
        '202':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperMeasRO'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v2/diag/operMeas/powerAttributes/facilities:
    post:
      tags:
      - tdcapiv2diagoperMeas
      summary: startPowerSnapshotAttributes
      description: This API retrieves power snapshot for a given service
      operationId: startPowerSnapshotAttributes
      parameters: []
      requestBody:
        description: Power Snapshot request data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PowerSnapshotRequestRO'
              - description: Power Snapshot request data
        required: true
      responses:
        '202':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperMeasRO'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v2/diag/operMeas/powerPms:
    post:
      tags:
      - tdcapiv2diagoperMeas
      summary: startPowerDiag
      description: This API retrieves optical power PM data for a given service or a given ROADM line
      operationId: startPowerDiag
      parameters: []
      requestBody:
        description: Optical Power(PMs) request data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OpticalPowerRequest'
              - description: Optical Power(PMs) request data
        required: true
      responses:
        '202':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperMeasRO'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /tdc/api/v2/diag/operMeas/reset:
    post:
      tags:
      - tdcapiv2diagoperMeas
      summary: resetPms
      description: This API resets current operational measurements data for a broadband service or infrastructure service
      operationId: resetPms
      parameters: []
      requestBody:
        description: Operational PM reset request data
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PmResetRequest'
              - description: Operational PM reset request data
        required: true
      responses:
        '202':
          description: Request accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PmResetRO'
        '400':
          description: Bad request. Input validation error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource is not found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: Internal system error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /kafka-rest/api/v1/topics/{topicName}:
    get:
      tags:
      - Topic Management
      summary: getTopic
      description: Returns a topic and its metadata
      operationId: getTopic
      parameters:
      - name: topicName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Request was successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetTopic'
            application/json:
              schema:
                $ref: '#/components/schemas/GetTopic'
        '404':
          description: Topic not found
          headers: {}
          content: {}
        '408':
          description: Timeout
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    put:
      tags:
      - Topic Management
      summary: alterTopic
      description: ONLY USE DURING MAINTENANCE WINDOW!! Alters a topic and its metadata
      operationId: alterTopic
      parameters:
      - name: topicName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutTopic'
        required: false
      responses:
        '204':
          description: Request was successful
          headers: {}
          content: {}
        '400':
          description: The request has invalid parameters
          headers: {}
          content: {}
        '404':
          description: Topic not found
          headers: {}
          content: {}
        '408':
          description: Timeout
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Topic Management
      summary: deleteTopic
      description: ONLY USE DURING MAINTENANCE WINDOW!! Deletes a topic and its metadata
      operationId: deleteTopic
      parameters:
      - name: topicName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Delete successful
          headers: {}
          content: {}
        '404':
          description: Topic not found
          headers: {}
          content: {}
        '408':
          description: Timeout
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /kafka-rest/api/v1/topics:
    post:
      tags:
      - Topic Management
      summary: createTopic
      description: Creates a topic with the provided configuration
      operationId: createTopic
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTopics'
        required: false
      responses:
        '201':
          description: Topics created
          headers: {}
          content: {}
        '207':
          description: Multi status
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '400':
          description: The request has invalid parameters
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: Conflict
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /kafka-rest/api/v1/monitor/{topicName}:
    get:
      tags:
      - Topic Monitoring
      summary: getTopicState
      description: Returns topic state
      operationId: getTopicState
      parameters:
      - name: topicName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TopicState'
            application/json:
              schema:
                $ref: '#/components/schemas/TopicState'
        '400':
          description: The request has invalid parameters
          headers: {}
          content: {}
        '404':
          description: Consumer group info for topic not found
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /kafka-rest/api/v1/monitor/{topicName}/{consumerGroup}:
    get:
      tags:
      - Topic Monitoring
      summary: getTopicConsumer
      description: Returns a topic state with respect to a consumergroup
      operationId: getTopicConsumer
      parameters:
      - name: topicName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: consumerGroup
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ConsumerGroupState'
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerGroupState'
        '400':
          description: The request has invalid parameters
          headers: {}
          content: {}
        '404':
          description: Consumer group info for topic not found
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /kafka-rest/api/v1/monitor/process-state/{topicName}/{consumerGroup}:
    get:
      tags:
      - Topic Monitoring
      summary: getTopicConsumerProcessState
      description: Returns process state of a consumergroup for a topic
      operationId: getTopicConsumerProcessState
      parameters:
      - name: topicName
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: consumerGroup
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ConsumerGroupProcessState'
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerGroupProcessState'
        '400':
          description: The request has invalid parameters
          headers: {}
          content: {}
        '404':
          description: Consumer group info for topic not found
          headers: {}
          content: {}
        '500':
          description: The server encountered an error while processing the request
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /upgrade/api/v1/upgrades:
    get:
      tags:
      - Upgrade Rest Service v1
      summary: listUpgrades
      description: List all upgrade processes
      operationId: listUpgrades
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Details were found successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                type: array
                items:
                  type: string
                description: ''
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: ''
        '500':
          description: The server encountered an error while upgrading
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    post:
      tags:
      - Upgrade Rest Service v1
      summary: upgradeSolutions
      description: Trigger Upgrade Process
      operationId: upgradeSolutions
      parameters: []
      requestBody:
        description: Upgrade request. It may include mutiple solution to be upgraded
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpgradeRequestRO'
              - description: Upgrade request. It may include mutiple solution to be upgraded
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UpgradeJob'
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeJob'
        '202':
          description: Upgrade request is accepted
          headers: {}
          content: {}
        '400':
          description: The upgrade request input is invalid
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while upgrading
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /upgrade/api/v1/upgrades/{jobId}:
    get:
      tags:
      - Upgrade Rest Service v1
      summary: listUpgradeJob
      description: List an upgrade process
      operationId: listUpgradeJob
      parameters:
      - name: jobId
        in: path
        description: Job Id of upgrade job
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Details were found successful
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/UpgradeJobRO'
                - description: The information about an upgrade
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/UpgradeJobRO'
                - description: The information about an upgrade
        '404':
          description: The job doesn't exist
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while upgrading
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
    delete:
      tags:
      - Upgrade Rest Service v1
      summary: stopUpgradeJob
      description: Stop an upgrade process
      operationId: stopUpgradeJob
      parameters:
      - name: jobId
        in: path
        description: Job Id of upgrade job
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: The upgrade job was stopped successful
          headers: {}
          content: {}
        '400':
          description: The job is not being processed
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The job doesn't exist
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /upgrade/api/v1/upgrades/{jobId}/commit:
    post:
      tags:
      - Upgrade Rest Service v1
      summary: commit
      description: Trigger cleanup of previous solution
      operationId: commit
      parameters:
      - name: jobId
        in: path
        description: Job Id of upgrade job
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                type: array
                items:
                  type: string
                description: ''
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: ''
        '204':
          description: Cleanup is successful
          headers: {}
          content: {}
        '400':
          description: Cannot clean up. The job is not succeeded
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The job doesn't exist
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while cleaning up.
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /upgrade/api/v1/upgrades/{jobId}/rollback:
    post:
      tags:
      - Upgrade Rest Service v1
      summary: rollback
      description: Trigger rollback of the upgrade job
      operationId: rollback
      parameters:
      - name: jobId
        in: path
        description: Job Id of upgrade job
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                type: array
                items:
                  type: string
                description: ''
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: ''
        '202':
          description: Rollback request is accepted
          headers: {}
          content: {}
        '400':
          description: Cannot rollback. The job is being processed
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: The job doesn't exist
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '500':
          description: The server encountered an error while cleaning up
          headers: {}
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      deprecated: false
  /events-to-service-correlator/api/v1/affectedServicesByResource:
    get:
      tags:
      - Resource to Service Query
      summary: getAffectedServicesByResource
      description: Search affected services for a resource
      operationId: getAffectedServicesByResource
      parameters:
      - name: resourceId
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Affected Services Query By Resource completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffectedServicesData'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /events-to-service-correlator/api/v1/affectedServicesCountsByResources:
    get:
      tags:
      - Resource to Service Query
      summary: getAffectedServicesCountsByResources
      description: Get number of affected services for resources
      operationId: getAffectedServicesCountsByResources
      parameters:
      - name: resourceIds
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Affected Services Counts By Resources Query completed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffectedServicesCounts'
        '500':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /equipmenttopologyplanning/api/v1/AutoSlatData/{projectId}:
    get:
      tags:
      - AutoSlatData
      summary: GeneratetheAuto-SLATdatausingprojectid
      description: Generate the Auto-SLAT data using project id
      operationId: GeneratetheAuto-SLATdatausingprojectid
      parameters:
      - name: projectId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AutoSlat.Network'
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSlat.Network'
            text/json:
              schema:
                $ref: '#/components/schemas/AutoSlat.Network'
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/AutoSlatData/name/{projectName}:
    get:
      tags:
      - AutoSlatData
      summary: GeneratetheAuto-SLATdatausingprojectname
      description: Generate the Auto-SLAT data using project name
      operationId: GeneratetheAuto-SLATdatausingprojectname
      parameters:
      - name: projectName
        in: path
        description: The project name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AutoSlat.Network'
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSlat.Network'
            text/json:
              schema:
                $ref: '#/components/schemas/AutoSlat.Network'
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/EquipmentKitNameMappings:
    get:
      tags:
      - EqptKitNameMappings
      summary: Getsallequipmentkitnamemappings
      description: Gets all equipment kit name mappings
      operationId: Getsallequipmentkitnamemappings
      parameters: []
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSummary.KitToOinMapping'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    post:
      tags:
      - EqptKitNameMappings
      summary: Createsanewequipmentkitnamemapping
      description: "- kitName:\r\n   - unique record identifier, meaning no duplicate records with the same kit name are allowed\r\n   - can't be null\r\n   - can't be series of white spaces\r\n    - valid string length is between 1 and 100 characters(inclusive)\r\n- oin: \r\n    - can't be null\r\n    - can't be series of white spaces\r\n    - valid string length is between 1 and 100 characters(inclusive)\r\n- comments:\r\n    - valid string length is between 0 and 600 characters(inclusive)\r\n- enabled:\r\n    - by default (if not specified) set to false"
      operationId: Createsanewequipmentkitnamemapping
      parameters: []
      requestBody:
        description: The equipment kit name mapping.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentSummary.KitToOinMappingItem'
              - description: The equipment kit name mapping.
        required: false
      responses:
        '201':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSummary.KitToOinMappingItem'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/EquipmentKitNameMappings/{kitName}:
    get:
      tags:
      - EqptKitNameMappings
      summary: GetEqptKitNameMappingByKitName
      description: Get the equipment kit name mapping for a given kitName
      operationId: GetEqptKitNameMappingByKitName
      parameters:
      - name: kitName
        in: path
        description: The equipment kit name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSummary.KitToOinMappingItem'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    put:
      tags:
      - EqptKitNameMappings
      summary: Updatesorcreateskitnamemapping
      description: "Updates kit name mapping if mapping with supplied kitName exists or creates new mapping otherwise.\r\n- oin: \r\n    - can't be null\r\n    - can't be series of white spaces\r\n    - valid string length is between 1 and 100 characters (inclusive) \r\n- comments:\r\n    - valid string length is between 0 and 600 characters (inclusive)\r\n- enabled:\r\n    - by default (if not specified) set to false"
      operationId: Updatesorcreateskitnamemapping
      parameters:
      - name: kitName
        in: path
        description: The equipment kit name.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The equipment kit name mapping.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmentSummary.KitToOinMappingItem'
              - description: The equipment kit name mapping.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSummary.KitToOinMappingItem'
        '201':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSummary.KitToOinMappingItem'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    delete:
      tags:
      - EqptKitNameMappings
      summary: DeletesequipmentkitnamemappingforagivenkitName
      description: Deletes equipment kit name mapping for a given kitName
      operationId: DeletesequipmentkitnamemappingforagivenkitName
      parameters:
      - name: kitName
        in: path
        description: The equipment kit name.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/Equipment:
    post:
      tags:
      - Equipment
      summary: Addsequipmenttoanode.
      description: Adds equipment to an existing node. The node may be in the planned state but must have been committed prior to adding equipment.
      operationId: Addsequipmenttoanode.
      parameters: []
      requestBody:
        description: The add equipment request.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Equipment.AddEquipmentRequest'
              - description: The add equipment request.
        required: false
      responses:
        '201':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Equipment.EquipmentResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v3/EquipmentSummary:
    get:
      tags:
      - EquipmentSummary
      summary: ComplexQueryParameters
      description: "One of the following combinations is allowed per request:\r\n1. physicalLocations:\r\nSummary for equipment at committed/deployed locations.\r\n2. physicalLocations and projects:\r\nSummary for equipment at committed/deployed locations that are part of any of the projects provided.\r\n3. physicalLocations and projectLists\r\nSummary for equipment at committed/deployed locations and equipment at those locations that are part of the project list (project list name)\r\nprovided\r\n4. physicalLocations and projectListIds\r\nSummary for equipment at committed/deployed locations and equipment at those locations that are part of the project list (project list id)\r\nprovided\r\n5. physicalLocations and projects and projectLists\r\nSummary for equipment at committed/deployed locations and equipment at those locations that are part of the project list (project list name)\r\nprovided and are part of any of the projects (project names) provided\r\n6. physicalLocations and projects and projectListIds\r\nSummary for equipment at committed/deployed locations and equipment at those locations that are part of the project list (project list id)\r\nprovided and are part of any of the projects (project names) provided\r\n7. projects:\r\nSummary for equipment that are part of any of the projects (project names) provided.\r\n8. projectIds:\r\nSummary for equipment that are part of any of the projects (project ids) provided.\r\n9. projectListIds:\r\nSummary for planned equipment that are part of project lists (project list ids) provided. If organizeByProject is set to true, display \r\nequipment for each project in a project list.\r\n10. projectLists:\r\nSummary for planned equipment that are part of project lists (project list names) provided. If organizeByProject is set to true, display\r\nequipment for each project in a project list.\r\n\r\nReturn codes for the different query scenarios:\r\n1. Return BadRequest (400) if the service cannot parse the query parameters or the combinations of those parameters.\r\n2. Return BadRequest (400) if the service cannot successfully parse the strings, \"physicalLocations\", \"projects\", \"projectIds\", \"projectListIds\", and \"projectLists\".\r\n3. Return BadRequest (400) if the service fails to retrieve project data using the project name which is specified in \"projects\".\r\n4. Return BadRequest (400) if the service fails to retrieve project data using the project id which is specified in \"projectIds\".\r\n5. Return BadRequest (400) if the service fails to retrieve project data using the project list id which is specified in \"projectListIds\".\r\n6. Return BadRequest (400) if the service fails to retrieve project data using the project list name which is specified in \"projectListIds\".\r\n7. Return NoContent (204) if there are no equipment being returned from any of physical locations and projects that are specified.\r\n8. Return NoContent (204) if there are no equipment being returned for any of the projectLists that are specified.\r\n9. Return Ok (200) if the service successfully retrieves equipment using the input query parameters.\r\n10.Return Internal Server Error (500) if the service encounters an unexpected error."
      operationId: ComplexQueryParameters
      parameters:
      - name: physicalLocations
        in: query
        description: List of comma-separated (deployed or committed) physical locations
        style: form
        explode: true
        schema:
          type: string
      - name: projects
        in: query
        description: List of comma-separated (deployed or committed) project names
        style: form
        explode: true
        schema:
          type: string
      - name: projectIds
        in: query
        description: List of comma-separated project identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: projectListIds
        in: query
        description: List of comma-separated project list identifiers
        style: form
        explode: true
        schema:
          type: string
      - name: projectLists
        in: query
        description: List of comma-separated project list names
        style: form
        explode: true
        schema:
          type: string
      - name: organizeByProject
        in: query
        description: Organize by project, defaults to true.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSummary.EquipmentSummaryResponseOrganizedByProject'
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v2/EquipmentSummary:
    get:
      tags:
      - EquipmentSummaryV2
      summary: GetByQueryParams
      description: >-
        One of the following combinations is allowed per request:

        1. physicalLocations:

        Summary for equipment at committed/deployed locations.

        2. physicalLocations and projects:

        Summary for equipment at committed/deployed locations that are part of any of the projects provided.

        3. projectId and/or projectName:

        Summary for planned equipment for the project provided.

        4. projectListId and/or projectListName:

        Summary for planned equipment for the project list provided. If organizeByProject is set to true then group

        equipment by projects in the list. Otherwise combine the equipment of all the projects together.
      operationId: GetByQueryParams
      parameters:
      - name: physicalLocations
        in: query
        description: List of comma-separated (deployed or committed) physical locations
        style: form
        explode: true
        schema:
          type: string
      - name: projects
        in: query
        description: List of comma-separated project names
        style: form
        explode: true
        schema:
          type: string
      - name: projectId
        in: query
        description: The project ID
        style: form
        explode: true
        schema:
          type: string
          format: uuid
      - name: projectName
        in: query
        description: The project name
        style: form
        explode: true
        schema:
          type: string
      - name: projectListId
        in: query
        description: The project list ID
        style: form
        explode: true
        schema:
          type: string
          format: uuid
      - name: projectListName
        in: query
        description: The project list name
        style: form
        explode: true
        schema:
          type: string
      - name: organizeByProject
        in: query
        description: Organize by project, defaults to true.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSummary.EquipmentSummaryResponseOrganizedByProject'
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/FiberRoutes:
    post:
      tags:
      - FiberRoutes
      summary: Createanewfiberroute.
      description: >-
        New fiber routes can be created between existing or new ROADM nodes. The request may contain any number of nodes with the restriction that the route

        must begin and end with a ROADM.
      operationId: Createanewfiberroute.
      parameters: []
      requestBody:
        description: The fiber route request.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FiberRoute.AddFiberRouteRequest'
              - description: The fiber route request.
        required: false
      responses:
        '201':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    put:
      tags:
      - FiberRoutes
      summary: RollfiberRoute.Themethoddetectstheaffectedfiberrouteandreturnsthedeltabetweentheaffectedrouteandthenewroute.
      description: Roll fiber Route. The method detects the affected fiber route and returns the delta between the affected route and the new route.
      operationId: RollfiberRoute.Themethoddetectstheaffectedfiberrouteandreturnsthedeltabetweentheaffectedrouteandthenewroute.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/FiberRoute.AddFiberRouteRequest'
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FiberRoute.FiberRouteDelta'
            application/json:
              schema:
                $ref: '#/components/schemas/FiberRoute.FiberRouteDelta'
            text/json:
              schema:
                $ref: '#/components/schemas/FiberRoute.FiberRouteDelta'
        '400':
          description: Bad Request
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData:
    get:
      tags:
      - GlobalConfigurationData
      summary: Getallconfigdata
      description: Get all config data
      operationId: Getallconfigdata
      parameters: []
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalConfigurationData.ConfigurationData'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    put:
      tags:
      - GlobalConfigurationData
      summary: Updatesthevalueforconfigdataitem.
      description: Updates the value for config data item.
      operationId: Updatesthevalueforconfigdataitem.
      parameters: []
      requestBody:
        description: The update request of configuration item.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EquipmenttopologyplanningApiV1GlobalConfigurationDataRequest'
              - description: The update request of configuration item.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/{itemKey}:
    get:
      tags:
      - GlobalConfigurationData
      summary: Getaconfigitemcorrespondingtoagivenkey
      description: Get a config item corresponding to a given key
      operationId: Getaconfigitemcorrespondingtoagivenkey
      parameters:
      - name: itemKey
        in: path
        description: The config item key
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/HeatDissipationLimitThreshold1/{heatDissipationLimitThreshold1Value}:
    put:
      tags:
      - GlobalConfigurationData
      summary: Updateconfigvaluecorrespondingtoheatdissipationlimitperbaythreshold1.
      description: 'NOTE: This operation should not be used, please use planning policies to set the global heat dissipation threshold'
      operationId: Updateconfigvaluecorrespondingtoheatdissipationlimitperbaythreshold1.
      parameters:
      - name: heatDissipationLimitThreshold1Value
        in: path
        description: Heat dissipation limit threshold 1 value to be updated.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: true
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/HeatDissipationLimitThreshold2/{heatDissipationLimitThreshold2Value}:
    put:
      tags:
      - GlobalConfigurationData
      summary: Updateconfigvaluecorrespondingtoheatdissipationlimitperbaythreshold2.
      description: 'NOTE: This operation should not be used, please use planning policies to set the global heat dissipation threshold'
      operationId: Updateconfigvaluecorrespondingtoheatdissipationlimitperbaythreshold2.
      parameters:
      - name: heatDissipationLimitThreshold2Value
        in: path
        description: Heat dissipation limit threshold 2 value to be updated.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: true
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/SingleILASiteLabel/{singleILASiteLabelValue}:
    put:
      tags:
      - GlobalConfigurationData
      summary: UpdatethesingleILAsitelabel
      description: Update the single ILA site label
      operationId: UpdatethesingleILAsitelabel
      parameters:
      - name: singleILASiteLabelValue
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/DualILASiteLabel/{dualILASiteLabelValue}:
    put:
      tags:
      - GlobalConfigurationData
      summary: UpdatethedualILAsitelabel
      description: Update the dual ILA site label
      operationId: UpdatethedualILAsitelabel
      parameters:
      - name: dualILASiteLabelValue
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/DgeWithSingleILASiteLabel/{DgeWithSingleILASiteLabelValue}:
    put:
      tags:
      - GlobalConfigurationData
      summary: UpdatetheDGEwithsingleILAsitelabel
      description: Update the DGE with single ILA site label
      operationId: UpdatetheDGEwithsingleILAsitelabel
      parameters:
      - name: dgeWithSingleILASiteLabelValue
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  ? /equipmenttopologyplanning/api/v1/GlobalConfigurationData/DgeWithAtoZDualILAZtoASingleILASiteLabel/{DgeWithAtoZDualILAZtoASingleILASiteLabelValue}
  : put:
      tags:
      - GlobalConfigurationData
      summary: UpdatetheDGEwithdualILAinA-ZandsingleILAinZ-Asitelabel
      description: Update the DGE with dual ILA in A-Z and single ILA in Z-A site label
      operationId: UpdatetheDGEwithdualILAinA-ZandsingleILAinZ-Asitelabel
      parameters:
      - name: dgeWithAtoZDualILAZtoASingleILASiteLabelValue
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  ? /equipmenttopologyplanning/api/v1/GlobalConfigurationData/DgeWithAtoZSingleILAZtoADualILASiteLabel/{DgeWithAtoZSingleILAZtoADualILASiteLabelValue}
  : put:
      tags:
      - GlobalConfigurationData
      summary: UpdatetheDGEwithsingleILAinA-ZanddualILAinZ-Asitelabel
      description: Update the DGE with single ILA in A-Z and dualILA in Z-A site label
      operationId: UpdatetheDGEwithsingleILAinA-ZanddualILAinZ-Asitelabel
      parameters:
      - name: dgeWithAtoZSingleILAZtoADualILASiteLabelValue
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/DgeWithDualILASiteLabel/{DgeWithDualILASiteLabelValue}:
    put:
      tags:
      - GlobalConfigurationData
      summary: UpdatetheDGEwithdualILAsitelabel
      description: Update the DGE with dual ILA site label
      operationId: UpdatetheDGEwithdualILAsitelabel
      parameters:
      - name: dgeWithDualILASiteLabelValue
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/GlobalConfigurationData/DefaultProfilePreferencesValue/{defaultProfilePreferencesValue}:
    put:
      tags:
      - GlobalConfigurationData
      summary: Updateconfigvaluecorrespondingtodefaultpreferencesprofile.
      description: Update config value corresponding to default preferences profile.
      operationId: Updateconfigvaluecorrespondingtodefaultpreferencesprofile.
      parameters:
      - name: defaultProfilePreferencesValue
        in: path
        description: New profile to be used {ROD, Generic}.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Model.GlobalConfigurationData'
                - description: Provides a Global table to store configuration data in key value pair
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/HeatDissipationReport:
    get:
      tags:
      - HeatDissipationReport
      summary: GetHeatDissipationReport
      description: >-
        Get Heat Dissipation Report API with support for different filters i.e.

        physicalLocations, tidNames, nodeIdentities, racks

        <para />Note: Use '|' as separator between mulitple values for any query parameter.

        <para />Following are some valid example query formats:

        <para /> 1. HeatDissipationReport?tidnames=tid1|tid2|tid3

        <para /> 2. HeatDissipationReport?tidnames=tid1&amp;racks=1|2

        <para /> 3. HeatDissipationReport?nodeidentities=clli1::1|clli2::2

        <para /> 4. HeatDissipationReport?nodeidentities=clli1::1&amp;racks=1|2

        <para /> 5. HeatDissipationReport?physicalLocations=site1|site2
      operationId: GetHeatDissipationReport
      parameters:
      - name: physicalLocations
        in: query
        description: Accepts one or more valid physicalLocations separated by '|'.
        style: form
        explode: true
        schema:
          type: string
      - name: tidNames
        in: query
        description: Accepts one or more valid tidNames separated by '|'.
        style: form
        explode: true
        schema:
          type: string
      - name: nodeIdentities
        in: query
        description: "Accepts one or more valid nodeIdentities separated by '|' and \r\n            each nodeIdentity with Clli and NodeId separated with \"::\" e.g. \"clli1::1\"."
        style: form
        explode: true
        schema:
          type: string
      - name: racks
        in: query
        description: Accepts one or more valid racks separated with '|'.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeatDissipationReport.HeatDissipationReport'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v2/PlannedData/fiberLoss:
    patch:
      tags:
      - PlannedDataV2
      summary: Partiallyupdatesalistoffibers
      description: "This request may be used in two ways:\r\n            \r\n1) Specifying only freId. The following properties are supported:\r\n- Loss: Total planned loss of the fiber span\r\n- Margin: Total planned margin of the fiber span\r\n- FiberLossReconciled: Indicates whether the planned fiber loss has been reconciled with measured fiber loss\r\n            \r\n2) Specifying freId and fiberId. The following properties are supported:\r\n- Loss: Planned fiber loss of the fiber\r\n- Margin: Planned margin of the fiber\r\n- HeadPPL: Planned head-end patch-panel loss of the fiber\r\n- TailPPL: Planned tail-end patch-panel loss of the fiber\r\n- FiberLossReconciled: Indicates whether the planned fiber loss has been reconciled with measured fiber loss"
      operationId: Partiallyupdatesalistoffibers
      parameters: []
      requestBody:
        description: fiberLoss
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlannedData.FiberList'
              - description: fiberLoss
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
            application/json:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
            text/json:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
        '400':
          description: Bad Request
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
      deprecated: false
    get:
      tags:
      - PlannedDataV2
      summary: GetfiberlossdataforoneormorefreIds
      description: "The request may contain any number of freIds for which loss values are to be fetched.\r\n            \r\nThe properties returned by this request for each freId are:\r\n- Loss: Total planned loss of the fiber span\r\n- Head-end patch-panel loss: Planned loss of the patch panel at the head of the fiber\r\n- Tail-end patch-panel loss: Planned loss of the patch panel at the tail of the fiber\r\n- Margin: Total planned margin of the fiber span\r\n- FiberLossReconciled: Indicates whether the planned fiber loss of the span has been reconciled with measured fiber loss"
      operationId: GetfiberlossdataforoneormorefreIds
      parameters:
      - name: freIds
        in: query
        description: Comma separated FreIDs for fibers.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
            application/json:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
            text/json:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
        '204':
          description: Success
          headers: {}
          content: {}
      deprecated: true
  /equipmenttopologyplanning/api/v2/PlannedData/snrData:
    get:
      tags:
      - PlannedDataV2
      summary: GetplannedOmsSnrdataforoneormoreOmsFreIds.
      description: "The request may contain any number of FreIds separated by commas for which Oms Snr data is to be fetched.\r\nIf no freIds are given in the request, then all the planned oms snr data is returned from the database.\r\n            \r\nReturn codes for the different query scenarios:\r\n1. Return Ok (200) if the input string is null or whitespace. The returned OmsList may be empty if no data is present in the database, but will never be null.\r\n2. Return Ok (200) if the input string contains any characters other than commas or whitespace. The returned OmsList may be empty if no data is found for any FreIds, but will never be null.\r\n3. Return BadRequest (400) if the input string is a combination of only commas and whitespace."
      operationId: GetplannedOmsSnrdataforoneormoreOmsFreIds.
      parameters:
      - name: freIds
        in: query
        description: (Optional) List of comma-separated freIds
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannedData.OmsList'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v2/PlannedData/snrData/file:
    get:
      tags:
      - PlannedDataV2
      summary: GetstheplannedOmsSnrdatafromthedatabaseasacompressedfile,eitherziporgzipformat
      description: "The request may contain any number of FreIds separated by commas for which Oms Snr data is to be fetched.\r\nIf no freIds are given in the request, then all the planned oms snr data is returned from the database.\r\n            \r\nReturn codes for the different query scenarios:\r\n1. Return Ok (200) if the input string is null or whitespace. The returned OmsList may be empty if no data is present in the database, but will never be null.\r\n2. Return Ok (200) if the input string contains any characters other than commas or whitespace. The returned OmsList may be empty if no data is found for any FreIds, but will never be null.\r\n3. Return BadRequest (400) if the input string is a combination of only commas and whitespace."
      operationId: GetstheplannedOmsSnrdatafromthedatabaseasacompressedfile,eitherziporgzipformat
      parameters:
      - name: freIds
        in: query
        description: (Optional) List of comma-separated freIds
        style: form
        explode: true
        schema:
          type: string
      - name: fileType
        in: query
        description: File type, allowed values are gzip or zip. If not set then this will return zip file
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
      deprecated: false
  /equipmenttopologyplanning/api/v2/PlannedData/InsertPlannedOmsSnrData:
    post:
      tags:
      - PlannedDataV2
      summary: Insertstheplannedomssnrinforeceivedfromoneplannerintothedatabase
      description: All existing Oms Snr records in the database are removed prior to inserting the provided set.
      operationId: Insertstheplannedomssnrinforeceivedfromoneplannerintothedatabase
      parameters: []
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PlannedData.OmsList'
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
      deprecated: false
  /equipmenttopologyplanning/api/v2/PlannedData/InsertPlannedOmsSnrDataFromFile:
    post:
      tags:
      - PlannedDataV2
      summary: InsertplannedOmsSnrdatafromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      description: >-
        All existing Oms Snr records in the database are removed prior to inserting the provided set.





        NOTE: This API uploads data from a file and does not display or work correctly in MCP REST API Documentation.

        Please use an API testing tool that supports form-data file upload to use this API.
      operationId: InsertplannedOmsSnrdatafromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          enum:
          - application/x-www-form-urlencoded
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                ContentType:
                  type: string
                ContentDisposition:
                  type: string
                Headers:
                  type: string
                Length:
                  type: integer
                  format: int64
                Name:
                  type: string
                FileName:
                  type: string
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      deprecated: false
  /equipmenttopologyplanning/api/v3/PlannedData/DeletePlannedFiberData:
    delete:
      tags:
      - PlannedDataV3
      summary: Deleteallplannedfiberdatathatdoesnotbelongtoaplanningproject
      description: This request is used to delete all planned fiber data that does not belong to a planning project.
      operationId: Deleteallplannedfiberdatathatdoesnotbelongtoaplanningproject
      parameters: []
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      deprecated: false
  /equipmenttopologyplanning/api/v3/PlannedData/fiberLoss:
    get:
      tags:
      - PlannedDataV3
      summary: GetfiberlossdataforoneormoreFreIds
      description: "The request may contain any number of FreIds separated by commas for which loss values are to be fetched.\r\n            \r\nThe properties returned by this request for each FreId are:\r\n- Loss: Total planned loss of the fiber span\r\n- Head-end patch-panel loss: Planned loss of the patch panel at the head of the fiber\r\n- Tail-end patch-panel loss: Planned loss of the patch panel at the tail of the fiber\r\n- Margin: Total planned margin of the fiber span\r\n- FiberLossReconciled: Indicates whether the planned fiber loss of the span has been reconciled with measured fiber loss\r\n\r\nReturn codes for the different query scenarios:\r\n1. Return BadRequest (400) if the input string is null, whitespace, or any combination of only commas and whitespace.\r\n2. Return Ok (200) if the input string contains any characters other than commas or whitespace. The returned FiberList may be empty if no data is found for any FreIds, but will never be null."
      operationId: GetfiberlossdataforoneormoreFreIds
      parameters:
      - name: freIds
        in: query
        description: Comma separated FreIDs for fibers.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
            application/json:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
            text/json:
              schema:
                $ref: '#/components/schemas/PlannedData.FiberList'
        '400':
          description: Bad Request
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Common.Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v3/PlannedData/InsertPlannedOmsSnrData:
    post:
      tags:
      - PlannedDataV3
      summary: PostInsertstheplannedomssnrinforeceivedfromoneplannerintothedatabase
      description: >-
        Oms Snr records in the database that overlap any portion of the provided set are removed prior to inserting the provided set.

        Oms Snr records that do not overlap any portion of the provided set are left in the database.
      operationId: PostInsertstheplannedomssnrinforeceivedfromoneplannerintothedatabase
      parameters: []
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PlannedData.OmsList'
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
      deprecated: false
  /equipmenttopologyplanning/api/v3/PlannedData/InsertPlannedOmsSnrDataFromFile:
    post:
      tags:
      - PlannedDataV3
      summary: PostInsertplannedOmsSnrdatafromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      description: >-
        Oms Snr records in the database that overlap any portion of the provided set are removed prior to inserting the provided set.

        Oms Snr records that do not overlap any portion of the provided set are left in the database.





        NOTE: This API uploads data from a file and does not display or work correctly in MCP REST API Documentation.

        Please use an API testing tool that supports form-data file upload to use this API.
      operationId: PostInsertplannedOmsSnrdatafromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          enum:
          - application/x-www-form-urlencoded
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                ContentType:
                  type: string
                ContentDisposition:
                  type: string
                Headers:
                  type: string
                Length:
                  type: integer
                  format: int64
                Name:
                  type: string
                FileName:
                  type: string
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      deprecated: false
  /equipmenttopologyplanning/api/v3/PlannedData/DeletePlannedOmsSnrData/{projectId}:
    delete:
      tags:
      - PlannedDataV3
      summary: ThisAPIdeletesSnrdataforanyOmsthathasnotyetbeendeployedusingProjectID.
      description: This API deletes Snr data for any Oms that has not yet been deployed using Project ID.
      operationId: ThisAPIdeletesSnrdataforanyOmsthathasnotyetbeendeployedusingProjectID.
      parameters:
      - name: projectId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      deprecated: false
  /equipmenttopologyplanning/api/v1/PlanningPolicies:
    get:
      tags:
      - PlanningPolicy
      summary: Getsplanningpolicies
      description: Gets planning policies
      operationId: Getsplanningpolicies
      parameters:
      - name: name
        in: query
        description: The planning policy name
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningPolicy.PlanningPolicy'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    post:
      tags:
      - PlanningPolicy
      summary: Createanewplanningpolicy
      description: "- Planning policy id :\r\n    - this planningPolicy parameter will be assigned internally and will be returned in the response body upon sucessful operation\r\n    - specifying planningPolicy id in the reqest body will result in bad request response\r\n- Planning policy name : \r\n    - valid name is any combinations of characters except empty string or series of white spaces\r\n    - duplicate names are not allowed\r\n- Planning policy userActivityInfo : \r\n    - this property values are internally assigned and will be returned in the response body upon sucessful operation\r\n    - specifying userActivityInfo in the request body will result in bad request response\r\n- ServiceProvisioningPolicy :\r\n    - cardPec property is validated as follows:\r\n        - cardPec cannot be left blank\r\n        - cardPec has to match one of the supported card pecs for the current release\r\n        - same cardPec cannot be used in two different CardPolicies\r\n    - certifiedMatePecs property is validated as follows:\r\n        - mate pec strings are validated against supported card pecs for the current release\r\n        - mate pecs and cardPec are validated if they are actually compatible (can be mated) in the current release\r\n        - certifiedMatePecs section should be left blank for OTR or MOTR cards. Cards that host client and line ports on the same card should leave this section blank since same card is used as mate\r\n    - certifiedClientPluggables property is validated as follows:\r\n        - client pluggables pec and rate combinations are validated if they are actually supported by cardPec in current release\r\n        - client pluggables pec and rate combinations have to be unique, meaning duplicate definitions are not allowed  \r\n        - client pluggable pec cannot be left blank\r\n        - certifiedClientPluggables section should be left blank for cards that do not have any supported client pluggable (like line cards or client cards with built in client port)\r\n        - certifiedClientPluggables cannot be left blank if card supports at least one client pluggable"
      operationId: Createanewplanningpolicy
      parameters: []
      requestBody:
        description: The planning policy.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlanningPolicy.PlanningPolicy'
              - description: The planning policy.
        required: false
      responses:
        '201':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningPolicy.PlanningPolicy'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/PlanningPolicies/{id}:
    get:
      tags:
      - PlanningPolicy
      summary: GetPolicyByGuid
      description: Get a planning policy by Id
      operationId: GetPolicyByGuid
      parameters:
      - name: id
        in: path
        description: The planning policy Id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningPolicy.PlanningPolicy'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    put:
      tags:
      - PlanningPolicy
      summary: Updatesthespecifiedplanningpolicy
      description: "- Planning policy id :\r\n    - if planningPolicy parameter contains id it shall match id parameter, otherwise bad request response is returned. It is ok to ommit id value in the planningPolicy body\r\n- Planning policy name :\r\n    -  planningPolicy name parameter shall be unique. If duplicate request will result in bad request response\r\n    -  planningPolicy name parameter can't be empty string or series of white spaces and request with such values will result in bad request response\r\n- Planning policy userActivityInfo : \r\n    - this property values are internally assigned and will be returned in the response body upon sucessful operation\r\n    - specifying userActivityInfo in the request body will result in bad request response\r\n- ServiceProvisioningPolicy :\r\n    - cardPec property is validated as follows:\r\n        - cardPec cannot be left blank\r\n        - cardPec has to match one of the supported card pecs for the current release\r\n        - same cardPec cannot be used in two different CardPolicies\r\n    - certifiedMatePecs property is validated as follows:\r\n        - mate pec strings are validated against supported card pecs for the current release\r\n        - mate pecs and cardPec are validated if they are actually compatible (can be mated) in the current release\r\n        - certifiedMatePecs section should be left blank for OTR or MOTR cards. Cards that host client and line ports on the same card should leave this section blank since same card is used as mate\r\n    - certifiedClientPluggables property is validated as follows:\r\n        - client pluggables pec and rate combinations are validated if they are actually supported by cardPec in current release\r\n        - client pluggables pec and rate combinations have to be unique, meaning duplicate definitions are not allowed  \r\n        - client pluggable pec cannot be left blank\r\n        - certifiedClientPluggables section should be left blank for cards that do not have any supported client pluggable (like line cards or client cards with built in client port)\r\n        - certifiedClientPluggables cannot be left blank if card supports at least one client pluggable"
      operationId: Updatesthespecifiedplanningpolicy
      parameters:
      - name: id
        in: path
        description: The planning policy ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: The planning policy.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlanningPolicy.PlanningPolicy'
              - description: The planning policy.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningPolicy.PlanningPolicy'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.ErrorList'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
    delete:
      tags:
      - PlanningPolicy
      summary: Deletesaplanningpolicy
      description: Deletes a planning policy
      operationId: Deletesaplanningpolicy
      parameters:
      - name: id
        in: path
        description: The planning policy Id.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.Error'
      deprecated: false
  /equipmenttopologyplanning/api/v1/PostUpgrade/UpgradeProjects:
    post:
      tags:
      - PostUpgrade
      summary: UpdatestheprojectsaccordingtonewOnepObjectmodel.
      description: Updates the projects according to new Onep Object model.
      operationId: UpdatestheprojectsaccordingtonewOnepObjectmodel.
      parameters: []
      requestBody:
        description: List of projects which should be upgraded.
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                type: string
                format: uuid
              description: List of projects which should be upgraded.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
      deprecated: false
  /equipmenttopologyplanning/api/v1/ProjectEquipmentDetails/equipmentcount:
    get:
      tags:
      - ProjectEquipmentDetails
      summary: gettotalequipmentcountforaprojectintent
      description: get total equipment count for a project intent
      operationId: gettotalequipmentcountforaprojectintent
      parameters:
      - name: intentId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: projectName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      deprecated: false
  /equipmenttopologyplanning/api/v1/ProjectEquipmentDetails/equipmentdetailsdata:
    delete:
      tags:
      - ProjectEquipmentDetails
      summary: Deletesequipmentdetailsdataforaprojectintent
      description: Deletes equipment details data for a project intent
      operationId: Deletesequipmentdetailsdataforaprojectintent
      parameters:
      - name: intentId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: projectName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      deprecated: false
  /gcs/api/v1/callback:
    post:
      tags:
      - callback
      summary: AddCallback
      description: Adds the given callbacks to the configuration specified.
      operationId: AddCallback
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: The callbacks to add to the configurations.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CallbackRequest'
              description: The callbacks to add to the configurations.
        required: true
      responses:
        '200':
          description: Returns the specified configuration(s).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Failed to validate or parse the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
    delete:
      tags:
      - callback
      summary: DeleteCallback
      description: Removes the given callbacks from the configuration specified
      operationId: DeleteCallback
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Configuration successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Failed to validate the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
  /gcs/api/v1/inheritable:
    post:
      tags:
      - inheritable
      summary: AddInheritable
      description: Returns the configuration value specified by URL parameters.
      operationId: AddInheritable
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: The callbacks to add to the configurations.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CallbackRequest'
              description: The callbacks to add to the configurations.
        required: true
      responses:
        '200':
          description: Returns the specified configuration(s).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Failed to parse or validate the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
    delete:
      tags:
      - inheritable
      summary: DeleteInheritable
      description: Removes the given inheritable callbacks from the configuration specified and all applicable child configurations.
      operationId: DeleteInheritable
      parameters:
      - name: sort
        in: query
        description: >-
          Sorts the response objects by the field specified. If not every value is specified, the order of precedence goes service, instance, partition, group(s), name with the specified field(s) taking highest precedence.


          Simply including the name implies an Ascending sort.  Appending a \'-\' to the prefix signifies descending.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Inheritable callback successfully added.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Failed to parse or validate the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while processing the request.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
  /planningnetworkexport/api/v1/Networks/TpeFre:
    get:
      tags:
      - Networks
      summary: Downloadrawtpefredataas.mcpcfile
      description: Download raw tpe fre data as .mcpc file
      operationId: Downloadrawtpefredataas.mcpcfile
      parameters:
      - name: captureTimeOutInMins
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 30
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects:
    get:
      tags:
      - PlanningProjects
      summary: Getsplanningprojects.
      description: >-
        Can filter on the list of planning projects using one of the following:

        - name: filter on projects with specified name

        - projectType and/or projectState: filter on projects with the specified projectType and/or projectState

        - projects with completion date within specified dates

        - archivedStatus: filter projects with specified archived status- All, Archived, UnArchived
      operationId: Getsplanningprojects.
      parameters:
      - name: name
        in: query
        description: The project name.
        style: form
        explode: true
        schema:
          type: string
      - name: projectState
        in: query
        description: List of comma separated project states to filter on.
        style: form
        explode: true
        schema:
          type: string
      - name: projectType
        in: query
        description: List of comma separated project types to filter on.
        style: form
        explode: true
        schema:
          type: string
      - name: completionDateStart
        in: query
        description: The RFC 3339 date specifying the beginning of the interval (e.g. 2017-10-02T10:00:00-05:00).
        style: form
        explode: true
        schema:
          type: string
      - name: completionDateEnd
        in: query
        description: The RFC 3339 date specifying the end of the interval (e.g. 2017-10-02T10:00:00-05:00).
        style: form
        explode: true
        schema:
          type: string
      - name: archivedStatus
        in: query
        description: filter projects with specified archived status
        style: form
        explode: true
        schema:
          type: object
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlanningProject'
                description: ''
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    post:
      tags:
      - PlanningProjects
      summary: Createaplanningproject.
      description: Create a new planning project. The initial state of the new project will always be New.
      operationId: Createaplanningproject.
      parameters:
      - name: profileName
        in: query
        description: "The current proffile if ROD or Generic. \r\n            This will be passed by taking current profile from ETP by some other libraries like Onep-proxy"
        style: form
        explode: true
        schema:
          type: string
          default: ROD
      requestBody:
        description: The planning project.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlanningProject'
              - description: The planning project.
        required: false
      responses:
        '201':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningProject'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    delete:
      tags:
      - PlanningProjects
      summary: Deletesplanningprojects.
      description: >-
        Deleting a project is only allowed if the project is not in the Committing state. Deleting a project

        deletes all associated data, including intent.
      operationId: Deletesplanningprojects.
      parameters:
      - name: name
        in: query
        description: The planning project name.
        style: form
        explode: true
        schema:
          type: string
      - name: checkDependencies
        in: query
        description: If set to true, then validate if other projects depend on project being deleted.
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '202':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects/{id}:
    get:
      tags:
      - PlanningProjects
      summary: GetByGuid
      description: Get a planning project by ID.
      operationId: GetByGuid
      parameters:
      - name: id
        in: path
        description: The planning project ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningProject'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    put:
      tags:
      - PlanningProjects
      summary: Updatesthespecifiedplanningproject.
      description: Updates the specified planning project.
      operationId: Updatesthespecifiedplanningproject.
      parameters:
      - name: id
        in: path
        description: The planning project ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: The planning project.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlanningProject'
              - description: The planning project.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningProject'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    delete:
      tags:
      - PlanningProjects
      summary: Deletesaplanningproject.
      description: >-
        Deleting a project is only allowed if the project is not in the Committing state. Deleting a project

        deletes all associated data, including intent.
      operationId: Deletesaplanningproject.
      parameters:
      - name: id
        in: path
        description: The planning project ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: checkDependencies
        in: query
        description: If set to true, then validate if other projects depend on project being deleted.
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '202':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects/{id}/commit:
    post:
      tags:
      - PlanningProjects
      summary: Commitstheplanningproject.
      description: >-
        Committing a project is an asynchronous operation that creates equipment intent. A project can only be committed

        when the state is InProcess. Query the project's status for the result of the commit and the intent ID, if successful.
      operationId: Commitstheplanningproject.
      parameters:
      - name: id
        in: path
        description: The planning project ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningProject'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects/{id}/commitOperation:
    post:
      tags:
      - PlanningProjects
      summary: Commitstheplanningproject.1
      description: >-
        NOTE: This operation will be removed in MCP 17.06.

        Please use the commit operation instead to commit the project



        Committing a project is an asynchronous operation that creates equipment intent. A project can only be committed

        when the state is InProcess. Query the project's status for the result of the commit and the intent ID, if successful.
      operationId: Commitstheplanningproject.1
      parameters:
      - name: id
        in: path
        description: The planning project ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningProject'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: true
  /projectmanagement/api/v1/PlanningProjects/commit:
    post:
      tags:
      - PlanningProjects
      summary: Commitsplanningprojects.
      description: >-
        Committing a project is an asynchronous operation that creates equipment intent. A project can only be committed

        when the state is InProcess. Query the project's status for the result of the commit and the intent ID, if successful.
      operationId: Commitsplanningprojects.
      parameters:
      - name: name
        in: query
        description: The planning project name.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects/commitOperation:
    post:
      tags:
      - PlanningProjects
      summary: Commitsplanningprojects.1
      description: >-
        NOTE: This operation will be removed in MCP 17.06.

        Please use the commit operation instead to commit the project



        Committing a project is an asynchronous operation that creates equipment intent. A project can only be committed

        when the state is InProcess. Query the project's status for the result of the commit and the intent ID, if successful.
      operationId: Commitsplanningprojects.1
      parameters:
      - name: name
        in: query
        description: The planning project name.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: true
  /projectmanagement/api/v1/PlanningProjects/{id}/cancel:
    post:
      tags:
      - PlanningProjects
      summary: Cancelsaplanningproject.
      description: >-
        Cancels a project asynchronously. Query the project status to get the result of the commit. A planning project can only be canceled

        when the state is Committed. In the former state, the project will go directly to When a project has been committed,

        a request to Delete the Intent is issued (Canceling) and if successful, the project state will be Canceled.

        If the intent Delete cannot be completed, the project state will be either CancelFailed or Error.



        If the project is New, Error or InProcess, use the Planning Project Delete operation instead.
      operationId: Cancelsaplanningproject.
      parameters:
      - name: id
        in: path
        description: The planning project ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: ignoreEquipmentProvisioning
        in: query
        description: Optional parameter. If set to true provisioned equipment will be deleted. False by default.
        style: form
        explode: true
        schema:
          type: boolean
      - name: checkDependencies
        in: query
        description: If set to true, then validate if other projects depend on project being cancelled.
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects/{id}/cancelOperation:
    post:
      tags:
      - PlanningProjects
      summary: Cancelsaplanningproject.1
      description: >-
        NOTE: This operation will be removed in MCP 17.06.

        Please use the cancel operation instead to cancel the project



        Cancels a project asynchronously. Query the project status to get the result of the commit. A planning project can only be canceled

        when the state is Committed. In the former state, the project will go directly to When a project has been committed,

        a request to Delete the Intent is issued (Canceling) and if successful, the project state will be Canceled.

        If the intent Delete cannot be completed, the project state will be either CancelFailed or Error.



        If the project is New, Error or InProcess, use the Planning Project Delete operation instead.
      operationId: Cancelsaplanningproject.1
      parameters:
      - name: id
        in: path
        description: The planning project ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: ignoreEquipmentProvisioning
        in: query
        description: Optional parameter. If set to true provisioned equipment will be deleted. False by default.
        style: form
        explode: true
        schema:
          type: boolean
      - name: checkDependencies
        in: query
        description: If set to true, then validate if other projects depend on project being cancelled.
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: true
  /projectmanagement/api/v1/PlanningProjects/cancel:
    post:
      tags:
      - PlanningProjects
      summary: Cancelsplanningproject.
      description: >-
        Cancels a project asynchronously. Query the project status to get the result of the commit. A planning project can only be canceled

        when the state is Committed. In the former state, the project will go directly to When a project has been committed,

        a request to Delete the Intent is issued (Canceling) and if successful, the project state will be Canceled.

        If the intent Delete cannot be completed, the project state will be either CancelFailed or Error.



        If the project is New, Error or InProcess, use the Planning Project Delete operation instead.
      operationId: Cancelsplanningproject.
      parameters:
      - name: name
        in: query
        description: The planning project name.
        style: form
        explode: true
        schema:
          type: string
      - name: ignoreEquipmentProvisioning
        in: query
        description: Optional parameter. If set to true provisioned equipment will be deleted. False by default.
        style: form
        explode: true
        schema:
          type: boolean
      - name: checkDependencies
        in: query
        description: If set to true, then validate if other projects depend on project being cancelled.
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects/cancelOperation:
    post:
      tags:
      - PlanningProjects
      summary: Cancelsplanningproject.1
      description: >-
        NOTE: This operation will be removed in MCP 17.06.

        Please use the cancel operation instead to cancel the project



        Cancels a project asynchronously. Query the project status to get the result of the commit. A planning project can only be canceled

        when the state is Committed. In the former state, the project will go directly to When a project has been committed,

        a request to Delete the Intent is issued (Canceling) and if successful, the project state will be Canceled.

        If the intent Delete cannot be completed, the project state will be either CancelFailed or Error.



        If the project is New, Error or InProcess, use the Planning Project Delete operation instead.
      operationId: Cancelsplanningproject.1
      parameters:
      - name: name
        in: query
        description: The planning project name.
        style: form
        explode: true
        schema:
          type: string
      - name: ignoreEquipmentProvisioning
        in: query
        description: Optional parameter. If set to true provisioned equipment will be deleted. False by default.
        style: form
        explode: true
        schema:
          type: boolean
      - name: checkDependencies
        in: query
        description: If set to true, then validate if other projects depend on project being cancelled.
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: true
  /projectmanagement/api/v1/PlanningProjects/updateArchivedStatus:
    post:
      tags:
      - PlanningProjects
      summary: Updatesthespecifiedarchivedstatusofplanningprojects.
      description: Updates the specified archived status of planning projects.
      operationId: Updatesthespecifiedarchivedstatusofplanningprojects.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ProjectsArchivedStatusUpdateRequest'
        required: false
      responses:
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/PlanningProjects/nameChangeOperation:
    post:
      tags:
      - PlanningProjects
      summary: Changesthenameofaplanningproject.
      description: >-
        NOTE: This operation will be removed in MCP 17.06.

        Please use the PATCH operation instead to modify the name
      operationId: Changesthenameofaplanningproject.
      parameters:
      - name: name
        in: query
        description: The planning project name.
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: The new name of the planning project.
        content:
          application/json-patch+json:
            schema:
              type: string
              description: The new name of the planning project.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningProject'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: true
  /projectmanagement/api/v1/PlanningProjects/name/{projectName}:
    patch:
      tags:
      - PlanningProjects
      summary: Partiallyupdatestheproject.
      description: Partially updates the project.
      operationId: Partiallyupdatestheproject.
      parameters:
      - name: projectName
        in: path
        description: Name of the project.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The planning project.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PlanningProject'
              - description: The planning project.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanningProject'
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v2/ProjectLists:
    get:
      tags:
      - ProjectLists
      summary: Getallprojectlists.
      description: Get all project lists.
      operationId: Getallprojectlists.
      parameters:
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    post:
      tags:
      - ProjectLists
      summary: Createaprojectlist.
      description: >-
        Create a project list. Project lists can only be created empty. Use the addProject REST API to add projects to the project list.

        The initial state of the new project list will always be New.
      operationId: Createaprojectlist.
      parameters: []
      requestBody:
        description: Project list to create.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProjectList'
              - description: Project list to create.
        required: false
      responses:
        '201':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectList'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v2/ProjectLists/{id}:
    get:
      tags:
      - ProjectLists
      summary: GetaprojectlistbyID.
      description: Get a project list by ID.
      operationId: GetaprojectlistbyID.
      parameters:
      - name: id
        in: path
        description: The project list ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v2/ProjectLists/{projectListId}/addProject:
    post:
      tags:
      - ProjectLists
      summary: Appendaprojecttothelistandvalidatetheprojectlist.
      description: >-
        This REST API is intended to be used during pre load to validate project dependencies. Please note that conflicts do not get resolved currently.

        The following assumptions are made:

        * A Project can only be added to one Project List

        * Each time a project is added, it will be validated against the list

        * A project cannot be removed from a list (the list must be deleted)

        * Equipment projects must be created against a list to account for planned equipment or nodes in the project list.
      operationId: Appendaprojecttothelistandvalidatetheprojectlist.
      parameters:
      - name: projectListId
        in: path
        description: The project list ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: The identifier of the project to append to the list.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddProjectRequest'
              - description: The identifier of the project to append to the list.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectList'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v2/ProjectLists/name/{projectListName}/addProject:
    post:
      tags:
      - ProjectLists
      summary: PostAppendaprojecttothelistandvalidatetheprojectlist.
      description: >-
        This REST API is intended to be used during pre load to validate project dependencies. Please note that conflicts do not get resolved currently.

        The following assumptions are made:

        * A Project can only be added to one Project List

        * Each time a project is added, it will be validated against the list

        * A project cannot be removed from a list (the list must be deleted)

        * Equipment projects must be created against a list to account for planned equipment or nodes in the project list.
      operationId: PostAppendaprojecttothelistandvalidatetheprojectlist.
      parameters:
      - name: projectListName
        in: path
        description: The project list name.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The identifier of the project to append to the list.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddProjectRequest'
              - description: The identifier of the project to append to the list.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectList'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v2/ProjectLists/{projectListId}:
    delete:
      tags:
      - ProjectLists
      summary: DeleteaprojectlistbyID.
      description: Delete a project list by ID. This operation will first remove all projects from the list.
      operationId: DeleteaprojectlistbyID.
      parameters:
      - name: projectListId
        in: path
        description: The project list ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v2/ProjectLists/name/{projectListName}:
    delete:
      tags:
      - ProjectLists
      summary: Deleteaprojectlistbyname.
      description: Delete a project list by name. This operation will first remove all projects from the list.
      operationId: Deleteaprojectlistbyname.
      parameters:
      - name: projectListName
        in: path
        description: The project list name.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/ProjectLists:
    get:
      tags:
      - ProjectListsV1
      summary: Getallprojectlists.1
      description: Get all project lists.
      operationId: Getallprojectlists.1
      parameters:
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListV1'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    post:
      tags:
      - ProjectListsV1
      summary: PostCreateaprojectlist.
      description: >-
        Create a project list. Project lists can only be created empty. Use the addProject REST API to add projects to the project list.

        The initial state of the new project list will always be New.
      operationId: PostCreateaprojectlist.
      parameters: []
      requestBody:
        description: Project list to create.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProjectListV1'
              - description: Project list to create.
        required: false
      responses:
        '201':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListV1'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/ProjectLists/{id}:
    get:
      tags:
      - ProjectListsV1
      summary: GetaprojectlistbyID.1
      description: Get a project list by ID.
      operationId: GetaprojectlistbyID.1
      parameters:
      - name: id
        in: path
        description: The project list ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListV1'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/ProjectLists/{projectListId}/addProject:
    post:
      tags:
      - ProjectListsV1
      summary: PostAppendaprojecttothelistandvalidatetheprojectlist.1
      description: Append a project to the list and validate the project list.
      operationId: PostAppendaprojecttothelistandvalidatetheprojectlist.1
      parameters:
      - name: projectListId
        in: path
        description: The project list ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      requestBody:
        description: The identifier of the project to append to the list.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddProjectRequest'
              - description: The identifier of the project to append to the list.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListV1'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/ProjectLists/name/{projectListName}/addProject:
    post:
      tags:
      - ProjectListsV1
      summary: PostAppendaprojecttothelistandvalidatetheprojectlist.2
      description: Append a project to the list and validate the project list.
      operationId: PostAppendaprojecttothelistandvalidatetheprojectlist.2
      parameters:
      - name: projectListName
        in: path
        description: The project list name.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The identifier of the project to append to the list.
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddProjectRequest'
              - description: The identifier of the project to append to the list.
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListV1'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/ProjectLists/{projectListId}:
    delete:
      tags:
      - ProjectListsV1
      summary: DeleteaprojectlistbyID.1
      description: Delete a project list by ID. This operation will first remove all projects from the list.
      operationId: DeleteaprojectlistbyID.1
      parameters:
      - name: projectListId
        in: path
        description: The project list ID.
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /projectmanagement/api/v1/ProjectLists/name/{projectListName}:
    delete:
      tags:
      - ProjectListsV1
      summary: Deleteaprojectlistbyname.1
      description: Delete a project list by name. This operation will first remove all projects from the list.
      operationId: Deleteaprojectlistbyname.1
      parameters:
      - name: projectListName
        in: path
        description: The project list name.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /bpoifdnbi/api/v1/serviceIntent/deploy:
    post:
      tags:
      - Service Deploy
      summary: deployServiceIntent
      description: Deploys a Service to the network
      operationId: deployServiceIntent
      parameters: []
      requestBody:
        description: Service Deploy Input
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/service-operationinput'
              - description: Service Deploy Input
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '404':
          description: Service not Found
          headers: {}
          content: {}
        '500':
          description: Internal system error
          headers: {}
          content: {}
      deprecated: false
  /bpoifdnbi/api/v1/serviceIntent/undeploy:
    post:
      tags:
      - Service Undeploy
      summary: undeployServiceIntent
      description: Undeploys a Service from the network
      operationId: undeployServiceIntent
      parameters: []
      requestBody:
        description: Service Undeploy Input
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/service-operationinput'
              - description: Service Undeploy Input
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '404':
          description: Service not Found
          headers: {}
          content: {}
        '500':
          description: Internal system error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/connection/:
    get:
      tags:
      - tapi-connectivity
      summary: TapiCoreContextConnection_GET
      description: returns deeppaging.connection.Response
      operationId: TapiCoreContextConnection_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.connection.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.connection.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/connectivity-context/connection/:
    get:
      tags:
      - tapi-connectivity
      summary: TapiDataContextConnectivityContextConnection_GET
      description: returns tapi.connectivity.Connection
      operationId: TapiDataContextConnectivityContextConnection_GET
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.connectivity.Connection
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/context/connectivity-context/connection={uuid}:
    get:
      tags:
      - tapi-connectivity
      summary: UntitledEndpoint_GET
      description: returns tapi.connectivity.Connection
      operationId: UntitledEndpoint_GET
      parameters:
      - name: uuid
        in: path
        description: Id of connection
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.connectivity.Connection
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}:
    get:
      tags:
      - tapi-connectivity
      summary: UntitledEndpoint_GET1
      description: returns tapi.connectivity.Connection
      operationId: UntitledEndpoint_GET1
      parameters:
      - name: uuid
        in: path
        description: Id of connection
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.connectivity.Connection
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/connectivity-context/provisioning/connectivity-service/:
    post:
      tags:
      - tapi-connectivity
      summary: TapiDataContextConnectivityContextProvisioningConnectivityService_POST
      description: 'creates tapi.connectivity.connectivitycontext.ConnectivityService (note: operation unavailable on standby servers)'
      operationId: TapiDataContextConnectivityContextProvisioningConnectivityService_POST
      parameters: []
      requestBody:
        description: tapi.connectivity.connectivitycontext.ConnectivityService to be added to list
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
              - description: tapi.connectivity.connectivitycontext.ConnectivityService to be added to list
        required: false
      responses:
        '201':
          description: Object created
          headers: {}
          content: {}
        '400':
          description: Internal error
          headers: {}
          content: {}
        '409':
          description: Object already exists
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/context/connectivity-context/provisioning/connectivity-service={uuid}:
    delete:
      tags:
      - tapi-connectivity
      summary: UntitledEndpoint_DELETE
      description: 'removes tapi.connectivity.connectivitycontext.ConnectivityService (note: operation unavailable on standby servers)'
      operationId: UntitledEndpoint_DELETE
      parameters:
      - name: uuid
        in: path
        description: Id of connectivity-service
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Object deleted
          headers: {}
          content: {}
        '400':
          description: Internal error
          headers: {}
          content: {}
        '404':
          description: Not found
          headers: {}
          content: {}
        '500':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/context/connectivity-context/provisioning/connectivity-service={uuid}/name:
    post:
      tags:
      - tapi-connectivity
      summary: createstapi.common.NameAndValue
      description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
      operationId: createstapi.common.NameAndValue
      parameters:
      - name: uuid
        in: path
        description: Id of connectivity-service
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: tapi.common.NameAndValue to be added to list
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/tapi.common.NameAndValue'
              - description: tapi.common.NameAndValue to be added to list
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '201':
          description: Object created
          headers: {}
          content: {}
        '400':
          description: Internal error
          headers: {}
          content: {}
        '409':
          description: Object already exists
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/name:
    post:
      tags:
      - tapi-connectivity
      summary: createstapi.common.NameAndValue1
      description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
      operationId: createstapi.common.NameAndValue1
      parameters:
      - name: uuid
        in: path
        description: Id of connectivity-service
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: tapi.common.NameAndValue to be added to list
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/tapi.common.NameAndValue'
              - description: tapi.common.NameAndValue to be added to list
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '201':
          description: Object created
          headers: {}
          content: {}
        '400':
          description: Internal error
          headers: {}
          content: {}
        '409':
          description: Object already exists
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/connectivity-service/:
    get:
      tags:
      - tapi-connectivity
      summary: TapiCoreContextConnectivityService_GET
      description: returns deeppaging.connectivity-service.Response
      operationId: TapiCoreContextConnectivityService_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.connectivity-service.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.connectivity-service.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/connectivity-context/connectivity-service/:
    get:
      tags:
      - tapi-connectivity
      summary: TapiDataContextConnectivityContextConnectivityService_GET
      description: returns tapi.connectivity.connectivitycontext.ConnectivityService
      operationId: TapiDataContextConnectivityContextConnectivityService_GET
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.connectivity.connectivitycontext.ConnectivityService
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service/:
    post:
      tags:
      - tapi-connectivity
      summary: TapiDataTapiCommonContextTapiConnectivityConnectivityContextConnectivityService_POST
      description: 'creates tapi.connectivity.connectivitycontext.ConnectivityService (note: operation unavailable on standby servers)'
      operationId: TapiDataTapiCommonContextTapiConnectivityConnectivityContextConnectivityService_POST
      parameters: []
      requestBody:
        description: tapi.connectivity.connectivitycontext.ConnectivityService to be added to list
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
              - description: tapi.connectivity.connectivitycontext.ConnectivityService to be added to list
        required: false
      responses:
        '201':
          description: Object created
          headers: {}
          content: {}
        '400':
          description: Internal error
          headers: {}
          content: {}
        '409':
          description: Object already exists
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - tapi-connectivity-core
      summary: TapiDataTapiCommonContextTapiConnectivityConnectivityContextConnectivityService_GET
      description: returns tapi.connectivity.connectivitycontext.ConnectivityService
      operationId: TapiDataTapiCommonContextTapiConnectivityConnectivityContextConnectivityService_GET
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.connectivity.connectivitycontext.ConnectivityService
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/connectivity-context/connectivity-service={uuid}:
    get:
      tags:
      - tapi-connectivity
      summary: UntitledEndpoint_GET2
      description: returns tapi.connectivity.connectivitycontext.ConnectivityService
      operationId: UntitledEndpoint_GET2
      parameters:
      - name: uuid
        in: path
        description: Id of connectivity-service
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.connectivity.connectivitycontext.ConnectivityService
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}:
    get:
      tags:
      - tapi-connectivity
      summary: UntitledEndpoint_GET3
      description: returns tapi.connectivity.connectivitycontext.ConnectivityService
      operationId: UntitledEndpoint_GET3
      parameters:
      - name: uuid
        in: path
        description: Id of connectivity-service
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.connectivity.connectivitycontext.ConnectivityService
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.connectivitycontext.ConnectivityService'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - tapi-connectivity
      summary: UntitledEndpoint_DELETE1
      description: 'removes tapi.connectivity.connectivitycontext.ConnectivityService (note: operation unavailable on standby servers)'
      operationId: UntitledEndpoint_DELETE1
      parameters:
      - name: uuid
        in: path
        description: Id of connectivity-service
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Object deleted
          headers: {}
          content: {}
        '400':
          description: Internal error
          headers: {}
          content: {}
        '404':
          description: Not found
          headers: {}
          content: {}
        '500':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/topology/mcp-base-topology/connection-end-point/:
    get:
      tags:
      - tapi-connectivity
      summary: TapiCoreContextTopologyMcpBaseTopologyConnectionEndPoint_GET
      description: returns deeppaging.connection-end-point.Response
      operationId: TapiCoreContextTopologyMcpBaseTopologyConnectionEndPoint_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.connection-end-point.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.connection-end-point.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/connection-end-point/:
    get:
      tags:
      - tapi-connectivity
      summary: ConnectionEndPoint_GET
      description: returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList
      operationId: ConnectionEndPoint_GET
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/connection-end-point={connection-end-point-uuid}:
    get:
      tags:
      - tapi-connectivity
      summary: GetUntitledEndpoint_GET
      description: returns tapi.connectivity.ceplist.ConnectionEndPoint
      operationId: GetUntitledEndpoint_GET
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: connection-end-point-uuid
        in: path
        description: Id of connection-end-point
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.connectivity.ceplist.ConnectionEndPoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.ceplist.ConnectionEndPoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.ceplist.ConnectionEndPoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connection/:
    get:
      tags:
      - tapi-connectivity-core
      summary: TapiDataTapiCommonContextTapiConnectivityConnectivityContextConnection_GET
      description: returns tapi.connectivity.Connection
      operationId: TapiDataTapiCommonContextTapiConnectivityConnectivityContextConnection_GET
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.connectivity.Connection
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.connectivity.Connection'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/oam-context/oam-job/:
    post:
      tags:
      - oam
      summary: TapiDataContextOamContextOamJob_POST
      description: creates tapi.oam.OamData
      operationId: TapiDataContextOamContextOamJob_POST
      parameters: []
      requestBody:
        description: tapi.oam.Oam
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/tapi.oam.Oam'
              - description: tapi.oam.Oam
        required: false
      responses:
        '201':
          description: Object created
          headers: {}
          content: {}
        '400':
          description: Internal error
          headers: {}
          content: {}
        '409':
          description: Object already exists
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/service-interface-point/:
    get:
      tags:
      - tapi-common
      summary: TapiCoreContextServiceInterfacePoint_GET
      description: returns deeppaging.service-interface-point.Response
      operationId: TapiCoreContextServiceInterfacePoint_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.service-interface-point.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.service-interface-point.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/service-interface-point/:
    get:
      tags:
      - tapi-common
      summary: TapiDataContextServiceInterfacePoint_GET
      description: returns tapi.common.context.ServiceInterfacePoint
      operationId: TapiDataContextServiceInterfacePoint_GET
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.common.context.ServiceInterfacePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/service-interface-point/:
    get:
      tags:
      - tapi-common
      summary: TapiDataTapiCommonContextServiceInterfacePoint_GET
      description: returns tapi.common.context.ServiceInterfacePoint
      operationId: TapiDataTapiCommonContextServiceInterfacePoint_GET
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.common.context.ServiceInterfacePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/service-interface-point={uuid}:
    get:
      tags:
      - tapi-common
      summary: GetUntitledEndpoint_GET1
      description: returns tapi.common.context.ServiceInterfacePoint
      operationId: GetUntitledEndpoint_GET1
      parameters:
      - name: uuid
        in: path
        description: Id of service-interface-point
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.common.context.ServiceInterfacePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/service-interface-point={uuid}:
    get:
      tags:
      - tapi-common
      summary: GetUntitledEndpoint_GET11
      description: returns tapi.common.context.ServiceInterfacePoint
      operationId: GetUntitledEndpoint_GET11
      parameters:
      - name: uuid
        in: path
        description: Id of service-interface-point
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.common.context.ServiceInterfacePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology/:
    get:
      tags:
      - tapi-topology
      summary: returnstapi.topology.topologycontext.Topology
      description: none
      operationId: returnstapi.topology.topologycontext.Topology
      parameters: []
      responses:
        '200':
          description: tapi.topology.TopologyInfo
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.TopologyInfo'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.TopologyInfo'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology/:
    get:
      tags:
      - tapi-topology
      summary: returnstapi.topology.topologycontext.Topology1
      description: none
      operationId: returnstapi.topology.topologycontext.Topology1
      parameters: []
      responses:
        '200':
          description: tapi.topology.TopologyInfo
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.TopologyInfo'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.TopologyInfo'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={uuid}:
    get:
      tags:
      - tapi-topology
      summary: Getreturnstapi.topology.topologycontext.Topology
      description: none
      operationId: Getreturnstapi.topology.topologycontext.Topology
      parameters:
      - name: uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.topologycontext.Topology
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topologycontext.TopologyWrapper'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topologycontext.TopologyWrapper'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology={uuid}:
    get:
      tags:
      - tapi-topology
      summary: Getreturnstapi.topology.topologycontext.Topology1
      description: none
      operationId: Getreturnstapi.topology.topologycontext.Topology1
      parameters:
      - name: uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.topologycontext.Topology
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topologycontext.TopologyWrapper'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topologycontext.TopologyWrapper'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/topology/mcp-base-topology/link/:
    get:
      tags:
      - tapi-topology
      summary: TapiCoreContextTopologyMcpBaseTopologyLink_GET
      description: returns deeppaging.link.Response
      operationId: TapiCoreContextTopologyMcpBaseTopologyLink_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.link.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.link.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/link/:
    get:
      tags:
      - tapi-topology
      summary: Link_GET
      description: returns tapi.topology.Link
      operationId: Link_GET
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.topology.Link
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology={topology-uuid}/link/:
    get:
      tags:
      - tapi-topology
      summary: Link_GET1
      description: returns tapi.topology.Link
      operationId: Link_GET1
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.topology.Link
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/link={link-uuid}:
    get:
      tags:
      - tapi-topology
      summary: GetUntitledEndpoint_GET2
      description: returns tapi.topology.Link
      operationId: GetUntitledEndpoint_GET2
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: link-uuid
        in: path
        description: Id of link
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.Link
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology={topology-uuid}/link={link-uuid}:
    get:
      tags:
      - tapi-topology
      summary: GetUntitledEndpoint_GET12
      description: returns tapi.topology.Link
      operationId: GetUntitledEndpoint_GET12
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: link-uuid
        in: path
        description: Id of link
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.Link
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.Link'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/topology/mcp-base-topology/node/:
    get:
      tags:
      - tapi-topology
      summary: TapiCoreContextTopologyMcpBaseTopologyNode_GET
      description: returns deeppaging.node.Response
      operationId: TapiCoreContextTopologyMcpBaseTopologyNode_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.node.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.node.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/node/:
    get:
      tags:
      - tapi-topology
      summary: Node_GET
      description: returns tapi.topology.topology.Node
      operationId: Node_GET
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.topology.topology.Node
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology={topology-uuid}/node/:
    get:
      tags:
      - tapi-topology
      summary: Node_GET1
      description: returns tapi.topology.topology.Node
      operationId: Node_GET1
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.topology.topology.Node
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/node={node-uuid}:
    get:
      tags:
      - tapi-topology
      summary: GetUntitledEndpoint_GET3
      description: returns tapi.topology.topology.Node
      operationId: GetUntitledEndpoint_GET3
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: node-uuid
        in: path
        description: Id of node
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.topology.Node
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology={topology-uuid}/node={node-uuid}:
    get:
      tags:
      - tapi-topology
      summary: GetUntitledEndpoint_GET13
      description: returns tapi.topology.topology.Node
      operationId: GetUntitledEndpoint_GET13
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: node-uuid
        in: path
        description: Id of node
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.topology.Node
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.topology.Node'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}:
    get:
      tags:
      - tapi-topology
      summary: OwnedNodeEdgePointOwnedNodeEdgePointUuid_GET
      description: returns tapi.topology.node.OwnedNodeEdgePoint
      operationId: OwnedNodeEdgePointOwnedNodeEdgePointUuid_GET
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: node-uuid
        in: path
        description: Id of node
        required: true
        style: simple
        schema:
          type: string
      - name: owned-node-edge-point-uuid
        in: path
        description: Id of owned-node-edge-point
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.node.OwnedNodeEdgePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/topology/mcp-base-topology/node-edge-point/:
    get:
      tags:
      - tapi-topology
      summary: TapiCoreContextTopologyMcpBaseTopologyNodeEdgePoint_GET
      description: returns deeppaging.node-edge-point.Response
      operationId: TapiCoreContextTopologyMcpBaseTopologyNodeEdgePoint_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.node-edge-point.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.node-edge-point.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/node-edge-point/:
    get:
      tags:
      - tapi-topology
      summary: NodeEdgePoint_GET
      description: returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList
      operationId: NodeEdgePoint_GET
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.topology.node.OwnedNodeEdgePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology={topology-uuid}/node-edge-point/:
    get:
      tags:
      - tapi-topology
      summary: NodeEdgePoint_GET1
      description: returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList
      operationId: NodeEdgePoint_GET1
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.topology.node.OwnedNodeEdgePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/topology-context/topology={topology-uuid}/node-edge-point={node-edge-point-uuid}:
    get:
      tags:
      - tapi-topology
      summary: GetUntitledEndpoint_GET4
      description: returns tapi.topology.node.OwnedNodeEdgePoint
      operationId: GetUntitledEndpoint_GET4
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: node-edge-point-uuid
        in: path
        description: Id of node-edge-point
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.node.OwnedNodeEdgePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-topology:topology-context/topology={topology-uuid}/node-edge-point={node-edge-point-uuid}:
    get:
      tags:
      - tapi-topology
      summary: GetUntitledEndpoint_GET14
      description: returns tapi.topology.node.OwnedNodeEdgePoint
      operationId: GetUntitledEndpoint_GET14
      parameters:
      - name: topology-uuid
        in: path
        description: Id of topology
        required: true
        style: simple
        schema:
          type: string
      - name: node-edge-point-uuid
        in: path
        description: Id of node-edge-point
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.topology.node.OwnedNodeEdgePoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/physical-context/device/:
    get:
      tags:
      - tapi-equipment
      summary: TapiCoreContextPhysicalContextDevice_GET
      description: returns deeppaging.device.Response
      operationId: TapiCoreContextPhysicalContextDevice_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.device.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.device.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/physical-span/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.PhysicalSpan
      description: References the physical span in an equipment
      operationId: returnstapi.equipment.PhysicalSpan
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.PhysicalSpan
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/physical-span/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.PhysicalSpan1
      description: References the physical span in an equipment
      operationId: returnstapi.equipment.PhysicalSpan1
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.PhysicalSpan
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/physical-span={uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.PhysicalSpan
      description: References the physical span in an equipment
      operationId: Getreturnstapi.equipment.PhysicalSpan
      parameters:
      - name: uuid
        in: path
        description: Id of physical span
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.PhysicalSpan
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/physical-span={uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.PhysicalSpan1
      description: References the physical span in an equipment
      operationId: Getreturnstapi.equipment.PhysicalSpan1
      parameters:
      - name: uuid
        in: path
        description: Id of physical span
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.PhysicalSpan
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.PhysicalSpan'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/device/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.Device
      description: none
      operationId: returnstapi.equipment.Device
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.Device
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/device/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.Device1
      description: none
      operationId: returnstapi.equipment.Device1
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.Device
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/device={uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.Device
      description: none
      operationId: Getreturnstapi.equipment.Device
      parameters:
      - name: uuid
        in: path
        description: Id of device
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.Device
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/device={uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.Device1
      description: none
      operationId: Getreturnstapi.equipment.Device1
      parameters:
      - name: uuid
        in: path
        description: Id of device
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.Device
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Device'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/physical-context/equipment/:
    get:
      tags:
      - tapi-equipment
      summary: TapiCoreContextPhysicalContextEquipment_GET
      description: returns deeppaging.equipment.Response
      operationId: TapiCoreContextPhysicalContextEquipment_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.equipment.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.equipment.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/equipment/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.Equipment
      description: none
      operationId: returnstapi.equipment.Equipment
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/equipment/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.Equipment1
      description: none
      operationId: returnstapi.equipment.Equipment1
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/equipment={equipment-uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.Equipment
      description: none
      operationId: Getreturnstapi.equipment.Equipment
      parameters:
      - name: equipment-uuid
        in: path
        description: Id of equipment
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/equipment={equipment-uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.Equipment1
      description: none
      operationId: Getreturnstapi.equipment.Equipment1
      parameters:
      - name: equipment-uuid
        in: path
        description: Id of equipment
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/device={uuid}/equipment={equipment-uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.Equipment2
      description: none
      operationId: Getreturnstapi.equipment.Equipment2
      parameters:
      - name: uuid
        in: path
        description: Id of device
        required: true
        style: simple
        schema:
          type: string
      - name: equipment-uuid
        in: path
        description: Id of equipment
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.Equipment
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Equipment'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/core/context/physical-context/equipmentholder/:
    get:
      tags:
      - tapi-equipment
      summary: TapiCoreContextPhysicalContextEquipmentholder_GET
      description: returns deeppaging.equipmentholder.Response
      operationId: TapiCoreContextPhysicalContextEquipmentholder_GET
      parameters:
      - name: token
        in: query
        description: (Optional) Token for the page to return
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: string
          default: '100'
      responses:
        '200':
          description: deeppaging.equipmentholder.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deeppaging.equipmentholder.Response'
        '400':
          description: Bad request in case of limit size exceeds max allowed
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/equipmentholder/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.Holder
      description: >-
        References the Holder in an Equipment that is available to take other Equipments.

                        For example:

                        - Slot in a sub-rack

                        - Slot in a Field Replaceable Unit that can take a small form-factor pluggable.
      operationId: returnstapi.equipment.Holder
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.Holder
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/equipmentholder/:
    get:
      tags:
      - tapi-equipment
      summary: returnstapi.equipment.Holder1
      description: >-
        References the Holder in an Equipment that is available to take other Equipments.

                        For example:

                        - Slot in a sub-rack

                        - Slot in a Field Replaceable Unit that can take a small form-factor pluggable.
      operationId: returnstapi.equipment.Holder1
      parameters:
      - name: page[number]
        in: query
        description: (Optional) The page to return
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: page[size]
        in: query
        description: (Optional) The size of a returned page
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: tapi.equipment.Holder
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/physical-context/equipmentholder={equipmentholder-uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.Holder
      description: >-
        References the Holder in an Equipment that is available to take other Equipments.

                        For example:

                        - Slot in a sub-rack

                        - Slot in a Field Replaceable Unit that can take a small form-factor pluggable.
      operationId: Getreturnstapi.equipment.Holder
      parameters:
      - name: equipmentholder-uuid
        in: path
        description: Id of contained-holder
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.Holder
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: true
  /tapi/data/tapi-common:context/tapi-equipment:physical-context/equipmentholder={equipmentholder-uuid}:
    get:
      tags:
      - tapi-equipment
      summary: Getreturnstapi.equipment.Holder1
      description: >-
        References the Holder in an Equipment that is available to take other Equipments.

                        For example:

                        - Slot in a sub-rack

                        - Slot in a Field Replaceable Unit that can take a small form-factor pluggable.
      operationId: Getreturnstapi.equipment.Holder1
      parameters:
      - name: equipmentholder-uuid
        in: path
        description: Id of contained-holder
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: tapi.equipment.Holder
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.equipment.Holder'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/stream-context/available-stream/:
    get:
      tags:
      - tapi-streaming
      summary: returnstapi.streaming.AvailableStream
      description: none
      operationId: returnstapi.streaming.AvailableStream
      parameters: []
      responses:
        '200':
          description: tapi.streaming.AvailableStream
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.streaming.AvailableStreamWrapper'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.streaming.AvailableStreamWrapper'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /tapi/data/context/stream-context/supported-stream-type/:
    get:
      tags:
      - tapi-streaming
      summary: returnstapi.streaming.streamcontext.SupportedStreamType
      description: none
      operationId: returnstapi.streaming.streamcontext.SupportedStreamType
      parameters: []
      responses:
        '200':
          description: tapi.streaming.streamcontext.SupportedStreamType
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.streaming.streamcontext.SupportedStreamTypeWrapper'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.streaming.streamcontext.SupportedStreamTypeWrapper'
        '400':
          description: Internal error
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ietf-restconf-monitoring:restconf-state/capabilities/:
    get:
      tags:
      - tapi-restconf
      summary: RestconfDataIetfRestconfMonitoringRestconfStateCapabilities_GET
      description: return tapi.restconf.capabilities.Response
      operationId: RestconfDataIetfRestconfMonitoringRestconfStateCapabilities_GET
      parameters: []
      responses:
        '200':
          description: tapi.restconf.capabilities.Response
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.restconf.capabilities.Response'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/tapi.restconf.capabilities.Response'
        '500':
          description: Internal Server Error
          headers: {}
          content: {}
      deprecated: false
  /sftp/api/v1/checkdisk:
    get:
      tags:
      - checkdisk
      summary: checkdisk
      description: checks if disk space is critical and responds
      operationId: checkdisk
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiskSize'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiskSize'
      deprecated: false
  /sftp/api/v1/checkkafka:
    get:
      tags:
      - checkkafka
      summary: checkkafka
      description: checks if kafka is up and responds
      operationId: checkkafka
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaUp'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaUp'
      deprecated: false
  /sftp/api/v1/checkpithos:
    get:
      tags:
      - checkpithos
      summary: checkpithos
      description: checks if pithos is up and responds
      operationId: checkpithos
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PithosUp'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PithosUp'
      deprecated: false
  /sftp/api/v1/cleanup:
    delete:
      tags:
      - cleanup
      summary: cleanup
      description: CleanUp the data directory used for sftp/sftp if size is more than the threshold size in MB
      operationId: cleanup
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad request
          headers: {}
          content: {}
      deprecated: false
  /sftp/debug/logs:
    get:
      tags:
      - debug
      summary: getLogLevel1
      description: Retrieves the currently active log level
      operationId: getLogLevel1
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: joy
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogLevel'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
    put:
      tags:
      - debug
      summary: changeLogLevel1
      description: Changes the log level
      operationId: changeLogLevel1
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogLevel'
        required: true
      responses:
        '200':
          description: The newly active log level
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogLevel'
        '400':
          description: Bad request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /submarine/api/v1/srs/commitCableSystem:
    post:
      tags:
      - Add to inventory / Remove from inventory cable system configuration
      summary: Commitcablesystemconfigurationforacustomer
      description: >
        Use this API to Add to inventory OR Remove from inventory cable system configuration


        Prerequisite: Customer specific SLTEs and TEMs servers are enrolled as mentioned in descriptor files.
      operationId: Commitcablesystemconfigurationforacustomer
      parameters: []
      requestBody:
        description: >-
          Add to inventory / Remove from inventory cable system for a customer
           1) Use operation_type as 'commit / cleanup' to apply cable descriptors changes on the network
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SubmarineApiV1SrsCommitCableSystemRequest'
              - description: >-
                  Add to inventory / Remove from inventory cable system for a customer
                   1) Use operation_type as 'commit / cleanup' to apply cable descriptors changes on the network
        required: true
      responses:
        '200':
          description: Cable system configuration is Added to inventory / Remove from inventory successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CableSystemUpdateConfirmationMessage'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/CableSystemUpdateConfirmationMessage'
        '400':
          description: Bad request. Invalid parameters
          headers: {}
          content: {}
        '500':
          description: Failed to Add to inventory / Remove from inventory cable system configuration, details error message are provided in logs and response.
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/api-keys:
    get:
      tags:
      - api-keys
      summary: api-keys_list
      description: List of all api-keys.
      operationId: api-keys_list
      parameters:
      - name: owner
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: keyId
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIKeyPairSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/APIKeyPairSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - api-keys
      summary: api-keys_create
      description: Create a new api-key.
      operationId: api-keys_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - owner
              type: object
              properties:
                owner:
                  type: string
                  description: User UUID
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIKeyPairSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/APIKeyPairSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/api-keys/{keyId}:
    get:
      tags:
      - api-keys
      summary: api-keys_read
      description: Get a specific api-key.
      operationId: api-keys_read
      parameters:
      - name: keyId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIKeyPairSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/APIKeyPairSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - api-keys
      summary: api-keys_delete
      description: Delete an api-key.
      operationId: api-keys_delete
      parameters:
      - name: keyId
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/applications:
    get:
      tags:
      - applications
      summary: applications_list
      description: List of all applications.
      operationId: applications_list
      parameters:
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: isInternal
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - applications
      summary: applications_create
      description: Create a new application entry.
      operationId: applications_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                username:
                  type: string
                  description: username for Application manager, <appname>Manager if not provided
                isInternal:
                  type: boolean
                  description: Is internal Application
                name:
                  type: string
                  description: Application name
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/applications/{uuid}:
    get:
      tags:
      - applications
      summary: applications_read
      description: Get a specific application by UUID.
      operationId: applications_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - applications
      summary: applications_update
      description: Replace the application with this UUID.
      operationId: applications_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                username:
                  type: string
                  description: username for Application manager, <appname>Manager if not provided
                isInternal:
                  type: boolean
                  description: Is internal Application
                name:
                  type: string
                  description: Application name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - applications
      summary: applications_partial_update
      description: Update some values for the application with this UUID.
      operationId: applications_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                username:
                  type: string
                  description: username for Application manager, <appname>Manager if not provided
                isInternal:
                  type: boolean
                  description: Is internal Application
                name:
                  type: string
                  description: Application name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApplicationSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - applications
      summary: applications_delete
      description: Delete an application.
      operationId: applications_delete
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/auth:
    post:
      tags:
      - auth
      summary: auth_create
      description: Create a new authentication.
      operationId: auth_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - authType
              type: object
              properties:
                authType:
                  type: string
                  description: Authentication Type, rest of the parameters depend on this
                username:
                  type: string
                  description: required for authType password
                password:
                  type: string
                  description: required for authType password
                tenant:
                  type: string
                  description: Tenant Name required for authType password
                token:
                  type: string
                  description: Required for authType token
                keyId:
                  type: string
                  description: Required for authType mac
                apps:
                  type: string
                  description: list of Application names, request roles for these Applications. If empty, user roles are not returned for any Application
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/AuthSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/current-user:
    get:
      tags:
      - current-user
      summary: current-user_list
      description: Detailed information about the current user.
      operationId: current-user_list
      parameters:
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/current-user/login_info:
    get:
      tags:
      - current-user
      summary: current-user_login_info
      description: Returns SessionId and Token Info including tenant_context for the current user.
      operationId: current-user_login_info
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUserLoginInfoSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/CurrentUserLoginInfoSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/health-check:
    get:
      tags:
      - health-check
      summary: health-check_list
      description: >-
        Health check

        Return 200 if things look good, or 503 if we can't talk to the DB.
      operationId: health-check_list
      parameters:
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/HealthCheckSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/ldap-configs:
    get:
      tags:
      - ldap-configs
      summary: ldap-configs_list
      description: List of all LDAP configurations.
      operationId: ldap-configs_list
      parameters:
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/ldap-configs/{uuid}:
    get:
      tags:
      - ldap-configs
      summary: ldap-configs_read
      description: Get a specific LDAP config by UUID.
      operationId: ldap-configs_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - ldap-configs
      summary: ldap-configs_update
      description: Replace the LDAP config with this UUID.
      operationId: ldap-configs_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              - group_object_filter
              type: object
              properties:
                description:
                  type: string
                  description: LDAP config description
                name:
                  type: string
                  description: LDAP config name
                enabled:
                  type: boolean
                  description: Activate this LDAP Configuration, if false, configuration exists in database but will not be used
                server_ip:
                  type: string
                  description: Server address
                enable_ssl:
                  type: boolean
                ssl_level:
                  type: string
                  description: SSL security level (NEVER, ALLOW, DEMAND)
                domain_search_user:
                  type: string
                  description: 'LDAP username to perform user lookups. Example: user@domain.com'
                domain_search_password:
                  type: string
                  description: Password for domain search user
                enable_referrals:
                  type: boolean
                  description: Microsoft AD needs this to be disabled. (Anonymous bind is not supported)
                base_dn:
                  type: string
                user_name_attribute:
                  type: string
                  description: Attribute to load user name
                tenant_attribute:
                  type: string
                  description: Tenant attribute to filter user
                accessible_tenants_attribute:
                  type: string
                  description: Attribute to define multiple tenant access for this user
                group_name_attribute:
                  type: string
                  description: Attribute to load group name
                group_object_filter:
                  type: string
                  description: Filter when searching group
                member_attr:
                  type: string
                  description: "'member_attr' used for 'group_object_filter', e.g. set 'memberUid' for '(objectClass=posixGroup)', 'member' for '(objectClass=groupOfNames)', 'uniqueMember' for '(objectClass=GroupOfUniqueNames)' when using OpenLDAP; 'member' for '(objectClass=group)' when using Microsoft AD."
                role_map:
                  type: string
                  description: Dictionary string that maps LDAP groups/roles to a list of tron roles
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - ldap-configs
      summary: ldap-configs_partial_update
      description: Update some values for the LDAP config with this UUID.
      operationId: ldap-configs_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: LDAP config description
                name:
                  type: string
                  description: LDAP config name
                enabled:
                  type: boolean
                  description: Activate this LDAP Configuration, if false, configuration exists in database but will not be used
                server_ip:
                  type: string
                  description: Server address
                enable_ssl:
                  type: boolean
                ssl_level:
                  type: string
                  description: SSL security level (NEVER, ALLOW, DEMAND)
                domain_search_user:
                  type: string
                  description: 'LDAP username to perform user lookups. Example: user@domain.com'
                domain_search_password:
                  type: string
                  description: Password for domain search user
                enable_referrals:
                  type: boolean
                  description: Microsoft AD needs this to be disabled. (Anonymous bind is not supported)
                base_dn:
                  type: string
                user_name_attribute:
                  type: string
                  description: Attribute to load user name
                tenant_attribute:
                  type: string
                  description: Tenant attribute to filter user
                accessible_tenants_attribute:
                  type: string
                  description: Attribute to define multiple tenant access for this user
                group_name_attribute:
                  type: string
                  description: Attribute to load group name
                group_object_filter:
                  type: string
                  description: Filter when searching group
                member_attr:
                  type: string
                  description: "'member_attr' used for 'group_object_filter', e.g. set 'memberUid' for '(objectClass=posixGroup)', 'member' for '(objectClass=groupOfNames)', 'uniqueMember' for '(objectClass=GroupOfUniqueNames)' when using OpenLDAP; 'member' for '(objectClass=group)' when using Microsoft AD."
                role_map:
                  type: string
                  description: Dictionary string that maps LDAP groups/roles to a list of tron roles
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LDAPConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/login-detail:
    get:
      tags:
      - login-detail
      summary: login-detail_list
      description: >-
        Lists the login details associated user's last sessions. For admins/sysadmins,

        it lists details for all the users in that tenant
      operationId: login-detail_list
      parameters:
      - name: user_uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_successful
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: user
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginDetailSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LoginDetailSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/login-info:
    get:
      tags:
      - login-info
      summary: login-info_list
      description: Login Info.
      operationId: login-info_list
      parameters:
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginInfoSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LoginInfoSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/login-message:
    get:
      tags:
      - login-message
      summary: login-message_list
      description: Get the one and only pre-login message.
      operationId: login-message_list
      parameters:
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/login-message/{uuid}:
    get:
      tags:
      - login-message
      summary: login-message_read
      description: Get the one and only pre-login message.
      operationId: login-message_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - login-message
      summary: login-message_update
      description: Replace the permission with this UUID.
      operationId: login-message_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - message
              type: object
              properties:
                message:
                  type: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - login-message
      summary: login-message_partial_update
      description: Update some values for the permission with this UUID.
      operationId: login-message_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                message:
                  type: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/LoginMessageSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/logout:
    post:
      tags:
      - logout
      summary: logout_create
      description: >-
        API endpoint for ui app users to logout.


        Expects authorization and csrftoken

        cookies, also X-CSRFToken header
      operationId: logout_create
      parameters: []
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/notification-config:
    get:
      tags:
      - notification-config
      summary: notification-config_list
      description: Get the Tron notification configuration.
      operationId: notification-config_list
      parameters:
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/notification-config/{uuid}:
    get:
      tags:
      - notification-config
      summary: notification-config_read
      description: Get the Tron notification configuration.
      operationId: notification-config_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - notification-config
      summary: notification-config_update
      description: Update the Tron notification configuration.
      operationId: notification-config_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether email support is enabled
                emailLinkServer:
                  type: string
                  description: Hostname/IP to use in links in email alerts (Reset password and first time account setup emails)
                resetLinkPath:
                  type: string
                  description: Path on server of reset password page - for example, uac/#/set-password for the uac-ui app.Don't change this field unless you really know what you're doing.
                confirmLinkPath:
                  type: string
                  description: Path on server of confirm email page - for example, uac/#/confirm-email for the uac-ui app.Don't change this field unless you really know what you're doing.
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - notification-config
      summary: notification-config_partial_update
      description: Update certain fields of the Tron notification configuration.
      operationId: notification-config_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether email support is enabled
                emailLinkServer:
                  type: string
                  description: Hostname/IP to use in links in email alerts (Reset password and first time account setup emails)
                resetLinkPath:
                  type: string
                  description: Path on server of reset password page - for example, uac/#/set-password for the uac-ui app.Don't change this field unless you really know what you're doing.
                confirmLinkPath:
                  type: string
                  description: Path on server of confirm email page - for example, uac/#/confirm-email for the uac-ui app.Don't change this field unless you really know what you're doing.
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/NotificationConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/oauth2/tokens:
    post:
      tags:
      - oauth2
      summary: oauth2_tokens_create
      description: Create an OAuth2 Token.
      operationId: oauth2_tokens_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - username
              - password
              - grant_type
              type: object
              properties:
                username:
                  type: string
                  description: Request token for user with username
                tenant:
                  type: string
                  description: Tenant name of user
                tenant_context:
                  type: string
                  description: Tenant name, request token for this tenant, applicable only if user can access multiple tenants
                password:
                  type: string
                  description: Password for user
                expires_in:
                  type: integer
                  description: Token expires in timeout seconds from created time
                  format: int32
                grant_type:
                  type: string
                  description: Accepted value is "password"
                inactive_expiration_time:
                  type: string
                is_successful:
                  type: string
                  description: Deprecated. Only successfull logins are stored.
                user_tenant_uuid:
                  type: string
                radius_state:
                  type: string
                  description: Represents the Access-Challenge State attribute
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuth2TokenSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OAuth2TokenSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/oauth2/tokens/{token}:
    delete:
      tags:
      - oauth2
      summary: oauth2_tokens_delete
      description: Delete an OAuth2 token.
      operationId: oauth2_tokens_delete
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/oauth2/tokens/{token}/change_tenant_context:
    post:
      tags:
      - oauth2
      summary: oauth2_tokens_change_tenant_context
      description: Change to the tenant context specified via tenant_context.
      operationId: oauth2_tokens_change_tenant_context
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - username
              - password
              - grant_type
              type: object
              properties:
                username:
                  type: string
                  description: Request token for user with username
                tenant:
                  type: string
                  description: Tenant name of user
                tenant_context:
                  type: string
                  description: Tenant name, request token for this tenant, applicable only if user can access multiple tenants
                password:
                  type: string
                  description: Password for user
                expires_in:
                  type: integer
                  description: Token expires in timeout seconds from created time
                  format: int32
                grant_type:
                  type: string
                  description: Accepted value is "password"
                inactive_expiration_time:
                  type: string
                is_successful:
                  type: string
                  description: Deprecated. Only successfull logins are stored.
                user_tenant_uuid:
                  type: string
                radius_state:
                  type: string
                  description: Represents the Access-Challenge State attribute
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuth2TokenSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OAuth2TokenSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/partitions:
    get:
      tags:
      - partitions
      summary: partitions_list
      description: List of all partitions.
      operationId: partitions_list
      parameters:
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_active
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: search
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - partitions
      summary: partitions_create
      description: Create a new partition.
      operationId: partitions_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                is_active:
                  type: boolean
                  description: Designates whether this partition should be treated as active.
                name:
                  type: string
                  description: Partition name
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/partitions/{uuid}:
    get:
      tags:
      - partitions
      summary: partitions_read
      description: Get a specific partition by UUID.
      operationId: partitions_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - partitions
      summary: partitions_update
      description: Replace the partition with this UUID.
      operationId: partitions_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                is_active:
                  type: boolean
                  description: Designates whether this partition should be treated as active.
                name:
                  type: string
                  description: Partition name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - partitions
      summary: partitions_partial_update
      description: Update some values for the partition with this UUID.
      operationId: partitions_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                is_active:
                  type: boolean
                  description: Designates whether this partition should be treated as active.
                name:
                  type: string
                  description: Partition name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PartitionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - partitions
      summary: partitions_delete
      description: Delete the partition with this UUID.
      operationId: partitions_delete
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/passwordpolicies:
    get:
      tags:
      - passwordpolicies
      summary: passwordpolicies_list
      description: List of all password policies.
      operationId: passwordpolicies_list
      parameters:
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: description
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: enable_lockout
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: history_size
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: allow_common_passwords
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: allow_dictionary_words
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: lockout_non_changed_days
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_change_days
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_digits
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_distance
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_lowercase
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_password_length
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_special_chars
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_strength
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: minimum_uppercase
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: password_change_days
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: require_periodic_change
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - passwordpolicies
      summary: passwordpolicies_create
      description: Create a new password policy.
      operationId: passwordpolicies_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                tenant:
                  type: string
                  description: Tenant UUID, if not provided "master" tenant is used
                description:
                  type: string
                  description: Password policy description
                password_expiration_warning_period:
                  type: integer
                  description: Number of days before the password expires to provide notifications.
                  format: int32
                email_password_expiration_weekly_notifications:
                  type: integer
                  description: Number of weeks before password expires to send emails. One email sent per week.
                  format: int32
                email_password_expiration_daily_notifications:
                  type: integer
                  description: Number of days before password expires to send emails. One email sent per day.
                  format: int32
                enable_lockout:
                  type: boolean
                failed_login_attempts:
                  type: integer
                  format: int32
                history_size:
                  type: integer
                  format: int32
                lockout_duration_minutes:
                  type: integer
                  format: int32
                lockout_non_changed_days:
                  type: integer
                  format: int32
                minimum_change_days:
                  type: integer
                  format: int32
                minimum_digits:
                  type: integer
                  format: int32
                minimum_lowercase:
                  type: integer
                  format: int32
                minimum_password_length:
                  type: integer
                  format: int32
                minimum_special_chars:
                  type: integer
                  format: int32
                minimum_uppercase:
                  type: integer
                  format: int32
                password_change_days:
                  type: integer
                  format: int32
                require_periodic_change:
                  type: boolean
                name:
                  type: string
                  description: Policy name
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/passwordpolicies/{uuid}:
    get:
      tags:
      - passwordpolicies
      summary: passwordpolicies_read
      description: Get a specific password policy by UUID.
      operationId: passwordpolicies_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - passwordpolicies
      summary: passwordpolicies_update
      description: Replace the password policy with this UUID.
      operationId: passwordpolicies_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                tenant:
                  type: string
                  description: Tenant UUID, if not provided "master" tenant is used
                description:
                  type: string
                  description: Password policy description
                password_expiration_warning_period:
                  type: integer
                  description: Number of days before the password expires to provide notifications.
                  format: int32
                email_password_expiration_weekly_notifications:
                  type: integer
                  description: Number of weeks before password expires to send emails. One email sent per week.
                  format: int32
                email_password_expiration_daily_notifications:
                  type: integer
                  description: Number of days before password expires to send emails. One email sent per day.
                  format: int32
                enable_lockout:
                  type: boolean
                failed_login_attempts:
                  type: integer
                  format: int32
                history_size:
                  type: integer
                  format: int32
                lockout_duration_minutes:
                  type: integer
                  format: int32
                lockout_non_changed_days:
                  type: integer
                  format: int32
                minimum_change_days:
                  type: integer
                  format: int32
                minimum_digits:
                  type: integer
                  format: int32
                minimum_lowercase:
                  type: integer
                  format: int32
                minimum_password_length:
                  type: integer
                  format: int32
                minimum_special_chars:
                  type: integer
                  format: int32
                minimum_uppercase:
                  type: integer
                  format: int32
                password_change_days:
                  type: integer
                  format: int32
                require_periodic_change:
                  type: boolean
                name:
                  type: string
                  description: Policy name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - passwordpolicies
      summary: passwordpolicies_partial_update
      description: Update some values for the password policy with this UUID.
      operationId: passwordpolicies_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                tenant:
                  type: string
                  description: Tenant UUID, if not provided "master" tenant is used
                description:
                  type: string
                  description: Password policy description
                password_expiration_warning_period:
                  type: integer
                  description: Number of days before the password expires to provide notifications.
                  format: int32
                email_password_expiration_weekly_notifications:
                  type: integer
                  description: Number of weeks before password expires to send emails. One email sent per week.
                  format: int32
                email_password_expiration_daily_notifications:
                  type: integer
                  description: Number of days before password expires to send emails. One email sent per day.
                  format: int32
                enable_lockout:
                  type: boolean
                failed_login_attempts:
                  type: integer
                  format: int32
                history_size:
                  type: integer
                  format: int32
                lockout_duration_minutes:
                  type: integer
                  format: int32
                lockout_non_changed_days:
                  type: integer
                  format: int32
                minimum_change_days:
                  type: integer
                  format: int32
                minimum_digits:
                  type: integer
                  format: int32
                minimum_lowercase:
                  type: integer
                  format: int32
                minimum_password_length:
                  type: integer
                  format: int32
                minimum_special_chars:
                  type: integer
                  format: int32
                minimum_uppercase:
                  type: integer
                  format: int32
                password_change_days:
                  type: integer
                  format: int32
                require_periodic_change:
                  type: boolean
                name:
                  type: string
                  description: Policy name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PasswordPolicySerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/permissions:
    get:
      tags:
      - permissions
      summary: permissions_list
      description: List of all permissions.
      operationId: permissions_list
      parameters:
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: isDefault
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: customerModifiable
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: category
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: category__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: category__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - permissions
      summary: permissions_create
      description: Create a new permission.
      operationId: permissions_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - displayName
              - operation
              - standby
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: Display name, same as name if not provided
                category:
                  type: string
                  description: Permission Category
                operation:
                  type: string
                  description: HTTP Operation like GET/POST
                description:
                  type: string
                  description: Permission Description
                standby:
                  type: boolean
                name:
                  type: string
                  description: Permission name
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/permissions/{uuid}:
    get:
      tags:
      - permissions
      summary: permissions_read
      description: Get a specific permission by UUID.
      operationId: permissions_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - permissions
      summary: permissions_update
      description: Defines permissions for the roles.
      operationId: permissions_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - displayName
              - operation
              - standby
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: Display name, same as name if not provided
                category:
                  type: string
                  description: Permission Category
                operation:
                  type: string
                  description: HTTP Operation like GET/POST
                description:
                  type: string
                  description: Permission Description
                standby:
                  type: boolean
                name:
                  type: string
                  description: Permission name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - permissions
      summary: permissions_partial_update
      description: Defines permissions for the roles.
      operationId: permissions_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: Display name, same as name if not provided
                category:
                  type: string
                  description: Permission Category
                operation:
                  type: string
                  description: HTTP Operation like GET/POST
                description:
                  type: string
                  description: Permission Description
                standby:
                  type: boolean
                name:
                  type: string
                  description: Permission name
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - permissions
      summary: permissions_delete
      description: Defines permissions for the roles.
      operationId: permissions_delete
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/permissions/{uuid}/add_resources:
    post:
      tags:
      - permissions
      summary: permissions_add_resources
      description: Defines permissions for the roles.
      operationId: permissions_add_resources
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - resources
              type: object
              properties:
                resources:
                  type: string
                  description: list of resource uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/permissions/{uuid}/remove_resources:
    post:
      tags:
      - permissions
      summary: permissions_remove_resources
      description: Defines permissions for the roles.
      operationId: permissions_remove_resources
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - resources
              type: object
              properties:
                resources:
                  type: string
                  description: list of resource uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/PermissionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/radius-configs:
    get:
      tags:
      - radius-configs
      summary: radius-configs_list
      description: List of all RADIUS configurations.
      operationId: radius-configs_list
      parameters:
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - radius-configs
      summary: radius-configs_create
      description: Stop user from creating more than two configurations per tenant.
      operationId: radius-configs_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - tenant
              - server_ip
              - name
              type: object
              properties:
                description:
                  type: string
                  description: RADIUS config description
                tenant:
                  type: string
                  description: Tenant name
                server_ip:
                  type: string
                retries:
                  type: integer
                  format: int32
                authport:
                  type: integer
                  format: int32
                name:
                  type: string
                  description: RADIUS config name
                enabled:
                  type: boolean
                  description: Activate this RADIUS configuration, if false, configuration exists in database but will not be used
                server_secret:
                  type: string
                  description: Server secret
                role_map:
                  type: string
                  description: Dictionary string that maps radius group/role to tron role
                authoritative_role_source:
                  type: boolean
                  description: True if your RADIUS keeps a list of users' roles
                timeout:
                  type: integer
                  description: Timeout in seconds for attempts to talk to the RADIUS server. Range is 1 to 60.
                  format: int32
                heartbeat_user:
                  type: string
                  description: Heartbeat user
                heartbeat_pwd:
                  type: string
                  description: Heartbeat password
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/radius-configs/{uuid}:
    get:
      tags:
      - radius-configs
      summary: radius-configs_read
      description: Get a specific RADIUS config by UUID.
      operationId: radius-configs_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - radius-configs
      summary: radius-configs_update
      description: Replace the RADIUS configuration with this UUID.
      operationId: radius-configs_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - tenant
              - server_ip
              - name
              type: object
              properties:
                description:
                  type: string
                  description: RADIUS config description
                tenant:
                  type: string
                  description: Tenant name
                server_ip:
                  type: string
                retries:
                  type: integer
                  format: int32
                authport:
                  type: integer
                  format: int32
                name:
                  type: string
                  description: RADIUS config name
                enabled:
                  type: boolean
                  description: Activate this RADIUS configuration, if false, configuration exists in database but will not be used
                server_secret:
                  type: string
                  description: Server secret
                role_map:
                  type: string
                  description: Dictionary string that maps radius group/role to tron role
                authoritative_role_source:
                  type: boolean
                  description: True if your RADIUS keeps a list of users' roles
                timeout:
                  type: integer
                  description: Timeout in seconds for attempts to talk to the RADIUS server. Range is 1 to 60.
                  format: int32
                heartbeat_user:
                  type: string
                  description: Heartbeat user
                heartbeat_pwd:
                  type: string
                  description: Heartbeat password
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - radius-configs
      summary: radius-configs_partial_update
      description: Update some values for the RADIUS config with this UUID.
      operationId: radius-configs_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: RADIUS config description
                tenant:
                  type: string
                  description: Tenant name
                server_ip:
                  type: string
                retries:
                  type: integer
                  format: int32
                authport:
                  type: integer
                  format: int32
                name:
                  type: string
                  description: RADIUS config name
                enabled:
                  type: boolean
                  description: Activate this RADIUS configuration, if false, configuration exists in database but will not be used
                server_secret:
                  type: string
                  description: Server secret
                role_map:
                  type: string
                  description: Dictionary string that maps radius group/role to tron role
                authoritative_role_source:
                  type: boolean
                  description: True if your RADIUS keeps a list of users' roles
                timeout:
                  type: integer
                  description: Timeout in seconds for attempts to talk to the RADIUS server. Range is 1 to 60.
                  format: int32
                heartbeat_user:
                  type: string
                  description: Heartbeat user
                heartbeat_pwd:
                  type: string
                  description: Heartbeat password
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RADIUSConfigSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/register:
    get:
      tags:
      - register
      summary: register_list
      description: List of all Pending registrations.
      operationId: register_list
      parameters:
      - name: search
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RegistrationSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - register
      summary: register_create
      description: Create a new user.
      operationId: register_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - first_name
              - last_name
              - email
              - password
              - username
              type: object
              properties:
                first_name:
                  type: string
                  description: user's first name
                last_name:
                  type: string
                  description: user's last name
                email:
                  type: string
                  description: user's email address
                tenant:
                  type: string
                  description: tenant UUID of user, if not provided "master" tenant is used
                password:
                  type: string
                  description: user's Password
                username:
                  type: string
                  description: User's username
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RegistrationSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/register/approve_users:
    post:
      tags:
      - register
      summary: register_approve_users
      description: Approve registrations for the requested registration uuids.
      operationId: register_approve_users
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - registrations
              type: object
              properties:
                registrations:
                  type: string
                  description: list of registration uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/register/confirm_email:
    post:
      tags:
      - register
      summary: register_confirm_email
      description: Endpoint to confirm a user's email.
      operationId: register_confirm_email
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - token
              type: object
              properties:
                token:
                  type: string
                  description: Token from the email
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/register/forgot_password:
    post:
      tags:
      - register
      summary: register_forgot_password
      description: Endpoint to send a confirmation email link for forgotten password.
      operationId: register_forgot_password
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - email
              type: object
              properties:
                email:
                  type: string
                  description: user's email address
                tenant:
                  type: string
                  description: tenant name
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/register/reject_users:
    post:
      tags:
      - register
      summary: register_reject_users
      description: Reject registrations for the requested registration uuids.
      operationId: register_reject_users
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - registrations
              type: object
              properties:
                registrations:
                  type: string
                  description: list of registration uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/register/resend_confirmation:
    post:
      tags:
      - register
      summary: register_resend_confirmation
      description: Endpoint to resend a confirmation email for registered users.
      operationId: register_resend_confirmation
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - email
              type: object
              properties:
                email:
                  type: string
                  description: user's email address
                tenant:
                  type: string
                  description: tenant name
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/register/set_password:
    post:
      tags:
      - register
      summary: register_set_password
      description: Endpoint to accept a password for forgotten password.
      operationId: register_set_password
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - token
              - password
              type: object
              properties:
                token:
                  type: string
                  description: token from the forgot password email
                password:
                  type: string
                  description: user's new password
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles:
    get:
      tags:
      - roles
      summary: roles_list
      description: List of all roles.
      operationId: roles_list
      parameters:
      - name: application__uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: application__name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: user
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: application
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: isInternal
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: customerModifiable
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: bypassDormancy
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: displayName__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - roles
      summary: roles_create
      description: Create a new role.
      operationId: roles_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - displayName
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                application:
                  type: string
                  description: Application uuid, if not provided default "BluePlanet" app is used
                reserved_sessions:
                  type: integer
                  description: The maximum number of concurrent sessions per role. (0=infinity)
                  format: int32
                name:
                  type: string
                  description: Role name
                all_partitions:
                  type: boolean
                  description: Ignore partitions field and enable all active available partitions
                parents:
                  type: array
                  items:
                    type: string
                  description: ''
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/total_reserved_sessions:
    get:
      tags:
      - roles
      summary: roles_total_reserved_sessions
      description: Return the total number of reserved sessions across all the Roles
      operationId: roles_total_reserved_sessions
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}:
    get:
      tags:
      - roles
      summary: roles_read
      description: Get a specific role by UUID.
      operationId: roles_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - roles
      summary: roles_update
      description: Replace the role with this UUID.
      operationId: roles_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - displayName
              - name
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                application:
                  type: string
                  description: Application uuid, if not provided default "BluePlanet" app is used
                reserved_sessions:
                  type: integer
                  description: The maximum number of concurrent sessions per role. (0=infinity)
                  format: int32
                name:
                  type: string
                  description: Role name
                all_partitions:
                  type: boolean
                  description: Ignore partitions field and enable all active available partitions
                parents:
                  type: array
                  items:
                    type: string
                  description: ''
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - roles
      summary: roles_partial_update
      description: Update some values for the role with this UUID.
      operationId: roles_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: display name, same as name if not provided
                description:
                  type: string
                  description: description
                application:
                  type: string
                  description: Application uuid, if not provided default "BluePlanet" app is used
                reserved_sessions:
                  type: integer
                  description: The maximum number of concurrent sessions per role. (0=infinity)
                  format: int32
                name:
                  type: string
                  description: Role name
                all_partitions:
                  type: boolean
                  description: Ignore partitions field and enable all active available partitions
                parents:
                  type: array
                  items:
                    type: string
                  description: ''
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - roles
      summary: roles_delete
      description: Defines roles of an application.
      operationId: roles_delete
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/add_parents:
    post:
      tags:
      - roles
      summary: roles_add_parents
      description: Add parents to this role.
      operationId: roles_add_parents
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - parents
              type: object
              properties:
                parents:
                  type: string
                  description: list of role uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/add_partitions:
    post:
      tags:
      - roles
      summary: roles_add_partitions
      description: Defines roles of an application.
      operationId: roles_add_partitions
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - partitions
              type: object
              properties:
                partitions:
                  type: string
                  description: list of partition uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/add_permissions:
    post:
      tags:
      - roles
      summary: roles_add_permissions
      description: Defines roles of an application.
      operationId: roles_add_permissions
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - permissions
              type: object
              properties:
                permissions:
                  type: string
                  description: list of permission uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/add_users:
    post:
      tags:
      - roles
      summary: roles_add_users
      description: Add users to this role.
      operationId: roles_add_users
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - users
              type: object
              properties:
                users:
                  type: string
                  description: list of user uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/remove_parents:
    post:
      tags:
      - roles
      summary: roles_remove_parents
      description: Remove parents from this role.
      operationId: roles_remove_parents
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - parents
              type: object
              properties:
                parents:
                  type: string
                  description: list of role uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/remove_partitions:
    post:
      tags:
      - roles
      summary: roles_remove_partitions
      description: Defines roles of an application.
      operationId: roles_remove_partitions
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - partitions
              type: object
              properties:
                partitions:
                  type: string
                  description: list of partition uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/remove_permissions:
    post:
      tags:
      - roles
      summary: roles_remove_permissions
      description: Defines roles of an application.
      operationId: roles_remove_permissions
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - permissions
              type: object
              properties:
                permissions:
                  type: string
                  description: list of permission uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/remove_users:
    post:
      tags:
      - roles
      summary: roles_remove_users
      description: Remove users from this role.
      operationId: roles_remove_users
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - users
              type: object
              properties:
                users:
                  type: string
                  description: list of user uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/roles/{uuid}/set_reserved_sessions:
    post:
      tags:
      - roles
      summary: roles_set_reserved_sessions
      description: Allow admin and sysadmin to change the role's reserved_sessions.
      operationId: roles_set_reserved_sessions
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - reserved_sessions
              type: object
              properties:
                reserved_sessions:
                  type: integer
                  description: The maximum number of concurrent sessions per role. (0=infinity)
                  format: int32
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/RoleSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/sessions:
    get:
      tags:
      - sessions
      summary: sessions_list
      description: List of all sessions.
      operationId: sessions_list
      parameters:
      - name: session_id
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: username
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ip_address
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: session_type
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: username__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: username__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ip_address__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ip_address__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: session_type__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: session_type__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: search
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/SessionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/sessions/{session_id}:
    get:
      tags:
      - sessions
      summary: sessions_read
      description: Get a specific session.
      operationId: sessions_read
      parameters:
      - name: session_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/SessionSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - sessions
      summary: sessions_delete
      description: Delete a session.
      operationId: sessions_delete
      parameters:
      - name: session_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/tokens:
    post:
      tags:
      - tokens
      summary: tokens_create
      description: Create a new base token.
      operationId: tokens_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - username
              - password
              type: object
              properties:
                username:
                  type: string
                  description: Request token for user with username
                tenant:
                  type: string
                  description: Tenant name of user
                tenant_context:
                  type: string
                  description: Tenant name, request token for this tenant, applicable only if user can access multiple tenants
                password:
                  type: string
                  description: Password for user
                inactive_expiration_time:
                  type: string
                is_successful:
                  type: string
                  description: Deprecated. Only successfull logins are stored.
                timeout:
                  type: integer
                  description: Seconds
                  format: int32
                user_tenant_uuid:
                  type: string
                radius_state:
                  type: string
                  description: Represents the Access-Challenge State attribute
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/TokenSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/tokens/{token}:
    delete:
      tags:
      - tokens
      summary: tokens_delete
      description: >-
        defines tokens of a user.

        used by token type of authentication against /auth api
      operationId: tokens_delete
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/tokens/{token}/change_tenant_context:
    post:
      tags:
      - tokens
      summary: tokens_change_tenant_context
      description: Change to the tenant context specified via tenant_context.
      operationId: tokens_change_tenant_context
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - tenant_context
              type: object
              properties:
                tenant_context:
                  type: string
                  description: Tenant name, request token for this tenant
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups:
    get:
      tags:
      - usergroups
      summary: usergroups_list
      description: List of all UserGroups.
      operationId: usergroups_list
      parameters:
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: user
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - usergroups
      summary: usergroups_create
      description: Create a new UserGroup.
      operationId: usergroups_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                description:
                  type: string
                  description: description
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions. (0=infinity)
                  format: int32
                name:
                  type: string
                  description: Group name
                parents:
                  type: array
                  items:
                    type: string
                  description: ''
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups/{uuid}:
    get:
      tags:
      - usergroups
      summary: usergroups_read
      description: Get a specific usergroup by UUID.
      operationId: usergroups_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - usergroups
      summary: usergroups_update
      description: Replace the UserGroup with this UUID.
      operationId: usergroups_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - name
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                description:
                  type: string
                  description: description
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions. (0=infinity)
                  format: int32
                name:
                  type: string
                  description: Group name
                parents:
                  type: array
                  items:
                    type: string
                  description: ''
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - usergroups
      summary: usergroups_partial_update
      description: Update some values for the UserGroup with this UUID.
      operationId: usergroups_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                description:
                  type: string
                  description: description
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions. (0=infinity)
                  format: int32
                name:
                  type: string
                  description: Group name
                parents:
                  type: array
                  items:
                    type: string
                  description: ''
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - usergroups
      summary: usergroups_delete
      description: >-
        Delete a UserGroup.


        Removing/Deleting a UserGroup removes the UserGroup and updates

        recursively the parent/children UserGroup reference to it. If UserGroup

        has users associated with it, the users usergroups will be updated and

        the deleted usergroup will be removed.
      operationId: usergroups_delete
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups/{uuid}/add_parents:
    post:
      tags:
      - usergroups
      summary: usergroups_add_parents
      description: Add parent groups to this usergroup.
      operationId: usergroups_add_parents
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - parents
              type: object
              properties:
                parents:
                  type: string
                  description: list of user group uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups/{uuid}/add_roles:
    post:
      tags:
      - usergroups
      summary: usergroups_add_roles
      description: Add roles to this usergroup.
      operationId: usergroups_add_roles
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - roles
              type: object
              properties:
                roles:
                  type: string
                  description: list of role uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups/{uuid}/add_users:
    post:
      tags:
      - usergroups
      summary: usergroups_add_users
      description: Add users to this usergroup.
      operationId: usergroups_add_users
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - users
              type: object
              properties:
                users:
                  type: string
                  description: list of user uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups/{uuid}/remove_parents:
    post:
      tags:
      - usergroups
      summary: usergroups_remove_parents
      description: Remove parent groups from this usergroup.
      operationId: usergroups_remove_parents
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - parents
              type: object
              properties:
                parents:
                  type: string
                  description: list of user group uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups/{uuid}/remove_roles:
    post:
      tags:
      - usergroups
      summary: usergroups_remove_roles
      description: Remove roles from this usergroup.
      operationId: usergroups_remove_roles
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - roles
              type: object
              properties:
                roles:
                  type: string
                  description: list of role uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/usergroups/{uuid}/remove_users:
    post:
      tags:
      - usergroups
      summary: usergroups_remove_users
      description: Remove users from this usergroup.
      operationId: usergroups_remove_users
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - users
              type: object
              properties:
                users:
                  type: string
                  description: list of user uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserGroupSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users:
    get:
      tags:
      - users
      summary: users_list
      description: >-
        List of users.


        Custom Filter current_logged_in can be used to get currently logged in users,

        GET api/v1/users?current_logged_in=True
      operationId: users_list
      parameters:
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: role
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: usergroup
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: tenant
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: current_logged_in
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: current_with_concurrent_session_count_greater
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_active
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_internal
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_locked
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_staff
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_dormant
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: is_expired
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: email
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: email__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: email__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: first_name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: first_name__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: first_name__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: last_name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: last_name__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: last_name__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: username
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: username__startswith
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: username__contains
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: search
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: ordering
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - users
      summary: users_create
      description: Create a new user.
      operationId: users_create
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - first_name
              - last_name
              - username
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                first_name:
                  type: string
                  description: user's first name
                last_name:
                  type: string
                  description: user's last name
                description:
                  type: string
                  description: user's description
                email:
                  type: string
                  description: user's email address
                tenant:
                  type: string
                  description: tenant UUID of user, if not provided "master" tenant is used
                accessible_tenants:
                  type: array
                  items:
                    type: string
                  description: ''
                roles:
                  type: array
                  items:
                    type: string
                  description: ''
                password:
                  type: string
                  description: user's password
                password_change_required:
                  type: boolean
                  description: Password change required
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions. (0=infinity)
                  format: int32
                is_verbose_logging:
                  type: boolean
                  description: User permission for generating audit logs
                username:
                  type: string
                  description: Required. 100 characters or fewer. Letters, numbers and @/./+/-/_ characters
                is_active:
                  type: boolean
                  description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
                is_locked:
                  type: boolean
                  description: Designates whether this user is locked from failed login attempts
                unlock_time:
                  type: string
                  description: Time when this user was locked.
                init_dormancy_time:
                  type: string
                is_internal:
                  type: boolean
                  description: Internal User
                directory:
                  type: string
                  description: Indicates which directory user is from, e.g. ldap
                last_login_detail_uuid:
                  type: string
                failed_login_attempts:
                  type: integer
                  description: Failed login attempts since last successful attempt
                  format: int32
                password_expiration_days:
                  type: integer
                  description: Number of days before an password for the account expires.
                  format: int32
        required: false
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}:
    get:
      tags:
      - users
      summary: users_read
      description: Get a specific user by UUID.
      operationId: users_read
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - users
      summary: users_update
      description: Replace the user with this UUID.
      operationId: users_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - first_name
              - last_name
              - username
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                first_name:
                  type: string
                  description: user's first name
                last_name:
                  type: string
                  description: user's last name
                description:
                  type: string
                  description: user's description
                email:
                  type: string
                  description: user's email address
                tenant:
                  type: string
                  description: tenant UUID of user, if not provided "master" tenant is used
                accessible_tenants:
                  type: array
                  items:
                    type: string
                  description: ''
                roles:
                  type: array
                  items:
                    type: string
                  description: ''
                password:
                  type: string
                  description: user's password
                password_change_required:
                  type: boolean
                  description: Password change required
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions. (0=infinity)
                  format: int32
                is_verbose_logging:
                  type: boolean
                  description: User permission for generating audit logs
                username:
                  type: string
                  description: Required. 100 characters or fewer. Letters, numbers and @/./+/-/_ characters
                is_active:
                  type: boolean
                  description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
                is_locked:
                  type: boolean
                  description: Designates whether this user is locked from failed login attempts
                unlock_time:
                  type: string
                  description: Time when this user was locked.
                init_dormancy_time:
                  type: string
                is_internal:
                  type: boolean
                  description: Internal User
                directory:
                  type: string
                  description: Indicates which directory user is from, e.g. ldap
                last_login_detail_uuid:
                  type: string
                failed_login_attempts:
                  type: integer
                  description: Failed login attempts since last successful attempt
                  format: int32
                password_expiration_days:
                  type: integer
                  description: Number of days before an password for the account expires.
                  format: int32
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - users
      summary: users_partial_update
      description: Update some values for the user with this UUID.
      operationId: users_partial_update
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                client_inactivity_time:
                  type: integer
                  description: timeout in seconds of inactivity
                  format: int32
                token_expiration_time:
                  type: integer
                  description: token expires in timeout seconds from created time
                  format: int32
                dormancy_days:
                  type: integer
                  description: number of days before an account can become dormant
                  format: int32
                first_name:
                  type: string
                  description: user's first name
                last_name:
                  type: string
                  description: user's last name
                description:
                  type: string
                  description: user's description
                email:
                  type: string
                  description: user's email address
                tenant:
                  type: string
                  description: tenant UUID of user, if not provided "master" tenant is used
                accessible_tenants:
                  type: array
                  items:
                    type: string
                  description: ''
                roles:
                  type: array
                  items:
                    type: string
                  description: ''
                password:
                  type: string
                  description: user's password
                password_change_required:
                  type: boolean
                  description: Password change required
                concurrent_session_max:
                  type: integer
                  description: The maximum number of concurrent sessions. (0=infinity)
                  format: int32
                is_verbose_logging:
                  type: boolean
                  description: User permission for generating audit logs
                username:
                  type: string
                  description: Required. 100 characters or fewer. Letters, numbers and @/./+/-/_ characters
                is_active:
                  type: boolean
                  description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
                is_locked:
                  type: boolean
                  description: Designates whether this user is locked from failed login attempts
                unlock_time:
                  type: string
                  description: Time when this user was locked.
                init_dormancy_time:
                  type: string
                is_internal:
                  type: boolean
                  description: Internal User
                directory:
                  type: string
                  description: Indicates which directory user is from, e.g. ldap
                last_login_detail_uuid:
                  type: string
                failed_login_attempts:
                  type: integer
                  description: Failed login attempts since last successful attempt
                  format: int32
                password_expiration_days:
                  type: integer
                  description: Number of days before an password for the account expires.
                  format: int32
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - users
      summary: users_delete
      description: Delete a user.
      operationId: users_delete
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/add_accessible_tenants:
    post:
      tags:
      - users
      summary: users_add_accessible_tenants
      description: Grant this user additional accessible tenants.
      operationId: users_add_accessible_tenants
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - accessible_tenants
              type: object
              properties:
                accessible_tenants:
                  type: string
                  description: list of tenant uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/add_roles:
    post:
      tags:
      - users
      summary: users_add_roles
      description: Grant this user additional roles.
      operationId: users_add_roles
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - roles
              type: object
              properties:
                roles:
                  type: string
                  description: list of role uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/add_usergroups:
    post:
      tags:
      - users
      summary: users_add_usergroups
      description: Add this user to a UserGroup.
      operationId: users_add_usergroups
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - usergroups
              type: object
              properties:
                usergroups:
                  type: string
                  description: list of group uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/context_accessible_tenants:
    get:
      tags:
      - users
      summary: users_context_accessible_tenants
      description: Return a list of all active subtenants of current tenant.
      operationId: users_context_accessible_tenants
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/TenantSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/remove_accessible_tenants:
    post:
      tags:
      - users
      summary: users_remove_accessible_tenants
      description: Remove accessible tenants from this user.
      operationId: users_remove_accessible_tenants
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - accessible_tenants
              type: object
              properties:
                accessible_tenants:
                  type: string
                  description: list of tenant uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/remove_roles:
    post:
      tags:
      - users
      summary: users_remove_roles
      description: Remove roles from this user.
      operationId: users_remove_roles
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - roles
              type: object
              properties:
                roles:
                  type: string
                  description: list of role uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/remove_usergroups:
    post:
      tags:
      - users
      summary: users_remove_usergroups
      description: Remove this user from a UserGroup.
      operationId: users_remove_usergroups
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - usergroups
              type: object
              properties:
                usergroups:
                  type: string
                  description: list of group uuids
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/reset_password:
    post:
      tags:
      - users
      summary: users_reset_password
      description: >-
        "Set the given users password (ADMIN).


        Does *NOT* require the current password
      operationId: users_reset_password
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - newPassword
              - newPasswordConfirm
              type: object
              properties:
                currentPassword:
                  type: string
                  description: Not required for reset_password,required for set_password if user's password is set at least once
                newPassword:
                  type: string
                  description: user's new password
                newPasswordConfirm:
                  type: string
                  description: Should match newPassword
                force:
                  type: boolean
                  description: Allow admin to skip password checks
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /tron/api/v1/users/{uuid}/set_password:
    post:
      tags:
      - users
      summary: users_set_password
      description: >-
        Set the given users password.


        Requires the current password
      operationId: users_set_password
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - newPassword
              - newPasswordConfirm
              type: object
              properties:
                currentPassword:
                  type: string
                  description: Not required for reset_password,required for set_password if user's password is set at least once
                newPassword:
                  type: string
                  description: user's new password
                newPasswordConfirm:
                  type: string
                  description: Should match newPassword
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/BaseResponseSerializer'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: Authentication credentials were not provided
          headers: {}
          content: {}
        '403':
          description: Forbidden
          headers: {}
          content: {}
        '404':
          description: Not Found
          headers: {}
          content: {}
      deprecated: false
  /viability/api/v1/Cache/Recompute:
    post:
      tags:
      - Cache
      summary: Recomputestheviabilitycache
      description: Recomputes the viability cache
      operationId: Recomputestheviabilitycache
      parameters:
      - name: deleteOnly
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content: {}
      deprecated: false
  /viability/api/v1/ViableRoutes/ViabilityData:
    post:
      tags:
      - ViableRoutes
      summary: InsertstheVPinforeceivedfromoneplannerintothedatabase.
      description: Inserts the VP info received from oneplanner into the database.
      operationId: InsertstheVPinforeceivedfromoneplannerintothedatabase.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/VerificationPathList'
        required: false
      responses:
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    get:
      tags:
      - ViableRoutes
      summary: GetstheVPinfofromthedatabase.
      description: >-
        If no freIds are given in the request, then all the verification paths are returned from the database.

        If the freids are given in the request, then those verification paths are returned which contain the freIds given in the request.
      operationId: GetstheVPinfofromthedatabase.
      parameters:
      - name: freIds
        in: query
        description: (Optional) List of comma-separated freIds
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationPathList'
        '500':
          description: Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    put:
      tags:
      - ViableRoutes
      summary: InsertsorupdatestheVPinforeceivedfromtheuserintothedatabase.
      description: Inserts or updates the VP info received from the user into the database.
      operationId: InsertsorupdatestheVPinforeceivedfromtheuserintothedatabase.
      parameters: []
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/VerificationPathDetail'
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /viability/api/v1/ViableRoutes/ViabilityData/file:
    post:
      tags:
      - ViableRoutes
      summary: InsertstheVerificationPathsreceivedfromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      description: >-
        All existing Verification Paths in the database are removed prior to inserting the provided set.





        NOTE: This API uploads data from a file and does not display or work correctly in MCP REST API Documentation.

        Please use an API testing tool that supports form-data file upload to use this API.
      operationId: InsertstheVerificationPathsreceivedfromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          enum:
          - application/x-www-form-urlencoded
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                ContentType:
                  type: string
                ContentDisposition:
                  type: string
                Headers:
                  type: string
                Length:
                  type: integer
                  format: int64
                Name:
                  type: string
                FileName:
                  type: string
        required: false
      responses:
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
    get:
      tags:
      - ViableRoutes
      summary: GetstheVPinfofromthedatabaseasacompressedfile,eitherziporgzipformat
      description: >-
        If no freIds are given in the request, then all the verification paths are returned from the database.

        If the freids are given in the request, then those verification paths are returned which contain the freIds given in the request.
      operationId: GetstheVPinfofromthedatabaseasacompressedfile,eitherziporgzipformat
      parameters:
      - name: freIds
        in: query
        description: (Optional) List of comma-separated freIds
        style: form
        explode: true
        schema:
          type: string
      - name: fileType
        in: query
        description: File type, allowed values are gzip or zip. If not set then this will return zip file
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /viability/api/v2/ViableRoutes/ViabilityData/file:
    post:
      tags:
      - ViableRoutesV2
      summary: PostInsertstheVerificationPathsreceivedfromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      description: "Verification Paths in the database that overlap any portion of the provided set are removed prior to inserting the provided set.\r\nVerification Paths that do not overlap any portion of the provided set are left in the database. \r\n\r\n\r\nNOTE: This API uploads data from a file and does not display or work correctly in MCP REST API Documentation.\r\nPlease use an API testing tool that supports form-data file upload to use this API."
      operationId: PostInsertstheVerificationPathsreceivedfromagzip(.gz),zip(.zip),JSON(.json)orOnePlanner(.onep)file.
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          enum:
          - application/x-www-form-urlencoded
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                ContentType:
                  type: string
                ContentDisposition:
                  type: string
                Headers:
                  type: string
                Length:
                  type: integer
                  format: int64
                Name:
                  type: string
                FileName:
                  type: string
        required: false
      responses:
        '500':
          description: Server Error
          headers: {}
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            text/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
  /watcher/api/v1/config:
    get:
      tags:
      - Admin
      summary: readConfig
      description: This return current AppConfig .
      operationId: readConfig
      parameters: []
      responses:
        '200':
          description: AppConfig
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfig'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/AppConfig'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
    put:
      tags:
      - Admin
      summary: updateConfig
      description: Will update AppConfig.
      operationId: updateConfig
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseAppConfig'
        required: false
      responses:
        '200':
          description: AppConfig
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfig'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/AppConfig'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/import/onecontrol:
    post:
      tags:
      - Admin
      summary: importOneC
      description: Import watchers.
      operationId: importOneC
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneCImporter'
        required: false
      responses:
        '200':
          description: OneCImporterResult
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneCImporterResult'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/OneCImporterResult'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/logs:
    get:
      tags:
      - Admin
      summary: readLogs
      description: Return the current logging level
      operationId: readLogs
      parameters: []
      responses:
        '200':
          description: Return current log level
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logging'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Logging'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
    put:
      tags:
      - Admin
      summary: changeLogs
      description: Will update logging configuration
      operationId: changeLogs
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Logging'
        required: false
      responses:
        '204':
          description: Delete204
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Delete204'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Delete204'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/meters/{uuid}:
    get:
      tags:
      - Admin
      summary: findMeters
      description: Retrieve available meters for a particular resource from heroic
      operationId: findMeters
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: force
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: RsAttr
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RsAttr'
                description: ''
            application/yang-data+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RsAttr'
                description: ''
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/resource-attrs:
    get:
      tags:
      - Admin
      summary: getResourceAttrs
      description: Retrieve all possible attributes of a resource.
      operationId: getResourceAttrs
      parameters:
      - name: uuid
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: RsAttr
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RsAttr'
                description: ''
            application/yang-data+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RsAttr'
                description: ''
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/sounds:
    get:
      tags:
      - Admin
      summary: soundFilenames
      description: List all available sound files.
      operationId: soundFilenames
      parameters: []
      responses:
        '200':
          description: SoundPath
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SoundPath'
                description: ''
            application/yang-data+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SoundPath'
                description: ''
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/sounds/{filename}:
    get:
      tags:
      - Admin
      summary: readSound
      description: List all available sound files.
      operationId: readSound
      parameters:
      - name: filename
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Empty
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/watchers:
    get:
      tags:
      - Watchers
      summary: readWatchers
      description: This will read and return watchers from DB.
      operationId: readWatchers
      parameters:
      - name: searchText
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: paging
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: facets
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Watcher
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Watcher'
                description: ''
            application/yang-data+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Watcher'
                description: ''
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
    post:
      tags:
      - Watchers
      summary: createWatcher
      description: This will create a new Watcher.
      operationId: createWatcher
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatcherCreate'
        required: false
      responses:
        '201':
          description: Watcher
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watcher'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Watcher'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/watchers/{uuid}:
    delete:
      tags:
      - Watchers
      summary: deleteWatcher
      description: Delete Watcher.
      operationId: deleteWatcher
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Delete204
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Delete204'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Delete204'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
    get:
      tags:
      - Watchers
      summary: readWatcher
      description: Retrieve single Watcher.
      operationId: readWatcher
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Watcher
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watcher'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Watcher'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
    put:
      tags:
      - Watchers
      summary: updateWatcher
      description: This will update  Watcher.
      operationId: updateWatcher
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatcherUpdate'
        required: false
      responses:
        '200':
          description: WatcherCreate
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatcherCreate'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/WatcherCreate'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /watcher/api/v1/watchers/{uuid}/triggers:
    get:
      tags:
      - Watchers
      summary: readWatcherTriggers
      description: Retrieve Retrieve IDs of items which triggered the Watcher.
      operationId: readWatcherTriggers
      parameters:
      - name: uuid
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Watcher
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watcher'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/Watcher'
        '500':
          description: InternalServerError
          headers: {}
          content:
            application/json:
              schema:
                type: object
            application/yang-data+json:
              schema:
                type: object
      deprecated: false
  /rbac-e/api/v1/admin/current-user:
    get:
      summary: getCurrentUser
      description: Retrieve current flattened user info
      operationId: getCurrentUser
      parameters: []
      responses:
        '200':
          description: Current user found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlattenUserAccount'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/FlattenUserAccount'
        '204':
          description: Current user not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /rbac-e/api/v1/admin/current-account:
    get:
      summary: getCurrentSessionData
      description: Retrieve current account info
      operationId: getCurrentSessionData
      parameters: []
      responses:
        '200':
          description: Account found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAccount'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/UserAccount'
        '204':
          description: Account not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: true
  /rbac-e/api/v1/admin/current-permissions:
    get:
      summary: getCurrentPermissions
      description: >-
        Returns list of permissions and partitions available to the

        authenticated user (from the Authorization header bearer token) given

        the current GeoRed active/standby state of the site.  If any of the

        user's roles give the user access to "all partitions" then this is

        indicated and the partition list will be empty.
      operationId: getCurrentPermissions
      parameters: []
      responses:
        '200':
          description: Account found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentPermissions'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/CurrentPermissions'
        '204':
          description: Account not found
          headers: {}
          content: {}
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /rbac-e/api/v1/admin/resources:
    get:
      summary: GetgetResources
      description: >-
        On startup, this service caches all the available resources in the

        solution, and associates them with the role they are associated with.
      operationId: GetgetResources
      parameters: []
      responses:
        '200':
          description: Resources found
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Resource'
                description: ''
            application/yang-data+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Resource'
                description: ''
        '204':
          description: No resources are cached on this API-GW
          headers: {}
          content: {}
      deprecated: false
  /rbac-e/api/v1/admin/sessions:
    get:
      summary: getSessions
      description: Retrieve all sessions currently in the cache
      operationId: getSessions
      parameters: []
      responses:
        '200':
          description: Sessions found
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RbacSession'
                description: ''
            application/yang-data+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RbacSession'
                description: ''
        '204':
          description: No sessions were available
          headers: {}
          content: {}
      deprecated: false
  /rbac-e/api/v1/admin/usercache:
    delete:
      summary: clearUserCache
      description: >-
        This forces api-gw to retrieve user information from the UAC service

        for every subsequent request received.
      operationId: clearUserCache
      parameters: []
      responses:
        '200':
          description: The cache was properly cleared
          headers: {}
          content: {}
      deprecated: false
  /rbac-e/api/v1/audit/configuration:
    post:
      summary: configureAudit
      description: Configure the audit feature
      operationId: configureAudit
      parameters:
      - name: enable
        in: query
        description: >-
          Enable/Disable the addition of the HTTP body in the Audit Logs for every API

          request and response entering and leaving the system.
        required: true
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '201':
          description: Accepted the request and changed the state
          headers: {}
          content: {}
      deprecated: false
  /rbac-e/api/v1/rest/permission:
    post:
      summary: validateRestResource
      description: >-
        For the resource and token specified in the body, checks whether the

        token is allowed to use the resource.
      operationId: validateRestResource
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestPermissionData'
        required: true
      responses:
        '200':
          description: ''
          headers:
            headers:
              description: in:headers
              content:
                text/plain:
                  schema:
                    type: string
                    description: in:headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrantedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/GrantedRbacResponse'
        '401':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/DeniedRbacResponse'
        '500':
          description: Unexpected processing error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /pm/api/v1/changeftpcredentials:
    post:
      summary: ChangeSFTPcredentialsfor6500PMfiletransfer
      description: Change SFTP credentials for 6500 PM file transfer
      operationId: ChangeSFTPcredentialsfor6500PMfiletransfer
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type37'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Bad request
          headers: {}
          content: {}
      deprecated: false
components:
  schemas:
    ActiveAlarms:
      title: ActiveAlarms
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ActiveAlarmsData'
          description: ''
        meta:
          $ref: '#/components/schemas/FilteredAlarmsMeta'
        links:
          $ref: '#/components/schemas/FilteredAlarmsLinks'
    ActiveAlarmsAttributes:
      title: ActiveAlarmsAttributes
      type: object
      properties:
        id:
          type: string
          description: The alarm id
        node-id:
          type: string
          description: The unique ID associated with the node/device provided by the RA
        node-type:
          type: string
          description: The type of node/device, e.g. 6500
        resource:
          type: string
          description: The location and equipment type
        native-condition-type:
          type: string
          description: The native condition or alarm name
        condition-severity:
          $ref: '#/components/schemas/ConditionSeverity'
        service-affecting:
          $ref: '#/components/schemas/ServiceAffecting'
        manual-clearable:
          type: boolean
          description: Whether or not the alarm can be cleared manually
          default: false
        additional-text:
          type: string
          description: Additional information about the alarm
        annotation:
          type: string
          description: Annotation information about the alarm
        first-raise-time:
          type: string
          description: The date and time that the alarm was first raised
          format: date-time
        last-raise-time:
          type: string
          description: The date and time that the alarm was last raised
          format: date-time
        acknowledge-update-time:
          type: string
          description: The date and time that the alarms acknowledge state last changed
          format: date-time
        acknowledge-update-user:
          type: string
          description: The user that last updated the acknowledge state the alarm
        number-of-occurrences:
          type: integer
          description: The number of times the alarm has occurred
          format: int64
        acknowledge-state:
          $ref: '#/components/schemas/AcknowledgeState'
        device-name:
          type: string
          description: Device's name.
        ip-address:
          type: string
          description: Device's IP address.
        mac-address:
          type: string
          description: Device's Mac address.
        device-attributes:
          type: object
    ActiveAlarmsData:
      title: ActiveAlarmsData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the alarm
        type:
          $ref: '#/components/schemas/Type'
        attributes:
          $ref: '#/components/schemas/ActiveAlarmsAttributes'
    AdditionalText:
      title: AdditionalText
      type: object
      properties:
        value:
          type: string
        count:
          type: integer
          format: int64
    AdditionalTextsAggregation:
      title: AdditionalTextsAggregation
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AdditionalTextsAggregationData'
    AdditionalTextsAggregationAttributes:
      title: AdditionalTextsAggregationAttributes
      type: object
      properties:
        additionalTexts:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalText'
          description: ''
    AdditionalTextsAggregationData:
      title: AdditionalTextsAggregationData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type1'
        attributes:
          $ref: '#/components/schemas/AdditionalTextsAggregationAttributes'
    AlarmQueryList:
      title: AlarmQueryList
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: ''
    Annotation:
      title: Annotation
      type: object
      properties:
        annotation:
          type: string
    DeviceAttributesAttributesRO:
      title: DeviceAttributesAttributesRO
      type: object
      properties:
        id:
          type: string
          description: The device session ID
        deviceId:
          type: string
          description: The device ID
        deviceName:
          type: string
          description: Device primary identifier. Will be shown below the alarm name
        deviceLongName:
          type: string
          description: Device long identifier.
        deviceLocation:
          type: string
          description: Geo hash location of the device.
        ipAddress:
          type: string
          description: Device secondary identifier. Will be shown below the primary identifier in the expanded view.
        macAddress:
          type: string
          description: Device tertiary identifier. Will be shown below the secondary identifier in the expanded view.
        partition:
          type: array
          items:
            type: string
          description: The partitions that the device belongs to.
        tags:
          type: array
          items:
            type: string
          description: The device tags that the device has.
    DeviceAttributesDataRO:
      title: DeviceAttributesDataRO
      type: object
      properties:
        id:
          type: string
          description: Unique device ID matching that provided from the device resource adapter in the alarm record
        type:
          $ref: '#/components/schemas/Type2'
        attributes:
          $ref: '#/components/schemas/DeviceAttributesAttributesRO'
    DeviceAttributesRO:
      title: DeviceAttributesRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DeviceAttributesDataRO'
    DeviceNamesAggregation:
      title: DeviceNamesAggregation
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DeviceNamesAggregationData'
    DeviceNamesAggregationAttributes:
      title: DeviceNamesAggregationAttributes
      type: object
      properties:
        deviceNames:
          type: array
          items:
            type: object
          description: ''
    DeviceNamesAggregationData:
      title: DeviceNamesAggregationData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type3'
        attributes:
          $ref: '#/components/schemas/DeviceNamesAggregationAttributes'
    DeviceTypesRO:
      title: DeviceTypesRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceObjectDeviceType'
          description: ''
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        included:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ResourceObjectObject'
          description: ''
    Error:
      title: Error
      type: object
      properties:
        code:
          type: string
        title:
          type: string
        detail:
          type: string
        source:
          $ref: '#/components/schemas/ErrorSource'
    Errors:
      title: Errors
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: ''
    Filter:
      title: Filter
      type: object
      properties:
        op:
          allOf:
          - $ref: '#/components/schemas/Op'
          - {}
          readOnly: true
        key:
          type: string
          readOnly: true
        value:
          type: array
          items:
            type: string
          description: ''
          readOnly: true
    FilterAttributes:
      title: FilterAttributes
      type: object
      properties:
        channel:
          type: string
          description: The channel on which to subscribe for notifications. E.g. via Kafka Comet
        latestOffset:
          type: integer
          description: The latest message offset for the associated channel. If the offset cannot be retrieved it will be set to -9999, in that case please use the latest offset
          format: int64
        nodeType:
          type: array
          items:
            type: string
          description: The type of node/device, e.g. CN6500, case insensitive exact match only
        resource:
          type: array
          items:
            type: string
          description: Regular expression for the location and equipment type. E.g. 40GMUX.* for all 40GMUX on any shelf and slot
        nativeConditionType:
          type: array
          items:
            type: string
          description: The native condition or alarm name, case insensitive exact match only
        nativeConditionTypeExclusion:
          type: array
          items:
            type: string
          description: The native condition or alarm name for exclusion, case insensitive substring match supported
        severity:
          type: array
          items:
            type: string
          description: 'The severity of the alarm, case insensitive exact match only. Allowable values: indeterminate, critical, major, minor, warning, config, info'
        serviceAffecting:
          type: array
          items:
            type: string
          description: 'The service impact of the alarm, case insensitive exact match only. Allowable values: service_affecting, non_service_affecting, unknown'
        additionalText:
          type: array
          items:
            type: string
          description: Additional information about the alarm, case insensitive substring match supported
        additionalTextExclusion:
          type: array
          items:
            type: string
          description: Additional information about the alarm for exclusion, case insensitive substring match supported
        raiseTimeHour:
          type: array
          items:
            type: string
          description: A GMT 24-hour range to allow notifications to pass through. E.g. 09-17 will pass all alarms with raise times between 9:00.000 AM and 4:59.999 PM GMT
        maxOccurrences:
          type: integer
          description: Pass through alarms with less than or equal to this number of occurrences. E.g. 100 would filter out any alarms with 101 or more occurrences
          format: int64
        deviceName:
          type: array
          items:
            type: string
          description: A device's name, case insensitive exact match only
        deviceNameExclusion:
          type: array
          items:
            type: string
          description: A device's name for exclusion, case insensitive substring match supported
        ipAddress:
          type: array
          items:
            type: string
          description: A device's IP address, exact match only
        ipAddressExclusion:
          type: array
          items:
            type: string
          description: A device's IP address for exclusion, exact match only
        partition:
          type: array
          items:
            type: string
          description: The partitions of the user who creates the filter
    FilterData:
      title: FilterData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the alarm filter
        type:
          $ref: '#/components/schemas/Type4'
        attributes:
          $ref: '#/components/schemas/FilterAttributes'
    FilteredAlarm:
      title: FilteredAlarm
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AlarmData'
    FilteredAlarms:
      title: FilteredAlarms
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FilteredAlarmsData'
          description: ''
        meta:
          $ref: '#/components/schemas/FilteredAlarmsMeta'
        links:
          $ref: '#/components/schemas/FilteredAlarmsLinks'
    FilteredAlarmsAttributes:
      title: FilteredAlarmsAttributes
      type: object
      properties:
        id:
          type: string
          description: The alarm id
        alarm-id:
          type: string
          description: The original alarm id of the historical alarm
        node-id:
          type: string
          description: The unique ID associated with the node/device provided by the RA
        ra-alarm-id:
          type: string
          description: The RA Alarm identifier
        node-type:
          type: string
          description: The type of node/device, e.g. 6500
        state:
          $ref: '#/components/schemas/State'
        resource:
          type: string
          description: The location and equipment type
        resource-id:
          type: string
          description: The a unique id of the resource sending the alarm
        native-condition-type:
          type: string
          description: The native condition type of alarm
        native-condition-type-qualifier:
          type: string
          description: The native condition type qualifier of alarm
        condition-severity:
          $ref: '#/components/schemas/ConditionSeverity'
        service-affecting:
          $ref: '#/components/schemas/ServiceAffecting'
        native-state:
          type: string
          description: The native state
        native-name:
          type: string
          description: The native name
        native-description:
          type: string
          description: The native description
        manual-clearable:
          type: boolean
          description: Whether or not the alarm can be cleared manually
          default: false
        additional-text:
          type: string
          description: Additional information about the alarm
        annotation:
          type: string
          description: Annotation information about the alarm
        first-raise-time:
          type: string
          description: The date and time that the alarm was first raised
          format: date-time
        last-raise-time:
          type: string
          description: The date and time that the alarm was last raised
          format: date-time
        clear-time:
          type: string
          description: The date and time that the alarm was cleared
          format: date-time
        supersede-time:
          type: string
          description: The date and time that the alarm was superseded
          format: date-time
        acknowledge-update-time:
          type: string
          description: The date and time that the alarms acknowledge state last changed
          format: date-time
        clear-user:
          type: string
          description: The user that cleared the alarm
        acknowledge-update-user:
          type: string
          description: The user that last updated the acknowledge state the alarm
        number-of-occurrences:
          type: integer
          description: The number of times the alarm has occurred
          format: int64
        acknowledge-state:
          $ref: '#/components/schemas/AcknowledgeState'
        device-id:
          type: string
          description: Device's id.
        device-name:
          type: string
          description: Device's name.
        device-long-name:
          type: string
          description: Device's long name.
        ip-address:
          type: string
          description: Device's IP address.
        mac-address:
          type: string
          description: Device's Mac address.
        subnet-name:
          type: string
          description: Device's subnet name.
        card-type:
          type: string
          description: Card type.
        clfi:
          type: string
          description: Common language facility identifier.
        fic:
          type: string
          description: Frame identification code.
        partition:
          type: array
          items:
            type: string
          description: The partitions that the device belongs to.
        device-tags:
          type: array
          items:
            type: string
          description: A list of tags for a given device.
        device-attributes:
          type: object
        additional-attrs:
          type: object
        affected-inventory-ids:
          type: array
          items:
            type: string
          description: Inventory IDs affected by alarms
        sequence-id:
          type: string
          description: The alarm's sequence ID, the last-raise-time of that alarm instance in long.
        request-id:
          type: string
          description: The alarm's sequence ID, the last-raise-time of that alarm instance in long.
        is-event:
          type: boolean
          description: If alarm is an event
          default: false
        is-clearable:
          type: boolean
          description: If alarm is clearable by device
          default: false
    FilteredAlarmsData:
      title: FilteredAlarmsData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the alarm
        type:
          $ref: '#/components/schemas/Type5'
        attributes:
          $ref: '#/components/schemas/FilteredAlarmsAttributes'
    FilteredAlarmsLinks:
      title: FilteredAlarmsLinks
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FilteredAlarmsLinksNext'
    FilteredAlarmsLinksMeta:
      title: FilteredAlarmsLinksMeta
      type: object
      properties:
        nextOffset:
          type: integer
          description: The offset for the next page of results
          format: int32
    FilteredAlarmsLinksNext:
      title: FilteredAlarmsLinksNext
      type: object
      properties:
        href:
          type: string
          description: The href for the next page of results
        meta:
          $ref: '#/components/schemas/FilteredAlarmsLinksMeta'
    FilteredAlarmsMeta:
      title: FilteredAlarmsMeta
      type: object
      properties:
        context-total:
          type: integer
          description: Total records matching the filters in the database
          format: int64
        query-total:
          type: integer
          description: Total records matching the filters in the database
          format: int64
        context-aggregations:
          $ref: '#/components/schemas/FilteredAlarmsMetaContextAggregations'
        query-aggregations:
          $ref: '#/components/schemas/FilteredAlarmsMetaQueryAggregations'
    FilteredAlarmsMetaContextAggregations:
      title: FilteredAlarmsMetaContextAggregations
      type: object
      properties:
        state:
          type: array
          items:
            type: object
          description: A map of state values and their counts associated with the context results
        severity:
          type: array
          items:
            type: object
          description: A map of severity values and their counts associated with the context results
        serviceAffecting:
          type: array
          items:
            type: object
          description: A map of service affecting values and their counts associated with the context results
        deviceType:
          type: array
          items:
            type: object
          description: A map of device type values and their counts associated with the context results
        acknowledgeState:
          type: array
          items:
            type: object
          description: A map of acknowledge state values and their counts associated with the context results
        deviceId:
          type: array
          items:
            type: object
          description: A map of device id values and their counts associated with the context results
        deviceName:
          type: array
          items:
            type: object
          description: A map of device name values and their counts associated with the context results
        ipAddress:
          type: array
          items:
            type: object
          description: A map of IP address values and their counts associated with the context results
        macAddress:
          type: array
          items:
            type: object
          description: A map of MAC address values and their counts associated with the context results
    FilteredAlarmsMetaFacetCounts:
      title: FilteredAlarmsMetaFacetCounts
      type: object
      properties:
        state:
          type: object
        severity:
          type: object
        serviceAffecting:
          type: object
        deviceType:
          type: object
        acknowledgeState:
          type: object
    FilteredAlarmsMetaQueryAggregations:
      title: FilteredAlarmsMetaQueryAggregations
      type: object
      properties:
        state:
          type: object
        severity:
          type: object
        serviceAffecting:
          type: object
        deviceType:
          type: object
        acknowledgeState:
          type: object
        deviceId:
          type: object
        deviceName:
          type: object
        ipAddress:
          type: object
        macAddress:
          type: object
    FilteredAlarmsParams:
      title: FilteredAlarmsParams
      type: object
      properties:
        alarmId:
          type: array
          items:
            type: string
          description: List of alarm id values.
        state:
          type: array
          items:
            type: string
          description: 'List of state values.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>'
        contextState:
          type: array
          items:
            type: string
          description: 'List of state values.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>'
        severity:
          type: array
          items:
            type: string
          description: 'List of severity values.<p>**Example**: _CRITICAL, MAJOR, MINOR, WARNING_</p>'
        serviceAffecting:
          type: array
          items:
            type: string
          description: 'List of service affecting values.<p>**Example**: _SERVICE_AFFECTING, NON_SERVICE_AFFECTING_</p>'
        deviceType:
          type: array
          items:
            type: string
          description: 'List of device type values.<p>**Example**: _6500, OPENSTACK, NUAGE_</p>'
        acknowledgeState:
          type: array
          items:
            type: string
          description: 'List of acknowledgment state values.<p>**Example**: _ACKNOWLEDGED, NOT_ACKNOWLEDGED_</p>'
        deviceId:
          type: array
          items:
            type: string
          description: List of device id values.
        deviceName:
          type: array
          items:
            type: string
          description: List of device name values.
        ipAddress:
          type: array
          items:
            type: string
          description: 'List of IP address values.<p>**Example**: _192.168.42.2, 192.168.42.3_</p>'
        macAddress:
          type: array
          items:
            type: string
          description: 'List of MAC address values.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_'
        deviceTag:
          type: array
          items:
            type: string
          description: List of device tag values.
        additionalText:
          type: array
          items:
            type: string
          description: List of additional text values.
        annotation:
          type: array
          items:
            type: string
          description: List of annotation text values.
        nativeConditionType:
          type: array
          items:
            type: string
          description: List of native condition type values.
        resource:
          type: array
          items:
            type: string
          description: List of resource values.
        resourceId:
          type: array
          items:
            type: string
          description: List of resource ID values.
        subnetName:
          type: array
          items:
            type: string
          description: List of case sensitive subnet name values.
        cardType:
          type: array
          items:
            type: string
          description: 'List of card type values.<p>**Example**: _SP-2_</p>'
        clfi:
          type: array
          items:
            type: string
          description: List of CLFI values.
        fic:
          type: array
          items:
            type: string
          description: List of FIC values.
        partition:
          type: array
          items:
            type: string
          description: 'List of partition values.<p>**Example**: _a08a7792-27a5-42d3-9169-2826d3d32b0c, 3541ccf8-03d2-3c0a-a7e5-3b88ca78df35_</p>'
        keytext:
          type: string
          description: "Key text, minimum 3 characters, to be present in the support alarm fields.<p>Support fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>"
        lastRaisedTime:
          type: string
          description: 'Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        lastRaisedTimeFrom:
          type: string
          description: 'Last raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>'
        lastRaisedTimeTo:
          type: string
          description: 'Last raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>'
        clearTime:
          type: string
          description: 'Comma separated clear time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        clearTimeFrom:
          type: string
          description: 'Last clear time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>'
        clearTimeTo:
          type: string
          description: 'Last clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>'
        refinedRaisedTimeFrom:
          type: string
          description: 'Refined raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>'
        refinedRaisedTimeTo:
          type: string
          description: 'Refined raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>'
        refinedClearTimeFrom:
          type: string
          description: 'Refined cleared time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>'
        refinedClearTimeTo:
          type: string
          description: 'Refined cleared time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>'
        allTime:
          type: string
          description: 'Comma separated time range to be searched in both active and historical alarms, in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000,2999-12-31T23:59:59.999_</p>'
        offset:
          type: string
          description: 'Offset for the next page of results.<p>**Example**: _50_'
        pageSize:
          type: string
          description: Limit of the number of alarms present in a page.
        sort:
          type: array
          items:
            type: string
          description: 'List of alarm attributes that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>'
    Filters:
      title: Filters
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FilterData'
          description: ''
    HistoricalAlarms:
      title: HistoricalAlarms
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/HistoricalAlarmsData'
          description: ''
        meta:
          $ref: '#/components/schemas/FilteredAlarmsMeta'
        links:
          $ref: '#/components/schemas/FilteredAlarmsLinks'
    HistoricalAlarmsAttributes:
      title: HistoricalAlarmsAttributes
      type: object
      properties:
        id:
          type: string
          description: The alarm id
        node-id:
          type: string
          description: The unique ID associated with the node/device provided by the RA
        node-type:
          type: string
          description: The type of node/device, e.g. 6500
        resource:
          type: string
          description: The location and equipment type
        native-condition-type:
          type: string
          description: The native condition or alarm name
        condition-severity:
          $ref: '#/components/schemas/ConditionSeverity'
        service-affecting:
          $ref: '#/components/schemas/ServiceAffecting'
        additional-text:
          type: string
          description: Additional information about the alarm
        first-raise-time:
          type: string
          description: The date and time that the alarm was first raised
          format: date-time
        last-raise-time:
          type: string
          description: The date and time that the alarm was last raised
          format: date-time
        clear-time:
          type: string
          description: The date and time that the alarm was cleared
          format: date-time
        acknowledge-update-time:
          type: string
          description: The date and time that the alarms acknowledge state last changed
          format: date-time
        clear-user:
          type: string
          description: The user that cleared the alarm
        acknowledge-update-user:
          type: string
          description: The user that last updated the acknowledge state the alarm
        number-of-occurrences:
          type: integer
          description: The number of times the alarm had occurred at the time it was cleared
          format: int64
        device-name:
          type: string
          description: Device's name.
        ip-address:
          type: string
          description: Device's IP address.
        mac-address:
          type: string
          description: Device's Mac address.
        device-attributes:
          type: object
    HistoricalAlarmsData:
      title: HistoricalAlarmsData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the alarm
        type:
          $ref: '#/components/schemas/Type6'
        attributes:
          $ref: '#/components/schemas/HistoricalAlarmsAttributes'
    IpAddressesAggregation:
      title: IpAddressesAggregation
      type: object
      properties:
        data:
          $ref: '#/components/schemas/IpAddressesAggregationData'
    IpAddressesAggregationAttributes:
      title: IpAddressesAggregationAttributes
      type: object
      properties:
        ipAddresses:
          type: array
          items:
            type: object
          description: ''
    IpAddressesAggregationData:
      title: IpAddressesAggregationData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type7'
        attributes:
          $ref: '#/components/schemas/IpAddressesAggregationAttributes'
    MacAddressesAggregation:
      title: MacAddressesAggregation
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MacAddressesAggregationData'
    MacAddressesAggregationAttributes:
      title: MacAddressesAggregationAttributes
      type: object
      properties:
        macAddresses:
          type: array
          items:
            type: object
          description: ''
    MacAddressesAggregationData:
      title: MacAddressesAggregationData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type8'
        attributes:
          $ref: '#/components/schemas/MacAddressesAggregationAttributes'
    NativeConditionType:
      title: NativeConditionType
      type: object
      properties:
        value:
          type: string
        count:
          type: integer
          format: int64
    NativeConditionTypesAggregation:
      title: NativeConditionTypesAggregation
      type: object
      properties:
        data:
          $ref: '#/components/schemas/NativeConditionTypesAggregationData'
    NativeConditionTypesAggregationAttributes:
      title: NativeConditionTypesAggregationAttributes
      type: object
      properties:
        nativeConditionTypes:
          type: array
          items:
            $ref: '#/components/schemas/NativeConditionType'
          description: ''
    NativeConditionTypesAggregationData:
      title: NativeConditionTypesAggregationData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type9'
        attributes:
          $ref: '#/components/schemas/NativeConditionTypesAggregationAttributes'
    NodeAlarmStateRO:
      title: NodeAlarmStateRO
      type: object
      properties:
        nodeId:
          type: string
        syncState:
          $ref: '#/components/schemas/SyncState'
        lastUpdated:
          type: string
          format: date-time
        syncFailedReason:
          $ref: '#/components/schemas/SyncFailedReason'
        lastSynced:
          type: string
          format: date-time
    Resource:
      title: Resource
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource (optional/ignored on calls to create)
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        domainId:
          type: string
          description: The domain for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        updatedAt:
          type: string
          description: Time of last update
          format: date-time
        createdAt:
          type: string
          description: Time of creation
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update including observed update
          format: int64
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        updateState:
          $ref: '#/components/schemas/UpdateState'
        updateReason:
          type: string
          description: Reason for the update state
        updateCount:
          type: integer
          description: Monotonically increasing count of updates applied to this resource
          format: int64
      description: Information describing a single resource
    ResourceObjectDeviceType:
      title: ResourceObjectDeviceType
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        relationships:
          type: object
          additionalProperties:
            type: object
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        attributes:
          $ref: '#/components/schemas/device-type'
    ResourceObjectObject:
      title: ResourceObjectObject
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        relationships:
          type: object
          additionalProperties:
            type: object
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        attributes:
          type: object
    ResourcesAggregation:
      title: ResourcesAggregation
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourcesAggregationData'
    ResourcesAggregationAttributes:
      title: ResourcesAggregationAttributes
      type: object
      properties:
        resources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: ''
    ResourcesAggregationData:
      title: ResourcesAggregationData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type10'
        attributes:
          $ref: '#/components/schemas/ResourcesAggregationAttributes'
    RetentionDaysRO:
      title: RetentionDaysRO
      type: object
      properties:
        retentionDays:
          type: integer
          format: int32
    SubnetName:
      title: SubnetName
      type: object
      properties:
        value:
          type: string
        count:
          type: integer
          format: int64
    SubnetNamesAggregation:
      title: SubnetNamesAggregation
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SubnetNamesAggregationData'
    SubnetNamesAggregationAttributes:
      title: SubnetNamesAggregationAttributes
      type: object
      properties:
        subnetNames:
          type: array
          items:
            $ref: '#/components/schemas/SubnetName'
          description: ''
    SubnetNamesAggregationData:
      title: SubnetNamesAggregationData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type11'
        attributes:
          $ref: '#/components/schemas/SubnetNamesAggregationAttributes'
    TotalAlarmRecordsCount:
      title: TotalAlarmRecordsCount
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TotalAlarmRecordsCountData'
    TotalAlarmRecordsCountAttributes:
      title: TotalAlarmRecordsCountAttributes
      type: object
      properties:
        id:
          type: string
        totalRecords:
          type: integer
          description: The total records count
          format: int64
    TotalAlarmRecordsCountData:
      title: TotalAlarmRecordsCountData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type12'
        attributes:
          $ref: '#/components/schemas/TotalAlarmRecordsCountAttributes'
    device-type:
      title: device-type
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: id of devicetype
        value:
          type: string
          description: Name of the device
    AffectingAlarmsParams:
      title: AffectingAlarmsParams
      type: object
      properties:
        inventoryId:
          type: array
          items:
            type: string
          description: List of inventory id values.
    ApiResponse:
      title: ApiResponse
      type: object
      properties:
        code:
          type: string
        level:
          type: string
        message:
          type: string
    CurrentPermissions:
      title: CurrentPermissions
      type: object
      properties:
        partitions:
          type: array
          items:
            $ref: '#/components/schemas/Partition'
          description: ''
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
          description: ''
    DeniedRbacResponse:
      title: DeniedRbacResponse
      type: object
      properties:
        message:
          type: string
        status:
          type: string
    GrantedRbacResponse:
      title: GrantedRbacResponse
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/Data'
        message:
          type: string
        permission:
          type: string
        status:
          type: string
        type:
          pattern: ^(AUTH|RBAC|RBAC_AUTH)$
          type: string
        version:
          type: string
    LastLoginDetail:
      title: LastLoginDetail
      type: object
      properties:
        ipAddress:
          type: string
        sessionId:
          type: string
        time:
          type: string
          format: date-time
    Partition:
      title: Partition
      type: object
      properties:
        partition:
          type: integer
          format: int32
        logSize:
          type: integer
          format: int64
        lastCommittedOffset:
          type: integer
          format: int64
        isr:
          type: array
          items:
            type: string
          description: ''
        replicas:
          type: array
          items:
            type: string
          description: ''
        leader:
          type: string
    Permission:
      title: Permission
      type: object
      properties:
        name:
          type: string
        uuid:
          type: string
    RbacSession:
      title: RbacSession
      type: object
      properties:
        creationTime:
          type: string
          format: date-time
        ipAddress:
          type: string
        lastAccess:
          type: string
          format: date-time
        sessionId:
          type: string
        userId:
          type: string
        userName:
          type: string
    RestPermissionData:
      title: RestPermissionData
      required:
      - authType
      - method
      - path
      type: object
      properties:
        Mac:
          type: string
        authType:
          pattern: ^(AUTH|RBAC|RBAC_AUTH)$
          type: string
        method:
          pattern: ^(POST|GET|PUT|DELETE|PATCH|OPTIONS|HEAD|TRACE|CONNECT)$
          type: string
        path:
          type: string
        token:
          type: string
    Role:
      title: Role
      type: object
      properties:
        application:
          type: string
        name:
          type: string
        uuid:
          type: string
        displayName:
          type: string
    User:
      title: User
      type: object
      properties:
        description:
          type: string
        email:
          type: string
        firstName:
          type: string
        isActive:
          type: boolean
        lastLoginDetail:
          $ref: '#/components/schemas/LastLoginDetail'
        lastName:
          type: string
        tenant:
          type: string
        tenantName:
          type: string
        username:
          type: string
        uuid:
          type: string
    UserAccount:
      title: UserAccount
      type: object
      properties:
        lastAccessed:
          type: string
          format: date-time
        retrievedTime:
          type: string
          format: date-time
        token:
          type: string
        tokenType:
          type: string
        user:
          $ref: '#/components/schemas/User'
        uuid:
          type: string
    FlattenUserAccount:
      title: FlattenUserAccount
      type: object
      properties:
        username:
          type: string
        allPartitions:
          type: boolean
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: ''
        partitions:
          type: array
          items:
            $ref: '#/components/schemas/Partition'
          description: ''
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
          description: ''
    sessionInfo:
      title: sessionInfo
      type: object
      properties:
        ciena-session-id:
          type: string
        ciena-user-id:
          type: string
        ciena-user-name:
          type: string
    ListReply:
      title: ListReply
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AuthorizedKey'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    RetrievedFile:
      title: RetrievedFile
      type: object
      properties:
        path:
          type: string
          description: Path specifying the location of the retrieved file
        content:
          type: string
          description: Text content of the file
      description: Container for a file retrieved from the Asset Manager
    ListReply1:
      title: ListReply1
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Area'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    AreaUpgrade:
      title: AreaUpgrade
      type: object
      properties:
        requestId:
          type: string
          description: Request UUID
        area:
          type: string
          description: Asset area name
        sourceDir:
          type: string
          description: Source directory for the upgrade content
        requestDate:
          type: string
          description: Timestamp that the upgrade request is received for processing
          format: date-time
        comment:
          type: string
          description: Comment or description for the upgrade
        commitDate:
          type: string
          description: The commit timestamp (successful upgrades only)
          format: date-time
        previousSignature:
          type: string
          description: The repository version signature prior to upgrade
        versionSignature:
          type: string
          description: The repository version signature for upgrade content
        branch:
          type: string
          description: The branch from which the upgrade pull request is performed
        tag:
          type: string
          description: The tag for the content submitted in the pull request
        pullRequestId:
          type: string
          description: The identifier for the associated pull request
        productionCommit:
          type: string
          description: The commit hash for the upgrade on the production branch
        status:
          $ref: '#/components/schemas/Status'
        reason:
          type: string
          description: Additional diagnostic information for an upgrade
        details:
          type: array
          items:
            $ref: '#/components/schemas/RejectionDetails'
          description: Additional details describing why an upgrade failed
      description: An asset area's upgrade request or event
    PullRequest:
      title: PullRequest
      type: object
      properties:
        requestId:
          type: string
          description: UUID for the PullRequest
        email:
          type: string
          description: Email address
        requestDate:
          type: string
          description: Date of the PullRequest
          format: date-time
        title:
          type: string
          description: Title
        comment:
          type: string
          description: Comment
        commitHash:
          type: string
          description: Git commit hash for the commit to pull
        commitDate:
          type: string
          description: Date of the Git commit to pull
          format: date-time
        status:
          type: object
        reason:
          type: string
          description: Reason for the status of the PullRequest
        details:
          type: array
          items:
            $ref: '#/components/schemas/RejectionDetails'
          description: Additional details describing why the PullRequest was rejected
        productionCommitHash:
          type: string
          description: The commit hash resulting from a successful pull request merged to the production branch
        branch:
          type: string
          description: The submission branch for the pull request
      description: Identification and information associated with a PullRequest
    Count:
      title: Count
      type: object
      properties:
        count:
          type: integer
          description: Count of items in scope
          format: int64
        bounded:
          type: boolean
          description: Whether the count is bounded by the limit
      description: Information describing count result
    AreaInformationReplyExternal:
      title: AreaInformationReplyExternal
      type: object
      properties:
        area:
          type: string
          description: Name of the area
        uri:
          type: string
          description: Uri for the area
        commitHash:
          type: string
          description: Latest commit hash for the area
        versionSignature:
          type: string
          description: Signature of the last release version incorporated into this area
        releaseSignature:
          type: string
          description: Signature for the latest available source content (i.e., installed release version - if different than the current versionSignature an upgrade is available)
        upgradeAvailable:
          type: boolean
          description: Is an upgrade available from the current release? (requires versionSignature and releaseSignature fields)
      description: Requested information fields for an Area
    ListReply2:
      title: ListReply2
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PullRequest'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply3:
      title: ListReply3
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AreaUpgrade'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    Area:
      title: Area
      type: object
      properties:
        name:
          type: string
          description: Asset area name
        externalGitUrl:
          type: string
          description: Git server URL for external use
        internalGitUrl:
          type: string
          description: Git server URL for internal use
      description: Information associated with a specific asset area (asset category)
    PullRequestSubmission:
      title: PullRequestSubmission
      type: object
      properties:
        branch:
          type: string
          description: Branch or commit hash from which the pull request is to be made
        title:
          type: string
          description: Title
        comment:
          type: string
          description: Optional comment
      description: Pull request submission
    PullRequestIssue:
      title: PullRequestIssue
      type: object
      properties:
        message:
          type: string
          description: Specific message describing an issue with the PR
        extra:
          type: object
      description: Information describing a specific issue with a PR
    FileEntry:
      title: FileEntry
      type: object
      properties:
        path:
          type: string
          description: The OS path to the file
        hash:
          type: string
          description: The SHA-1 hash of the file contents
        type:
          type: string
          description: The type of file
        access:
          type: string
          description: The access controls for the file
      description: Description of a file entry
    RejectionDetails:
      title: RejectionDetails
      type: object
      properties:
        component:
          type: string
          description: The component which rejected the PR (e.g, market-type-manager)
        description:
          type: string
          description: General (component specific) reason why the PR was rejected
        issues:
          type: array
          items:
            $ref: '#/components/schemas/PullRequestIssue'
          description: Specific issues with the PR which caused rejection
      description: Information describing why a PR was rejected by a particular component
    ChangeLog:
      title: ChangeLog
      type: object
      properties:
        changeId:
          type: string
          description: UUID for the change
        date:
          type: string
          description: Date/time stamp for the completion of the change
          format: date-time
        email:
          type: string
          description: Text of the email describing the change
        subject:
          type: string
          description: Subject of the email describing the change
      description: Information associated with a specific asset change
    AuthorizedKey:
      title: AuthorizedKey
      type: object
      properties:
        id:
          type: string
          description: Fingerprint (per ssh-keygen) of the key (without colons).  Not used on Create.
        key:
          type: string
          description: Authorized key (e.g., content of the id_rsa.pub file generated by ssh-keygen)
      description: Ssh public keys authorized for git access
    ListReply4:
      title: ListReply4
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ChangeLog'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply5:
      title: ListReply5
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FileEntry'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ErrorResponse:
      title: ErrorResponse
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
          description: A list of all errors that occurred.
    AuditAttributesRO:
      title: AuditAttributesRO
      type: object
      properties:
        name:
          type: string
          description: The name of the audit
        auditType:
          $ref: '#/components/schemas/AuditType'
        description:
          type: string
          description: The description of the audit
        creationTime:
          type: string
          description: The creation time of the audit
        comments:
          type: string
          description: The comment of the audit
    AuditDataRO:
      title: AuditDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the audit
        type:
          $ref: '#/components/schemas/Type13'
        attributes:
          $ref: '#/components/schemas/AuditAttributesRO'
        relationships:
          $ref: '#/components/schemas/AuditRelationshipsRO'
    AuditFindingAttributesRO:
      title: AuditFindingAttributesRO
      type: object
      properties:
        fixTime:
          type: string
          description: The fix time of the audit
        fixState:
          $ref: '#/components/schemas/FixingStateRO'
        severity:
          $ref: '#/components/schemas/Severity'
        comments:
          type: string
          description: The comments of the audit findings
        issueMessage:
          type: string
          description: The description of the issue
        testKey:
          type: string
          description: The description of the profile Name and test type of the issue
        testType:
          type: string
          description: The description of the test type of the issue
        profileName:
          type: string
          description: The name of the profile
        profileId:
          type: string
          description: The id of the profile
        isFixable:
          type: boolean
          description: If the testTypes that belong the profiles under this run provide fix APIs
          default: false
        groupId:
          type: string
          description: Group id of the finding
        neId:
          type: string
          description: Ne id for the finding
        neName:
          type: string
          description: Ne name for the finding
        neTags:
          type: array
          items:
            type: string
          description: ''
        neType:
          type: string
          description: Ne type for the finding
        nePartitions:
          type: array
          items:
            type: string
          description: ''
        instancePresent:
          type: boolean
          description: if an instance is present. Set to false when a global instance is not present
          default: false
        requireManualFix:
          type: boolean
          description: if this finding contains any finding details that requires manual fix
          default: false
        findingDetails:
          type: object
    AuditFindingDataRO:
      title: AuditFindingDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the audit finding
        type:
          $ref: '#/components/schemas/Type14'
        attributes:
          $ref: '#/components/schemas/AuditFindingAttributesRO'
        relationships:
          $ref: '#/components/schemas/AuditFindingRelationshipsRO'
    AuditFindingListRO:
      title: AuditFindingListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/AuditFindingMetaRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/AuditFindingDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    AuditFindingMetaRO:
      title: AuditFindingMetaRO
      type: object
      properties:
        tableDisplayData:
          type: object
        filteredByPartition:
          type: boolean
          description: If the response is filtered by partition
          default: false
    AuditFindingRO:
      title: AuditFindingRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/AuditFindingMetaRO'
        data:
          $ref: '#/components/schemas/AuditFindingDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    AuditFindingRelationshipsRO:
      title: AuditFindingRelationshipsRO
      type: object
      properties:
        audit:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        auditRun:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    AuditListRO:
      title: AuditListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AuditDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    AuditPatchOperationRO:
      title: AuditPatchOperationRO
      type: object
      properties:
        path:
          type: string
          description: The path to the audit attribute.
        op:
          $ref: '#/components/schemas/Op1'
        value:
          type: object
        ids:
          type: array
          items:
            type: string
          description: ''
    AuditPatchRO:
      title: AuditPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/AuditPatchOperationRO'
          description: ''
    AuditProfileAttributesRO:
      title: AuditProfileAttributesRO
      type: object
      properties:
        auditType:
          $ref: '#/components/schemas/AuditType'
        profileId:
          type: string
          description: The identifier of the profile coming from MCP App
        name:
          type: string
          description: The name of the profile
        supportMultipleAudits:
          type: boolean
          description: If the profile can belong more than one audit.
          default: false
        lastUpdatedTime:
          type: string
          description: The last updated time of the given profile, milliseconds after epoch
        mappingAttributes:
          type: object
    AuditProfileDataRO:
      title: AuditProfileDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the audit profile
        type:
          $ref: '#/components/schemas/Type15'
        attributes:
          $ref: '#/components/schemas/AuditProfileAttributesRO'
        relationships:
          $ref: '#/components/schemas/AuditProfileRelationshipsRO'
    AuditProfileListRO:
      title: AuditProfileListRO
      type: object
      properties:
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/AuditProfileDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    AuditProfileRO:
      title: AuditProfileRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditProfileDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    AuditProfileRelationshipsRO:
      title: AuditProfileRelationshipsRO
      type: object
      properties:
        testTypes:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    AuditRO:
      title: AuditRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    AuditRelationshipsRO:
      title: AuditRelationshipsRO
      type: object
      properties:
        auditProfiles:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        auditTarget:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        auditRuns:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    AuditRunAttributesRO:
      title: AuditRunAttributesRO
      type: object
      properties:
        description:
          type: string
          description: The description of the audit run.
        runTime:
          type: string
          description: The time of the audit run
        runSummary:
          $ref: '#/components/schemas/AuditSummaryRO'
        auditState:
          $ref: '#/components/schemas/AuditStateRO'
        findingState:
          $ref: '#/components/schemas/FindingState'
        fixState:
          $ref: '#/components/schemas/FixingStateRO'
        isFixable:
          type: boolean
          description: If the testTypes that belong the profiles under this run provide fix APIs
          default: false
    AuditRunDataRO:
      title: AuditRunDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the audit run
        type:
          $ref: '#/components/schemas/Type16'
        attributes:
          $ref: '#/components/schemas/AuditRunAttributesRO'
    AuditRunRO:
      title: AuditRunRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditRunDataRO'
    AuditStateRO:
      title: AuditStateRO
      type: object
      properties:
        state:
          $ref: '#/components/schemas/State2'
        message:
          type: string
          description: The message for state
    AuditSummaryRO:
      title: AuditSummaryRO
      type: object
      properties:
        totalResources:
          type: integer
          description: The total number of nodes that belong to the run.
          format: int32
        resourceTypes:
          $ref: '#/components/schemas/ResourceTypes'
        progressPercent:
          type: integer
          description: The audit progress in percentage.
          format: int32
        failed:
          type: integer
          description: The number of nodes that have failed in the audit run.
          format: int32
        findingSummaries:
          type: array
          items:
            $ref: '#/components/schemas/FindingSummaryRO'
          description: A list of finding summaries of test types.
        fixed:
          type: integer
          description: The number of fixed findings in the audit run.
          format: int32
        failures:
          type: array
          items:
            $ref: '#/components/schemas/FailureRO'
          description: A list of failures that belong to this run.
    AuditTargetAttributesRO:
      title: AuditTargetAttributesRO
      type: object
      properties:
        source:
          type: string
          description: The source that defines the NE context and provides the filtering, for example configmgmt, nsi
        queryParams:
          type: object
    AuditTargetDataRO:
      title: AuditTargetDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the audit target - same with the audit
        type:
          $ref: '#/components/schemas/Type17'
        attributes:
          $ref: '#/components/schemas/AuditTargetAttributesRO'
        relationships:
          $ref: '#/components/schemas/AuditTargetRelationshipsRO'
    AuditTargetRO:
      title: AuditTargetRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditTargetDataRO'
    AuditTargetRelationshipsRO:
      title: AuditTargetRelationshipsRO
      type: object
      properties:
        resources:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    FailureDetailRO:
      title: FailureDetailRO
      type: object
      properties:
        resource:
          type: string
          description: The resource of the failures
        message:
          type: string
          description: The failure message
    FailureRO:
      title: FailureRO
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
      description: The information about a failure
    FindingSummaryRO:
      title: FindingSummaryRO
      type: object
      properties:
        testKey:
          type: string
          description: The testKey the summaries are grouped by
        profileName:
          type: string
          description: The profile name
        testType:
          type: string
          description: The test type
        total:
          type: integer
          description: The total number of findings
          format: int32
        fixed:
          type: integer
          description: The number of fixed findings
          format: int32
        fixedFailed:
          type: integer
          description: The number of findings that are failed to be fixed
          format: int32
        requireManualFix:
          type: integer
          description: The number of findings that require manual fix
          format: int32
        progressPercent:
          type: integer
          description: The audit progress for test type in percentage.
          format: int32
    FixingStateRO:
      title: FixingStateRO
      type: object
      properties:
        state:
          $ref: '#/components/schemas/State1'
        message:
          type: string
          description: The message for state
    LinksRO:
      title: LinksRO
      type: object
      properties:
        self:
          type: string
          description: A `self` member, whose value is a URL for the relationship itself (a "relationship URL"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.
        first:
          type: string
          description: The first page of data
        last:
          type: string
          description: The last page of data
        prev:
          type: string
          description: The previous page of data
        next:
          type: string
          description: The next page of data
        current:
          type: string
          description: The current page of data
    OneToManyRelationshipRO:
      title: OneToManyRelationshipRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RelationshipDataRO'
          description: The one-to-many relationship
        meta:
          $ref: '#/components/schemas/RelationshipMetaDataRO'
    OneToOneRelationshipRO:
      title: OneToOneRelationshipRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RelationshipDataRO'
        meta:
          $ref: '#/components/schemas/RelationshipMetaDataRO'
    RelationshipDataRO:
      title: RelationshipDataRO
      type: object
      properties:
        type:
          type: string
          description: The relationship resource type
        id:
          type: string
          description: The unique identifier for the referenced resource.
    TestTypeAttributesRO:
      title: TestTypeAttributesRO
      type: object
      properties:
        name:
          type: string
          description: The name of the test type
        auditType:
          $ref: '#/components/schemas/AuditType'
        version:
          type: string
          description: The version of the test type
        typeGroups:
          type: array
          items:
            type: string
          description: ''
        description:
          type: string
          description: The description of the test type
        isFixable:
          type: boolean
          description: The test type supports fix
          default: false
        displayMapping:
          type: object
    TestTypeDataRO:
      title: TestTypeDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the test type
        type:
          $ref: '#/components/schemas/Type18'
        attributes:
          $ref: '#/components/schemas/TestTypeAttributesRO'
    TestTypeRO:
      title: TestTypeRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TestTypeDataRO'
    BackupDetail:
      title: BackupDetail
      type: object
      properties:
        scheduleName:
          type: string
        solutionName:
          type: string
        executionTime:
          type: string
        entityType:
          type: string
        status:
          type: string
        snapshotName:
          type: string
        failure:
          $ref: '#/components/schemas/Failure'
    BackupJob:
      title: BackupJob
      type: object
      properties:
        cancelled:
          type: boolean
          default: false
        schedule:
          $ref: '#/components/schemas/BackupSchedule'
        snapshots:
          type: array
          items:
            type: string
          description: ''
        label:
          type: string
        solutionName:
          type: string
        entityType:
          type: string
        force:
          type: boolean
          default: false
        details:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BackupDetail'
        lastExecutionTime:
          type: string
        name:
          type: string
        id:
          type: integer
          format: int64
        state:
          type: string
    BackupJobRO:
      title: BackupJobRO
      type: object
      properties:
        solutionName:
          type: string
        label:
          type: string
        state:
          type: string
        snapshots:
          type: array
          items:
            type: string
          description: ''
      description: The information about a backup job
    BackupRequestRO:
      title: BackupRequestRO
      type: object
      properties:
        solutionName:
          type: string
        label:
          type: string
    BackupSchedule:
      title: BackupSchedule
      type: object
      properties:
        frequency:
          $ref: '#/components/schemas/Frequency'
        time:
          type: string
        date:
          type: string
        dayOfMonth:
          type: integer
          format: int32
        dayOfWeek:
          $ref: '#/components/schemas/DayOfWeek'
        nextExecutionTime:
          type: string
        intervalInMinutes:
          type: integer
          format: int32
    BackupScheduleAttributesRO:
      title: BackupScheduleAttributesRO
      type: object
      properties:
        name:
          type: string
        solutionName:
          type: string
        label:
          type: string
        state:
          type: string
        lastExecutionTime:
          type: string
        schedule:
          $ref: '#/components/schemas/Schedule'
        force:
          type: boolean
          default: false
        entityType:
          type: string
      description: The attributes of a backup schedule
    BackupScheduleDataRO:
      title: BackupScheduleDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the backup schedule resource
        type:
          $ref: '#/components/schemas/Type20'
        attributes:
          $ref: '#/components/schemas/Attributes42'
        relationships:
          $ref: '#/components/schemas/BackupScheduleRelationshipsRO'
    BackupScheduleListRO:
      title: BackupScheduleListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BackupScheduleDataRO'
          description: Backup schedules
        included:
          type: array
          items:
            $ref: '#/components/schemas/BackupSnapshotDataRO'
          description: Referenced backup resources
    BackupScheduleRO:
      title: BackupScheduleRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BackupScheduleDataRO'
        included:
          type: array
          items:
            $ref: '#/components/schemas/BackupSnapshotDataRO'
          description: Referenced backup resources
    BackupScheduleRelationshipsRO:
      title: BackupScheduleRelationshipsRO
      type: object
      properties:
        backups:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    BackupSettingsAttributesRO:
      title: BackupSettingsAttributesRO
      type: object
      properties:
        archive:
          type: boolean
          default: false
        numberOfRetainedLocalBackups:
          type: integer
          format: int32
        numberOfRetainedArchivedBackups:
          type: integer
          format: int32
        timeoutInHours:
          type: integer
          format: int32
        raiseAlarmOnBackupFailure:
          type: boolean
          default: false
      description: The attributes of the backup settings
    BackupSettingsDataRO:
      title: BackupSettingsDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the backup settings resource
        type:
          $ref: '#/components/schemas/Type22'
        attributes:
          $ref: '#/components/schemas/Attributes210'
    BackupSettingsRO:
      title: BackupSettingsRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BackupSettingsDataRO'
    BackupSnapshotAttributesRO:
      title: BackupSnapshotAttributesRO
      type: object
      properties:
        scheduleName:
          type: string
        solutionName:
          type: string
        status:
          type: string
        executionTime:
          type: string
        snapshotName:
          type: string
        entityType:
          type: string
        failure:
          $ref: '#/components/schemas/Failure'
      description: The attributes of a backup snapshot
    BackupSnapshotDataRO:
      title: BackupSnapshotDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the backup snapshot resource
        type:
          $ref: '#/components/schemas/Type21'
        attributes:
          $ref: '#/components/schemas/BackupDetail'
    BackupSnapshotListRO:
      title: BackupSnapshotListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/BackupSnapshotMetaRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/BackupSnapshotDataRO'
          description: Backup snapshots
    BackupSnapshotMetaRO:
      title: BackupSnapshotMetaRO
      type: object
      properties:
        total:
          type: integer
          description: The total count of the backup snapshot resource
          format: int32
    Failure:
      title: Failure
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
    RestoreJobRO:
      title: RestoreJobRO
      type: object
      properties:
        solutionName:
          type: string
        solutionSnapshot:
          type: string
        state:
          type: string
        executionTime:
          type: string
      description: The information about a restore job
    RestoreRequestRO:
      title: RestoreRequestRO
      type: object
      properties:
        solutionName:
          type: string
        solutionSnapshot:
          type: string
    Schedule:
      title: Schedule
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type19'
        days:
          type: array
          items:
            $ref: '#/components/schemas/Day'
          description: ''
        time:
          type: string
    scriptsSummaryData:
      title: scriptsSummaryData
      required:
      - devicetypesURLs
      - projectName
      - nodes
      - supportedFormats
      type: object
      properties:
        devicetypesURLs:
          type: array
          items:
            $ref: '#/components/schemas/DevicetypesURL'
          description: The URLs to get commissioning scripts for each device types available in project.
        projectName:
          type: string
          description: Project name for which commissioning scripts are available.
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Node'
          description: Nodes available in the project.
        supportedFormats:
          type: array
          items:
            type: string
          description: Support formats of commissioning scripts available for this project.
    newEquipment:
      title: newEquipment
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data112'
    commissionProjectData:
      title: commissionProjectData
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data37'
    planningData:
      title: planningData
      type: object
      properties:
        id:
          type: string
          description: This field maps to the project id field in the RPT. This identifier is used by commissioning to retrieve auto-slat data from RPT.
        name:
          type: string
          description: This field maps to the project name field in the RPT.
      description: Data associated with Resource Planning Tool(RPT).
    networkConstructData:
      title: networkConstructData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the NetworkConstruct resource
        type:
          type: string
          description: The Network Construct resource type
        attributes:
          $ref: '#/components/schemas/networkConstructAttributes'
        relationships:
          $ref: '#/components/schemas/networkConstructRelationships'
    networkConstructExpectationsData:
      title: networkConstructExpectationsData
      required:
      - type
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the network construct expectation
        type:
          type: string
          description: The network construct expectation type
        attributes:
          $ref: '#/components/schemas/networkConstructExpectationAttributes'
        relationships:
          $ref: '#/components/schemas/networkConstructExpectationRelationships'
    networkConstructExpectationAttributes:
      title: networkConstructExpectationAttributes
      type: object
      properties:
        name:
          type: string
          description: Name (e.g. TID) of the Network Construct
        ipAddress:
          type: string
          description: IP address used for expectations.
        shelfType:
          type: string
          description: Shelf type of the network construct(example - ILA, DGE.
    networkConstructExpectationRelationships:
      title: networkConstructExpectationRelationships
      type: object
      properties:
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        serviceIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        physicalLocation:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        parentNetworkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
    equipmentData:
      title: equipmentData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the equipment resource
        type:
          type: string
          description: The equipment resource type
        attributes:
          $ref: '#/components/schemas/Attributes43'
        relationships:
          $ref: '#/components/schemas/Relationships3'
      description: The equipment data
    equipmentAttributes:
      title: equipmentAttributes
      type: object
      properties:
        locations:
          type: array
          items:
            $ref: '#/components/schemas/location'
          description: The list of locations associated with the equipment
        category:
          type: string
          description: The equipment category
        nativeName:
          type: string
          description: The native name of the equipment
        provisionedSpec:
          $ref: '#/components/schemas/ProvisionedSpec'
        installedSpec:
          $ref: '#/components/schemas/InstalledSpec'
        state:
          type: string
          description: The primary state of the equipment
        secondaryState:
          type: string
          description: The secondary state of the equipment
        availabilityState:
          type: string
          description: The availability state of the equipment
        reservationState:
          type: string
          description: The reservation state of the equipment
        cardType:
          type: string
          description: The card type
        siteName:
          type: string
          description: The site name associated with the equipment
        siteId:
          type: string
          description: The site identifier associated with the equipment
        maintenanceMode:
          type: boolean
          description: Maintenance mode to indicate if the equipment is available or not to MCP. While in maintenance mode, MCP will not provision anything against this equipment (including TPE information)
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/syncScope'
          description: The sync scope for the equipment
        additionalAttributes:
          $ref: '#/components/schemas/AdditionalAttributes1'
      description: The equipment attributes
    equipmentSpec:
      title: equipmentSpec
      type: object
      properties:
        hardwareVersion:
          type: string
          description: The hardware version
        serialNumber:
          type: string
          description: The serial number
        manufacturer:
          type: string
          description: The manufacturer
        type:
          type: string
          description: The type of equipment
        partNumber:
          type: string
          description: The part number
        version:
          type: string
          description: The software version
        displayLabels:
          $ref: '#/components/schemas/DisplayLabels'
        additionalAttributes:
          $ref: '#/components/schemas/AdditionalAttributes1'
      description: The specification of an equipment; can be either installed specification, the physical representation of the equipment, or provisioned specification, the logic representation of the equipment
    equipmentRelationships:
      title: equipmentRelationships
      type: object
      properties:
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        equipmentHolder:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        equipmentExpectations:
          $ref: '#/components/schemas/EquipmentExpectations'
      description: The equipment relationships
    networkConstructAttributes:
      title: networkConstructAttributes
      type: object
      properties:
        ipAddress:
          type: string
          description: IP Address of Network Construct.
        typeGroup:
          type: string
          description: Resource adapter type group.
        resourceType:
          type: string
          description: Resource Type.
        associationState:
          type: string
          description: Association state of the network construct.
        deviceType:
          type: string
          description: Device Type.
        softwareVersion:
          type: string
          description: Software version running in the device.
        accessIdentifier:
          type: string
          description: AID of the device.
        macAddress:
          type: string
          description: MAC address of the device.
        name:
          type: string
          description: Name (e.g. TID) of the Network Construct.
        geoLocation:
          $ref: '#/components/schemas/GeoLocation2'
        serialNumber:
          type: string
          description: Serial number (e.g. NNTMHQDP0001).
        deviceVersion:
          type: string
          description: Device version (example- 6500 32-SLOT OPTICAL).
        softwareType:
          type: string
          description: Software type (example- OCP)
        softwareImage:
          type: string
          description: Software image
        subnetName:
          type: string
          description: Subnet name (e.g. ROADM1---ROADM2---SUBNET)
        numberOfShelves:
          type: integer
          description: Number of shelves (primary + member shelves in case of TIDc)
          format: int32
        memberFunction:
          type: string
          description: Member function of the network construct.
        shelfType:
          type: string
          description: Shelf type of the network construct.
        additionalAttributes:
          $ref: '#/components/schemas/AdditionalAttributes1'
        capabilitySpecRef:
          type: string
          description: Name of the file which contains the constraint rules of the network device.
        identifiers:
          type: array
          items:
            type: object
          description: ''
        userData:
          type: object
          description: User data
        modelType:
          type: string
          description: The model type of network construct, TPE, FRE.
        networkConstructType:
          type: string
          description: The type of network construct. It is used to represent the physical hierarchy of a network element.
        l2Data:
          type: array
          items:
            $ref: '#/components/schemas/l2Data'
          description: ''
    networkConstructRelationships:
      title: networkConstructRelationships
      type: object
      properties:
        networkConstructExpectations:
          $ref: '#/components/schemas/NetworkConstructExpectations'
        managementSession:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        physicalLocation:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        parentNetworkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        childrenNetworkConstruct:
          $ref: '#/components/schemas/ChildrenNetworkConstruct'
        concrete:
          $ref: '#/components/schemas/Concrete'
    geoLocation:
      title: geoLocation
      type: object
      properties:
        zone:
          type: string
          description: Zone of the device location
        longitude:
          type: string
          description: Longitude of the device location
        latitude:
          type: string
          description: Latitude of the device location
      description: The geography location of the device
    location:
      title: location
      type: object
      properties:
        baynum:
          type: string
        mcId:
          type: string
          description: chcIdx of NMCC AID
        port:
          type: string
        shelf:
          type: string
        slot:
          type: string
        subport:
          type: string
        subslot:
          type: string
      description: The location of the entity queried for metrics
    remoteNetworkConstructRoute:
      title: remoteNetworkConstructRoute
      type: object
      properties:
        name:
          type: string
          description: TL1 target identifier for an NE (e.g. G4218-2NCP06)
        connectionAddress:
          type: array
          items:
            $ref: '#/components/schemas/remoteNetworkConstructRoutingConnectionAddress'
          description: Connection addresses of the NE
        additionalAttributes:
          $ref: '#/components/schemas/AdditionalAttributes1'
      description: The remote NE connection data
    remoteNetworkConstructRoutingConnectionAddress:
      title: remoteNetworkConstructRoutingConnectionAddress
      type: object
      properties:
        address:
          type: string
          description: Connection address of the NE
        cost:
          type: integer
          description: Connection cost of the above mentioned address (optional)
          format: int32
      description: The remote NE connection data
    additionalAttributes:
      title: additionalAttributes
      type: object
      properties:
        additionalProperties:
          type: string
      description: Various miscellaneous attributes that do not necessarily belong in the parent resource. Attributes are populated dynamically and therefore cannot be documented here.
    displayLabelMap:
      title: displayLabelMap
      type: object
      properties:
        additionalProperties:
          type: string
      description: Display label key/value pair map
    oneToManyRelationship:
      title: oneToManyRelationship
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/relationshipData'
          description: The one-to-many relationship
      description: The one-to-many relationship
    oneToOneRelationship:
      title: oneToOneRelationship
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RelationshipDataRO'
      description: The one-to-one relationship
    relationshipData:
      title: relationshipData
      type: object
      properties:
        type:
          type: string
          description: The relationship resource type
        id:
          type: string
          description: The unique identifier for the referenced resource.
      description: The relationship type and identifier
    syncScope:
      title: syncScope
      type: object
      properties:
        context:
          type: array
          items:
            type: string
          description: sync scope context
        name:
          type: array
          items:
            type: string
          description: sync scope name
      description: The synchronization scope
    l2Data:
      title: l2Data
      type: object
      properties:
        shelf:
          type: string
          description: Shelf number
        eqptGrp:
          type: string
          description: The group ID obtained from RTRV-EQPTGRP for the SAOS card on which the entity resides
        loopbackAddresses:
          type: array
          items:
            type: string
          description: The loopback addresses in the NE.
        staticTunnelLabelRange:
          $ref: '#/components/schemas/RangeRO'
        dynamicLabelRange:
          $ref: '#/components/schemas/RangeRO'
        staticVcLabelRange:
          $ref: '#/components/schemas/RangeRO'
      description: Describes a single entry in the L2Data
    range:
      title: range
      type: object
      properties:
        minValue:
          type: integer
          description: This defines the min value for the range.
          format: int32
        maxValue:
          type: integer
          description: This defines the max value for the range.
          format: int32
      description: Describes a Range attribute
    defaults:
      title: defaults
      required:
      - data
      type: object
      properties:
        data:
          type: object
          description: Data for defaults of a policy.
    policy:
      title: policy
      required:
      - policyName
      - policyType
      type: object
      properties:
        policyName:
          type: string
          description: Name of policy
        policyType:
          type: string
          description: Type of policy
        description:
          type: string
          description: Description of policy
        customerName:
          type: string
          description: Customer notes
        state:
          type: string
          description: 'State of policy. For example: New, Enable, Disable'
        policyId:
          type: string
          description: Id of policy
    ipsubnet:
      title: ipsubnet
      required:
      - shelfIP
      - ospfArea
      type: object
      properties:
        shelfIP:
          type: string
          description: Shelf IPv4 subnet with CIDR
        ospfArea:
          type: string
          description: ospfArea of the Shelf
        usage:
          type: string
          description: IPSubnet is allocated for shelf, craft
    ipremoval:
      title: ipremoval
      required:
      - subnetId
      - ospfArea
      type: object
      properties:
        subnetId:
          type: string
          description: Subnet id
        ospfArea:
          type: string
          description: ospfArea of the Shelf
    IPSubnet1:
      title: IPSubnet1
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data3'
          description: ''
    IPAddressSubnet:
      title: IPAddressSubnet
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data4'
    session:
      title: session
      required:
      - session_id
      type: object
      properties:
        session_id:
          type: string
          description: The data associated with this request.
    deployedShelfRemoval:
      title: deployedShelfRemoval
      required:
      - tid
      - shelfNumber
      type: object
      properties:
        tid:
          type: string
          description: Target Identifier of the shelf
        shelfNumber:
          type: string
          description: Shelf Number
    projectDeploymentData:
      title: projectDeploymentData
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data5'
    projectPostDeploymentResponseData:
      title: projectPostDeploymentResponseData
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data6'
    PostDeploymentRequestData:
      title: PostDeploymentRequestData
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data7'
    DeploymentDataNodes:
      title: DeploymentDataNodes
      type: object
      properties:
        function:
          type: string
          description: Function of the network element.
        name:
          type: string
          description: Network element name
        ncExpID:
          type: string
          description: Network construct expectation ID of the NE in the NSI.
        version:
          type: string
          description: The version number of the NE.
        ncID:
          type: string
          description: Network construct ID of the NE in NSI.
        osrpNodeName:
          type: string
          description: OSRP node name of the network element.
        type:
          type: string
          description: Type of the network element.
        shelves:
          type: array
          items:
            $ref: '#/components/schemas/Shelf1'
          description: shelves data in the network element.
    ConfigResourceData:
      title: ConfigResourceData
      type: object
      properties:
        attributes:
          type: object
    ConfigResourceRequest:
      title: ConfigResourceRequest
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConfigResourceData'
          description: List of ConfigResourceRequest Object
    ConfigResourceResponse:
      title: ConfigResourceResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConfigResourceData'
          description: An array of ConfigResources
    AffectedService:
      title: AffectedService
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/InventoryInfo'
        id:
          type: string
        type:
          type: string
    AffectedServicesCounts:
      title: AffectedServicesCounts
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AffectedServicesCountsData'
    AffectedServicesCountsData:
      title: AffectedServicesCountsData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes4'
        id:
          type: string
        type:
          type: string
    AffectedServicesCountsParams:
      title: AffectedServicesCountsParams
      type: object
      properties:
        alarmIds:
          type: array
          items:
            type: string
          description: ''
    AffectedServicesData:
      title: AffectedServicesData
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AffectedService'
          description: ''
        meta:
          $ref: '#/components/schemas/Meta'
    AlarmAttributes:
      title: AlarmAttributes
      required:
      - affected-inventory-ids
      type: object
      properties:
        affected-inventory-ids:
          type: array
          items:
            type: string
          description: Inventory IDs affected by alarms
    AlarmData:
      title: AlarmData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AlarmAttributes'
        id:
          type: string
          description: The unique identifier for the alarm
        type:
          type: string
          description: The alarm type
    AlarmRelationship:
      title: AlarmRelationship
      required:
      - name
      - parent
      type: object
      properties:
        name:
          type: string
          description: The unique type for the referenced resource.
        parent:
          type: string
          description: The parent inventory id of refrenced resource.
    BulkActionsNumber:
      title: BulkActionsNumber
      type: object
      properties:
        BulkActionsNumber:
          type: integer
          description: The bulk actions number for bulk load
          format: int32
    BulkLoadWorkers:
      title: BulkLoadWorkers
      type: object
      properties:
        BulkLoadWorkers:
          type: integer
          description: The number of bulk load workers
          format: int32
    CorrelatedAlarmsData:
      title: CorrelatedAlarmsData
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AlarmData'
          description: ''
        meta:
          $ref: '#/components/schemas/Meta1'
    FlushInterval:
      title: FlushInterval
      type: object
      properties:
        FlushInterval:
          type: integer
          description: The flush interval for bulk load
          format: int32
    InvRelationship:
      title: InvRelationship
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: The unique type for the referenced resource.
    InventoryInfo:
      title: InventoryInfo
      required:
      - inventoryType
      type: object
      properties:
        inventoryType:
          type: string
          description: type of inventory
    Definesrelationshipspropertiesandlinkagebetweendifferentinventoryandservices.:
      title: Definesrelationshipspropertiesandlinkagebetweendifferentinventoryandservices.
      type: object
      properties:
        data:
          $ref: '#/components/schemas/InventoryRelationshipData'
      description: This is typically what is received via a ChangeEvent from an Inventory system to inform this service on the graph tree against which events are correlated
    InventoryRelationshipAttributes:
      title: InventoryRelationshipAttributes
      required:
      - inventoryInfo
      type: object
      properties:
        inventoryInfo:
          $ref: '#/components/schemas/InventoryInfo'
    InventoryRelationshipData:
      title: InventoryRelationshipData
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/InventoryRelationshipAttributes'
        id:
          type: string
          description: Id that uniquely identifies an inventory
        relationships:
          $ref: '#/components/schemas/Relationships12'
        type:
          type: string
          description: The Inventory Relationship resource type
    LogLevel:
      title: LogLevel
      type: object
      properties:
        level:
          $ref: '#/components/schemas/Level'
    Relationship:
      title: Relationship
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the relationship (optional/ignored on calls to create)
        relationshipTypeId:
          type: string
          description: URI of relationship type
        properties:
          $ref: '#/components/schemas/JObject'
        sourceId:
          type: string
          description: UUID of source resource
        sourceResourceTypeId:
          type: string
          description: URI of source resource type
        requirementName:
          type: string
          description: Requirement name in source resource
        targetId:
          type: string
          description: UUID of target resource
        targetResourceTypeId:
          type: string
          description: URI of target resource type
        capabilityName:
          type: string
          description: Capability name in target resource
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        providerData:
          $ref: '#/components/schemas/JObject'
      description: Information describing a single relationship
    Credentials:
      title: Credentials
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data8'
      description: The credentials expected for BPI commands
    AggregationBucketRO:
      title: AggregationBucketRO
      type: object
      properties:
        bucketKey:
          type: string
          description: The key of the aggregation criteria
        bucketValue:
          type: string
          description: The result of the aggregation
        absoluteTotal:
          type: string
          description: The unfiltered total number of entities in the data
        subAggregations:
          $ref: '#/components/schemas/AggregationRO'
    AggregationRO:
      title: AggregationRO
      type: object
      properties:
        name:
          type: string
          description: The name of the aggregation
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/AggregationBucketRO'
          description: Aggregation results for different criteria
    AttributeMatchingRuleRO:
      title: AttributeMatchingRuleRO
      type: object
      properties:
        matchingScope:
          $ref: '#/components/schemas/MatchingScope'
        matchRequired:
          type: boolean
          default: false
        impact:
          $ref: '#/components/schemas/Impact'
    AttributeModificationRuleRO:
      title: AttributeModificationRuleRO
      type: object
      properties:
        permittedOperation:
          $ref: '#/components/schemas/PermittedOperation'
        constraint:
          $ref: '#/components/schemas/Constraint'
    AttributePoliciesRO:
      title: AttributePoliciesRO
      type: object
      properties:
        defaultAttributeSourcePolicy:
          $ref: '#/components/schemas/DefaultAttributeSourcePolicy'
        overrides:
          type: array
          items:
            $ref: '#/components/schemas/AttributePolicyOverrideRO'
          description: ''
    AttributePolicyOverrideRO:
      title: AttributePolicyOverrideRO
      type: object
      properties:
        attributeName:
          type: string
          description: Attribute path(e.g. attribute.customerCode or relationship.endpoints)
        policies:
          type: array
          items:
            $ref: '#/components/schemas/Policy1'
          description: ''
        attributeSource:
          type: string
          description: Attribute source, in case it has the value from some other references, (e.g. attributes.srlg is relationships.srlgs.id
    AttributeSpecRO:
      title: AttributeSpecRO
      type: object
      properties:
        name:
          type: string
          description: Name of attribute.
        transmode:
          type: string
          description: transmode of attribute.
        location:
          type: string
          description: Location of attribute, using dot notation e.g. attributes.layerTerminations[DSR].additionalAttributes.
        format:
          type: string
          description: Format of attribute.
        defaultValue:
          type: string
          description: Default value for attribute.
        modificationRules:
          type: array
          items:
            $ref: '#/components/schemas/AttributeModificationRuleRO'
          description: List of operations that are permitted on the attribute.
        displayRules:
          type: array
          items:
            $ref: '#/components/schemas/DisplayRuleRO'
          description: Display rules applicable for the attribute.
        valueOptions:
          $ref: '#/components/schemas/AttributeValueOptionRO'
        matchingRules:
          type: array
          items:
            $ref: '#/components/schemas/AttributeMatchingRuleRO'
          description: List of matching rules that apply to this attribute.
    AttributeValueOptionRO:
      title: AttributeValueOptionRO
      type: object
      properties:
        selectFrom:
          type: array
          items:
            type: string
          description: A comma separated list of the choices available for selection.
        range:
          type: string
          description: A range of values in the format of '<from>,<to>,[step]' whereby from is the initial value, to is the end value, and an optional step value to indicate the increment.
    AttributesRO:
      title: AttributesRO
      type: object
      properties:
        structured:
          type: object
        opaque:
          type: string
          description: Opaque value of SRLG as per the current SRLG format
    CapabilitySpecRO:
      title: CapabilitySpecRO
      type: object
      properties:
        attributeSpecs:
          type: array
          items:
            $ref: '#/components/schemas/AttributeSpecRO'
          description: List of attributes defined in the capability specification that can be acted upon.
    DisplayRuleRO:
      title: DisplayRuleRO
      type: object
      properties:
        name:
          type: string
          description: Name of attribute.
        disabled:
          type: boolean
          description: Describes whether attribute is disabled or not.
          default: false
    EquipmentAttributesRO:
      title: EquipmentAttributesRO
      type: object
      properties:
        displayData:
          $ref: '#/components/schemas/EquipmentDisplayDataRO'
        suppressPort:
          type: boolean
          description: Value for alarm suppression
          default: false
        userData:
          type: object
        identifiers:
          type: array
          items:
            type: object
          description: ''
        specificationMismatch:
          type: boolean
          description: Indicates if there's a mismatch between either the planned, installed, or provisioned specifications
          default: false
        specificationMismatchStatus:
          type: string
          description: Indicates the status of a mismatch between either the planned, installed, or provisioned specifications
        state:
          $ref: '#/components/schemas/State3'
        neContactState:
          $ref: '#/components/schemas/NeContactState'
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/SyncScopeRO'
          description: The sync scope for the equipment
        capabilitySpecification:
          $ref: '#/components/schemas/CapabilitySpecRO'
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        policies:
          $ref: '#/components/schemas/AttributePoliciesRO'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: The list of locations associated with the equipment
        onus:
          type: array
          items:
            $ref: '#/components/schemas/OnuListRO'
          description: ONUs data.
        category:
          $ref: '#/components/schemas/Category'
        nativeName:
          type: string
          description: The native name of the equipment
        provisionedSpec:
          $ref: '#/components/schemas/EquipmentSpecRO'
        installedSpec:
          $ref: '#/components/schemas/EquipmentSpecRO'
        secondaryState:
          type: string
          description: The secondary state of the equipment
        availabilityState:
          $ref: '#/components/schemas/AvailabilityState'
        reservationState:
          $ref: '#/components/schemas/ReservationState'
        cardType:
          type: string
          description: The card type
        cardMode:
          $ref: '#/components/schemas/CardMode'
        siteName:
          type: string
          description: The site name associated with the equipment
        siteId:
          type: string
          description: The site identifier associated with the equipment
        siteGroup:
          type: string
          description: The site group associated with the equipment
        maintenanceMode:
          type: boolean
          description: Maintenance mode to indicate if the equipment is available or not to MCP. While in maintenance mode, MCP will not provision anything against this equipment (including TPE information)
          default: false
        additionalAttributes:
          type: object
        validationState:
          $ref: '#/components/schemas/ValidationState'
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
        customerCode:
          type: string
          description: Customer code
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
    EquipmentDataRO:
      title: EquipmentDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the equipment resource
        type:
          $ref: '#/components/schemas/Type23'
        attributes:
          $ref: '#/components/schemas/EquipmentAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentRelationshipsRO'
    EquipmentDisplayDataRO:
      title: EquipmentDisplayDataRO
      type: object
      properties:
        displayName:
          type: string
          description: Display name of the equipment
        displayNameFormat:
          type: string
          description: Format of the display name
        displayAvailabilityState:
          $ref: '#/components/schemas/DisplayAvailabilityState'
        displayState:
          $ref: '#/components/schemas/DisplayState'
    EquipmentExpectationAttributesRO:
      title: EquipmentExpectationAttributesRO
      type: object
      properties:
        validateParameters:
          $ref: '#/components/schemas/ValidateParametersRO'
        startDate:
          type: string
          description: The scheduled start date and time of the expectation, with RFC 3339 date-time format
        endDate:
          type: string
          description: The scheduled end date and time of the expectation, with RFC 3339 date-time format
        policies:
          type: array
          items:
            type: object
          description: Policies to be applied to the entity.
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: The list of locations associated with the equipment
        onus:
          type: array
          items:
            $ref: '#/components/schemas/OnuListRO'
          description: ONUs data.
        category:
          $ref: '#/components/schemas/Category'
        nativeName:
          type: string
          description: The native name of the equipment
        provisionedSpec:
          $ref: '#/components/schemas/EquipmentSpecRO'
        installedSpec:
          $ref: '#/components/schemas/EquipmentSpecRO'
        secondaryState:
          type: string
          description: The secondary state of the equipment
        availabilityState:
          $ref: '#/components/schemas/AvailabilityState'
        reservationState:
          $ref: '#/components/schemas/ReservationState'
        cardType:
          type: string
          description: The card type
        cardMode:
          $ref: '#/components/schemas/CardMode'
        siteName:
          type: string
          description: The site name associated with the equipment
        siteId:
          type: string
          description: The site identifier associated with the equipment
        siteGroup:
          type: string
          description: The site group associated with the equipment
        maintenanceMode:
          type: boolean
          description: Maintenance mode to indicate if the equipment is available or not to MCP. While in maintenance mode, MCP will not provision anything against this equipment (including TPE information)
          default: false
        additionalAttributes:
          type: object
        validationState:
          $ref: '#/components/schemas/ValidationState'
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
        customerCode:
          type: string
          description: Customer code
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
    EquipmentExpectationDataRO:
      title: EquipmentExpectationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the equipment expectation
        type:
          $ref: '#/components/schemas/Type24'
        attributes:
          $ref: '#/components/schemas/EquipmentExpectationAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentExpectationRelationshipsRO'
    EquipmentExpectationListRO:
      title: EquipmentExpectationListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentExpectationDataRO'
          description: The list of equipment expectation
    EquipmentExpectationRO:
      title: EquipmentExpectationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentExpectationDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    EquipmentExpectationRelationshipsRO:
      title: EquipmentExpectationRelationshipsRO
      type: object
      properties:
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        intent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentHolder:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        carrierEquipment:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    EquipmentListRO:
      title: EquipmentListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentDataRO'
          description: A list of equipment
        included:
          type: array
          items:
            type: object
          description: Resources related to equipment, such as EquipmentExpectationData
    EquipmentPatchOperationRO:
      title: EquipmentPatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op2'
        srlgRelationships:
          $ref: '#/components/schemas/SrlgPatchDataRO'
    EquipmentPatchRO:
      title: EquipmentPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentPatchOperationRO'
          description: ''
    EquipmentPlannedAttributesRO:
      title: EquipmentPlannedAttributesRO
      type: object
      properties:
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: The list of locations associated with the equipment
        onus:
          type: array
          items:
            $ref: '#/components/schemas/OnuListRO'
          description: ONUs data.
        category:
          $ref: '#/components/schemas/Category'
        nativeName:
          type: string
          description: The native name of the equipment
        provisionedSpec:
          $ref: '#/components/schemas/EquipmentSpecRO'
        installedSpec:
          $ref: '#/components/schemas/EquipmentSpecRO'
        secondaryState:
          type: string
          description: The secondary state of the equipment
        availabilityState:
          $ref: '#/components/schemas/AvailabilityState'
        reservationState:
          $ref: '#/components/schemas/ReservationState'
        cardType:
          type: string
          description: The card type
        cardMode:
          $ref: '#/components/schemas/CardMode'
        siteName:
          type: string
          description: The site name associated with the equipment
        siteId:
          type: string
          description: The site identifier associated with the equipment
        siteGroup:
          type: string
          description: The site group associated with the equipment
        maintenanceMode:
          type: boolean
          description: Maintenance mode to indicate if the equipment is available or not to MCP. While in maintenance mode, MCP will not provision anything against this equipment (including TPE information)
          default: false
        additionalAttributes:
          type: object
        validationState:
          $ref: '#/components/schemas/ValidationState'
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
        customerCode:
          type: string
          description: Customer code
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
    EquipmentPlannedDataRO:
      title: EquipmentPlannedDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the planned equipment
        type:
          $ref: '#/components/schemas/Type26'
        attributes:
          $ref: '#/components/schemas/EquipmentPlannedAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentPlannedRelationshipsRO'
    EquipmentPlannedRO:
      title: EquipmentPlannedRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentPlannedDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    EquipmentPlannedRelationshipsRO:
      title: EquipmentPlannedRelationshipsRO
      type: object
      properties:
        manualSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicAutoSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicInheritedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicPropagatedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentHolder:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        carrierEquipment:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    EquipmentRO:
      title: EquipmentRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        data:
          $ref: '#/components/schemas/EquipmentDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to equipment, such as EquipmentExpectationData
    EquipmentRelationshipsRO:
      title: EquipmentRelationshipsRO
      type: object
      properties:
        equipmentPlanned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        equipmentDiscovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        utilization:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentHolder:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        carrierEquipment:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    EquipmentSpecRO:
      title: EquipmentSpecRO
      type: object
      properties:
        hardwareVersion:
          type: string
          description: The hardware version
        serialNumber:
          type: string
          description: The serial number
        manufacturer:
          type: string
          description: The manufacturer
        type:
          type: string
          description: The type of equipment
        modemType:
          type: string
          description: The type of modem
        partNumber:
          type: string
          description: The part number
        version:
          type: string
          description: The software version
        displayLabels:
          type: object
        subtendingEquipment:
          type: array
          items:
            $ref: '#/components/schemas/SubtendingEquipmentDataRO'
          description: ''
        additionalAttributes:
          type: object
    ErrorRO:
      title: ErrorRO
      type: object
      properties:
        code:
          type: string
          description: Error code
        title:
          type: string
          description: Error title
        detail:
          type: string
          description: Error details
        source:
          $ref: '#/components/schemas/ErrorSourceRO'
    ErrorSourceRO:
      title: ErrorSourceRO
      type: object
      properties:
        pointer:
          type: string
          description: JSON Pointer to the associated entity in the request document
        parameter:
          type: string
          description: URI query parameter that caused the error
    ErrorsRO:
      title: ErrorsRO
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorRO'
          description: A list of errors
    LocationRO:
      title: LocationRO
      type: object
      properties:
        managementType:
          $ref: '#/components/schemas/ManagementType'
        fic:
          type: string
        baynum:
          type: string
        sncId:
          type: string
        rack:
          type: string
        shelf:
          type: string
        subshelf:
          type: string
        slot:
          type: string
        subslot:
          type: string
        subsubslot:
          type: string
        port:
          type: string
        subport:
          type: string
        instance:
          type: string
        logicalPortName:
          type: string
        logicalId:
          type: string
        channel:
          type: string
        wavelength:
          type: string
        index:
          type: string
        odu2_index:
          type: string
        odu4_index:
          type: string
        oduCn_index:
          type: string
        eth_index:
          type: string
        vlan:
          type: string
        vce:
          type: string
        eqptGrp:
          type: string
        peerAs:
          type: integer
          format: int64
        peerIp:
          type: string
        frequency:
          type: string
        mcId:
          type: string
        pseudoWireId:
          type: string
        pseudoWireName:
          type: string
        interfaceName:
          type: string
        interfaceIp:
          type: string
        primaryLspName:
          type: string
        tunnelRole:
          $ref: '#/components/schemas/TunnelRole'
        lspName:
          type: string
        protectionRole:
          $ref: '#/components/schemas/ProtectionRole'
        mplsLabel:
          type: string
        lagName:
          type: string
        mgmtMcId:
          type: string
        nmcId:
          type: string
        mgmtNmcId:
          type: string
        neName:
          type: string
        locationIndex:
          type: array
          items:
            type: object
          description: ''
        srcIp:
          type: string
        destIp:
          type: string
        leg:
          $ref: '#/components/schemas/Leg'
        fiberPairTermination:
          type: string
        direction:
          $ref: '#/components/schemas/Direction'
        iclName:
          type: string
        virtualRingName:
          type: string
        ringId:
          type: string
        rapsVid:
          type: string
        flexePortName:
          type: string
        flexeGroupName:
          type: string
    MetaDataRO:
      title: MetaDataRO
      type: object
      properties:
        total:
          type: integer
          description: The total number of entities in the data
          format: int64
        absoluteTotal:
          type: integer
          description: The unfiltered total number of entities in the data
          format: int64
        aggregations:
          type: array
          items:
            $ref: '#/components/schemas/AggregationRO'
          description: The aggregated data based on a requested aggregation name and criteria
        missingReferences:
          type: boolean
          description: boolean detailing if the GET FRE tree has any missing references
          default: false
        missingReferenceIds:
          type: array
          items:
            $ref: '#/components/schemas/RelationshipDataRO'
          description: The list of missing resource IDs
        filtered:
          type: boolean
          description: Flags whether the current object is filtered using `fields` query param or not
          default: false
    OnuListRO:
      title: OnuListRO
      type: object
      properties:
        name:
          type: string
          description: Name of the ONU.
        onuId:
          type: integer
          description: ONU Id as assigned by the OLT.
          format: int32
        mode:
          type: string
          description: Operating Mode of ONU
        modelNumber:
          type: string
          description: Model number of  ONU.
        serialNumber:
          type: string
          description: Serial number of the discovered ONU.
        dataLink:
          type: string
          description: Name of the datalink.
        operState:
          $ref: '#/components/schemas/OperState'
        deregisterReason:
          type: string
          description: Reason for the last ONU deregistration.
        firmwareVersion:
          type: string
          description: Version of the firmware running on  OLT.
        standbyFirmwareVersion:
          type: string
          description: Version of the firmware in the standby bank on  OLT.
        expectedFirmwareVersion:
          type: string
          description: Expected Firmware Version
        firmwareStatus:
          type: string
          description: Status of the firmware running on  OLT.
        firmwareUpgradeProgress:
          type: string
          description: Percentage completion of the ONU firmware upgrade operation
        firmwareUpgradeFailReason:
          type: string
          description: reason for the last ONU firmware upgrade failure
        onuDataLinks:
          type: integer
          description: Number of Datalinks under  ONU.
          format: int32
        uniPorts:
          type: integer
          description: Number of UNI ports on  ONU.
          format: int32
    RelationshipMetaDataRO:
      title: RelationshipMetaDataRO
      type: object
      properties:
        partiallyPopulated:
          type: boolean
          description: Flags whether the included relationship object is partially populated or not
          default: false
    ResourceMetaDataRO:
      title: ResourceMetaDataRO
      type: object
      properties:
        partiallyPopulated:
          type: boolean
          description: Flags whether the current object is partially populated or not
          default: false
    SRLGDataListRO:
      title: SRLGDataListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SRLGDataRO'
          description: Detailed SRLG
    SRLGDataRO:
      title: SRLGDataRO
      type: object
      properties:
        id:
          type: string
          description: The identifier value of the SRLG. It's same as the native value of structured srlg attributes
        type:
          $ref: '#/components/schemas/Type25'
        attributes:
          $ref: '#/components/schemas/AttributesRO'
    SrlgPatchDataRO:
      title: SrlgPatchDataRO
      type: object
      properties:
        srlg:
          $ref: '#/components/schemas/SRLGDataListRO'
        dynamicAutoSRLG:
          $ref: '#/components/schemas/SRLGDataListRO'
        manualSRLG:
          $ref: '#/components/schemas/SRLGDataListRO'
        dynamicPropagatedSRLG:
          $ref: '#/components/schemas/SRLGDataListRO'
        shareSrlg:
          $ref: '#/components/schemas/SRLGDataListRO'
        manualShareSRLG:
          $ref: '#/components/schemas/SRLGDataListRO'
        dynamicPropagatedShareSRLG:
          $ref: '#/components/schemas/SRLGDataListRO'
        srlgPatchTime:
          type: string
          description: The time stamp of the patch operation. The date format is YYYY-MM-DDTHH:MM:SS.SSSZ
    SubtendingEquipmentDataRO:
      title: SubtendingEquipmentDataRO
      type: object
      properties:
        total:
          type: string
        type:
          type: string
    SyncScopeRO:
      title: SyncScopeRO
      type: object
      properties:
        context:
          type: string
          description: The synchronization scope context
        name:
          type: array
          items:
            type: string
          description: The synchronization scope name
    ValidateParametersRO:
      title: ValidateParametersRO
      type: object
      properties:
        include:
          type: string
          description: The list of comma separated parameters (if any) to be validated against the expectation
    Common.ErrorSource:
      title: Common.ErrorSource
      type: object
      properties:
        pointer:
          type: string
        parameter:
          type: string
    Common.Error:
      title: Common.Error
      type: object
      properties:
        code:
          type: string
        title:
          type: string
        detail:
          type: string
        source:
          $ref: '#/components/schemas/Common.ErrorSource'
    AutoSlat.NodeFunction:
      title: AutoSlat.NodeFunction
      required:
      - nodeType
      type: object
      properties:
        nodeType:
          type: string
    AutoSlat.Aid:
      title: AutoSlat.Aid
      type: object
      properties:
        node:
          type: string
        shelf:
          type: string
        slot:
          type: string
        port:
          type: string
        subPort:
          type: string
        partnerSubPort:
          type: string
    AutoSlat.Link:
      title: AutoSlat.Link
      required:
      - name
      type: object
      properties:
        name:
          type: string
        linkType:
          type: string
        fiberType:
          type: string
        rx:
          $ref: '#/components/schemas/AutoSlat.Aid'
        tx:
          $ref: '#/components/schemas/AutoSlat.Aid'
        repairMargin:
          type: string
        egressFiberType:
          type: string
        ingressPPL:
          type: string
        egressPPL:
          type: string
        insertionLoss:
          type: string
        planningStatus:
          type: string
        expectedFiberLength:
          type: string
    AutoSlat.ConnectionValidation:
      title: AutoSlat.ConnectionValidation
      required:
      - name
      type: object
      properties:
        name:
          type: string
        rx:
          $ref: '#/components/schemas/AutoSlat.Aid'
        tx:
          $ref: '#/components/schemas/AutoSlat.Aid'
    AutoSlat.Pfib:
      title: AutoSlat.Pfib
      required:
      - band
      type: object
      properties:
        band:
          type: string
        raman:
          type: string
        pfib_a:
          type: string
        pfib_b:
          type: string
    AutoSlat.FiberProfile:
      title: AutoSlat.FiberProfile
      required:
      - profileType
      - fiberType
      type: object
      properties:
        attenuation:
          type: string
        dispersion:
          type: string
        effectiveArea:
          type: string
        profileType:
          type: string
        fiberType:
          type: string
        pfib:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Pfib'
          description: ''
    AutoSlat.OTDR:
      title: AutoSlat.OTDR
      required:
      - slot
      - port
      type: object
      properties:
        slot:
          type: string
        port:
          type: string
        lossThresholdAll:
          type: string
        lossThresholdSingle:
          type: string
    AutoSlat.ShelfIP:
      title: AutoSlat.ShelfIP
      required:
      - shelfOSPFV2Area
      - shelfIPV4
      - shelfNetMaskV4
      type: object
      properties:
        shelfOSPFV2Area:
          type: string
        shelfIPV4:
          type: string
        shelfNetMaskV4:
          type: string
    AutoSlat.Optmon:
      title: AutoSlat.Optmon
      required:
      - portNumber
      - primaryState
      - secondaryStatesAutoInServiceState
      type: object
      properties:
        portNumber:
          type: string
        primaryState:
          type: string
        secondaryStatesAutoInServiceState:
          type: string
    AutoSlat.Line:
      title: AutoSlat.Line
      required:
      - spanLossTarget
      - spanLossMargin
      - fiberType
      type: object
      properties:
        spanLossTarget:
          type: string
        spanLossMargin:
          type: string
        fiberType:
          type: string
        oscPfib:
          type: string
    AutoSlat.Adjacency:
      title: AutoSlat.Adjacency
      required:
      - adjShelf
      - adjSlot
      - farEndAddressForm
      - adjBay
      - adjPort
      - adjOts
      - portNumber
      - mode
      - adjPhysicalShelf
      - adjTid
      - type
      - aidType
      - excessLoss
      type: object
      properties:
        adjShelf:
          type: string
        adjSlot:
          type: string
        farEndAddressForm:
          type: string
        adjBay:
          type: string
        adjPort:
          type: string
        adjOts:
          type: string
        portNumber:
          type: string
        mode:
          type: string
        adjPhysicalShelf:
          type: string
        line:
          $ref: '#/components/schemas/AutoSlat.Line'
        adjTid:
          type: string
        type:
          type: string
        aidType:
          type: string
        excessLoss:
          type: string
        clfi:
          type: string
    AutoSlat.Ptp:
      title: AutoSlat.Ptp
      required:
      - id
      - role
      - linkOptMode
      - aidType
      type: object
      properties:
        id:
          type: string
        role:
          type: string
        linkOptMode:
          type: string
        aidType:
          type: string
        modemClass:
          type: string
        reachClass:
          type: string
        transMode:
          type: string
        serviceType:
          type: string
        farEndTp:
          type: string
    AutoSlat.Xcvr:
      title: AutoSlat.Xcvr
      required:
      - portNumber
      - mode
      - frequency
      - spli
      - portType
      type: object
      properties:
        portNumber:
          type: string
        mode:
          type: string
        frequency:
          type: string
        spli:
          type: string
        portType:
          type: string
        ptp:
          $ref: '#/components/schemas/AutoSlat.Ptp'
    AutoSlat.AmpFacility:
      title: AutoSlat.AmpFacility
      required:
      - outputLosThreshold
      - dropLimTargetGain
      - ampPeakMode
      - controlMode
      - inputLoss
      - gainMode
      - outputLoss
      - inputLosThreshold
      - aidType
      - topOffset
      - portNumber
      - targetTotalPower
      - gainOffset
      - forcedShutOff
      - targetPeakPower
      - peakPowerControlState
      - targetGain
      - targetGainTilt
      - shutoffThreshold
      - refBw
      type: object
      properties:
        outputLosThreshold:
          type: string
        dropLimTargetGain:
          type: string
        ampPeakMode:
          type: string
        controlMode:
          type: string
        inputLoss:
          type: string
        gainMode:
          type: string
        outputLoss:
          type: string
        inputLosThreshold:
          type: string
        aidType:
          type: string
        topOffset:
          type: string
        portNumber:
          type: string
        targetTotalPower:
          type: string
        gainOffset:
          type: string
        forcedShutOff:
          type: string
        targetPeakPower:
          type: string
        peakPowerControlState:
          type: string
        targetGain:
          type: string
        targetGainTilt:
          type: string
        shutoffThreshold:
          type: string
        refBw:
          type: string
    AutoSlat.CraftIP:
      title: AutoSlat.CraftIP
      required:
      - craftIPV4
      type: object
      properties:
        craftIPV4:
          type: string
    AutoSlat.VoaFacility:
      title: AutoSlat.VoaFacility
      required:
      - aidType
      - averageTargetPower
      - lossThreshold
      - portNumber
      - targetLoss
      - targetPad
      - targetPower
      - targetPeakPower
      - voaControlMode
      - voaResetRequired
      type: object
      properties:
        aidType:
          type: string
        averageTargetPower:
          type: string
        lossThreshold:
          type: string
        portNumber:
          type: string
        targetLoss:
          type: string
        targetPad:
          type: string
        targetPower:
          type: string
        targetPeakPower:
          type: string
        voaControlMode:
          type: string
        voaResetRequired:
          type: string
    AutoSlat.RamanFacility:
      title: AutoSlat.RamanFacility
      type: object
      properties:
        gainMode:
          type: string
        aidType:
          type: string
        portNumber:
          type: string
        targetGain:
          type: string
        totalPumpPower:
          type: string
        fiberType:
          type: string
    AutoSlat.Otuttp:
      title: AutoSlat.Otuttp
      required:
      - id
      - aidType
      - rate
      type: object
      properties:
        id:
          type: string
        aidType:
          type: string
        rate:
          type: string
        numts:
          type: string
    AutoSlat.Oductp:
      title: AutoSlat.Oductp
      required:
      - id
      type: object
      properties:
        id:
          type: string
        tsAssignment:
          type: string
    AutoSlat.Oduttp:
      title: AutoSlat.Oduttp
      required:
      - id
      - aidType
      type: object
      properties:
        id:
          type: string
        aidType:
          type: string
        oductp:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Oductp'
          description: ''
    AutoSlat.Equipment:
      title: AutoSlat.Equipment
      required:
      - slotNumber
      - aidType
      - pec
      type: object
      properties:
        optmon:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Optmon'
          description: ''
        slotNumber:
          type: string
        adjacency:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Adjacency'
          description: ''
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Equipment'
          description: ''
        xcvr:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Xcvr'
          description: ''
        ampFacility:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.AmpFacility'
          description: ''
        ots:
          type: string
        craftIP:
          $ref: '#/components/schemas/AutoSlat.CraftIP'
        aidType:
          type: string
        pec:
          type: string
        isSpare:
          type: string
        planningStatus:
          type: string
        voaFacility:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.VoaFacility'
          description: ''
        ramanFacility:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.RamanFacility'
          description: ''
        refRxTxType:
          type: string
        ptp:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Ptp'
          description: ''
        otuttp:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Otuttp'
          description: ''
        oduttp:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Oduttp'
          description: ''
        oscProvProfile:
          type: string
    AutoSlat.Gne:
      title: AutoSlat.Gne
      required:
      - gneIPSubnet
      - gneOSPFArea
      - gneIPSubnetMask
      type: object
      properties:
        gneIPSubnet:
          type: string
        gneOSPFArea:
          type: string
        gneIPSubnetMask:
          type: string
    AutoSlat.DocModClassFacility:
      title: AutoSlat.DocModClassFacility
      required:
      - aidType
      - modClassBias100G
      - modClassBias100GWL3
      - modClassBias100GWL316QAM
      - modClassBias100GWL34ASK
      - modClassBias100GWL38QAM
      - modClassBias100GWLBPSK3
      - modClassBias10G
      - modClassBias10GNGM
      - modClassBias2G5
      - modClassBias35GBaud100G
      - modClassBias35GBaud150G
      - modClassBias35GBaud200G
      - modClassBias35GBaud250G
      - modClassBias40G
      - modClassBias40GULH
      - modClassBias56GBaud100G
      - modClassBias56GBaud150G
      - modClassBias56GBaud200G
      - modClassBias56GBaud250G
      - modClassBias56GBaud300G
      - modClassBias56GBaud350G
      - modClassBias56GBaud400G
      - modClassBiasCfp2Dco28GBaud100G
      - modClassBiasCfp2Dco32GBaud100G
      - modClassBiasCfp2Dco32GBaud200G
      - modClassBiasCustom1
      - modClassBiasCustom2
      - modClassBiasCustom3
      - modClassBiasCustom4
      - modClassBiasCustom5
      - modClassBiasCustom6
      - modClassBiasWL5eGeneral
      type: object
      properties:
        aidType:
          type: string
        modClassBias100G:
          type: string
        modClassBias100GWL3:
          type: string
        modClassBias100GWL316QAM:
          type: string
        modClassBias100GWL34ASK:
          type: string
        modClassBias100GWL38QAM:
          type: string
        modClassBias100GWLBPSK3:
          type: string
        modClassBias10G:
          type: string
        modClassBias10GNGM:
          type: string
        modClassBias2G5:
          type: string
        modClassBias35GBaud100G:
          type: string
        modClassBias35GBaud150G:
          type: string
        modClassBias35GBaud200G:
          type: string
        modClassBias35GBaud250G:
          type: string
        modClassBias40G:
          type: string
        modClassBias40GULH:
          type: string
        modClassBias56GBaud100G:
          type: string
        modClassBias56GBaud150G:
          type: string
        modClassBias56GBaud200G:
          type: string
        modClassBias56GBaud250G:
          type: string
        modClassBias56GBaud300G:
          type: string
        modClassBias56GBaud350G:
          type: string
        modClassBias56GBaud400G:
          type: string
        modClassBiasCfp2Dco28GBaud100G:
          type: string
        modClassBiasCfp2Dco32GBaud100G:
          type: string
        modClassBiasCfp2Dco32GBaud200G:
          type: string
        modClassBiasCustom1:
          type: string
        modClassBiasCustom2:
          type: string
        modClassBiasCustom3:
          type: string
        modClassBiasCustom4:
          type: string
        modClassBiasCustom5:
          type: string
        modClassBiasCustom6:
          type: string
        modClassBiasWL5eGeneral:
          type: string
    AutoSlat.OTS:
      title: AutoSlat.OTS
      required:
      - minMuxPout
      - cmd8Slot
      - cfgType
      - cmd9Slot
      - dscm2Slot
      - limSlot
      - dscm1Slot
      - cmd7Slot
      - dscm4Slot
      - cmd5Slot
      - ampMate
      - dwid
      - oscSlotPort
      - derived
      - csInd
      - subType
      - cmd6Slot
      - cmd2Slot
      - cmd4Slot
      - cmd1Slot
      - bmdSlot
      - dropLimSlot
      - autoRoute
      - cmd3Slot
      - casLimSlot
      - osid
      - otsInstance
      - dscm3Slot
      - wssSlot
      - txPath
      - smdSlot
      - provAssociatedOts
      - isDocSite
      - planningStatus
      - provControlMode
      - refBw
      - subnetName
      type: object
      properties:
        minMuxPout:
          type: string
        docModClassFacility:
          $ref: '#/components/schemas/AutoSlat.DocModClassFacility'
        cmd8Slot:
          type: string
        cfgType:
          type: string
        cmd9Slot:
          type: string
        dscm2Slot:
          type: string
        limSlot:
          type: string
        dscm1Slot:
          type: string
        cmd7Slot:
          type: string
        dscm4Slot:
          type: string
        cmd5Slot:
          type: string
        ampMate:
          type: string
        dwid:
          type: string
        oscSlotPort:
          type: string
        derived:
          type: string
        csInd:
          type: string
        subType:
          type: string
        cmd6Slot:
          type: string
        cmd2Slot:
          type: string
        cmd4Slot:
          type: string
        cmd1Slot:
          type: string
        bmdSlot:
          type: string
        dropLimSlot:
          type: string
        autoRoute:
          type: string
        cmd3Slot:
          type: string
        casLimSlot:
          type: string
        osid:
          type: string
        otsInstance:
          type: string
        dscm3Slot:
          type: string
        wssSlot:
          type: string
        txPath:
          type: string
        smdSlot:
          type: string
        provAssociatedOts:
          type: string
        isDocSite:
          type: string
        planningStatus:
          type: string
        provControlMode:
          type: string
        refBw:
          type: string
        subnetName:
          type: string
        cps:
          type: string
    AutoSlat.DCnComms:
      title: AutoSlat.DCnComms
      required:
      - slot
      - dcnIPV4
      - dcnNetMaskV4
      - shelf
      - dcnDefaultGatewayV4
      - staticRtIPV4
      - port
      type: object
      properties:
        slot:
          type: string
        dcnIPV4:
          type: string
        dcnNetMaskV4:
          type: string
        shelf:
          type: string
        dcnDefaultGatewayV4:
          type: string
        staticRtIPV4:
          type: string
        port:
          type: string
    AutoSlat.ShelfAttrs:
      title: AutoSlat.ShelfAttrs
      required:
      - function
      - provShelfPowerLimit
      - physicalShelfNumber
      - logicalShelfNumber
      - shelfType
      - siteGroup
      - csControl
      - primaryShelf
      - tidConsolidationEnabled
      - neMode
      - frameIdentificationCode
      - bayNumber
      - planningStatus
      type: object
      properties:
        function:
          type: string
        provShelfPowerLimit:
          type: string
        physicalShelfNumber:
          type: string
        logicalShelfNumber:
          type: string
        shelfType:
          type: string
        siteGroup:
          type: string
        csControl:
          type: string
        primaryShelf:
          type: string
        tidConsolidationEnabled:
          type: string
        neMode:
          type: string
        frameIdentificationCode:
          type: string
        bayNumber:
          type: string
        planningStatus:
          type: string
        groupId:
          type: string
        siteId:
          type: string
        siteName:
          type: string
        groupName:
          type: string
        memberId:
          type: string
        memberName:
          type: string
        hostName:
          type: string
    AutoSlat.Card:
      title: AutoSlat.Card
      required:
      - slot
      - shelf
      - subSlot
      type: object
      properties:
        slot:
          type: string
        shelf:
          type: string
        subSlot:
          type: string
    AutoSlat.AddSequence:
      title: AutoSlat.AddSequence
      required:
      - card
      type: object
      properties:
        card:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Card'
          description: ''
    AutoSlat.DropSequence:
      title: AutoSlat.DropSequence
      required:
      - card
      type: object
      properties:
        card:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Card'
          description: ''
    AutoSlat.SlotSequence:
      title: AutoSlat.SlotSequence
      required:
      - anchorPort
      - anchorSlot
      - addSequence
      - ots
      - dropSequence
      - id
      type: object
      properties:
        anchorPort:
          type: string
        anchorSlot:
          type: string
        addSequence:
          $ref: '#/components/schemas/AutoSlat.AddSequence'
        ots:
          type: string
        dropSequence:
          $ref: '#/components/schemas/AutoSlat.DropSequence'
        id:
          type: string
    AutoSlat.PfgNeighbor:
      title: AutoSlat.PfgNeighbor
      required:
      - name
      type: object
      properties:
        name:
          type: string
        node:
          type: string
        type:
          type: string
    AutoSlat.PfgAttr:
      title: AutoSlat.PfgAttr
      required:
      - name
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    AutoSlat.PfgConfig:
      title: AutoSlat.PfgConfig
      type: object
      properties:
        type:
          type: string
        dgff:
          type: string
        attr:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgAttr'
          description: ''
    AutoSlat.PfgObject:
      title: AutoSlat.PfgObject
      required:
      - role
      type: object
      properties:
        role:
          type: string
        slot:
          type: string
        config:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgConfig'
          description: ''
    AutoSlat.PfgFrequency:
      title: AutoSlat.PfgFrequency
      required:
      - role
      type: object
      properties:
        role:
          type: string
        minFreq:
          type: string
        maxFreq:
          type: string
    AutoSlat.Pfg:
      title: AutoSlat.Pfg
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        lineIn:
          type: string
        lineInPort:
          type: string
        lineInOsc:
          type: string
        lineInOscPort:
          type: string
        lineOut:
          type: string
        lineOutPort:
          type: string
        lineOutOsc:
          type: string
        lineOutOscPort:
          type: string
        partnerPfg:
          type: string
        neighborPfg:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgNeighbor'
          description: ''
        amp:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgObject'
          description: ''
        wss:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgObject'
          description: ''
        voa:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgObject'
          description: ''
        dgff:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgObject'
          description: ''
        oscPfib:
          type: string
        oscTxPower:
          type: string
        frequency:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.PfgFrequency'
          description: ''
        planningStatus:
          type: string
        commonIn:
          type: string
        commonInPort:
          type: string
        commonOut:
          type: string
        commonOutPort:
          type: string
    AutoSlat.LicenseObject:
      title: AutoSlat.LicenseObject
      type: object
      properties:
        feature:
          type: string
        enabled:
          type: string
    AutoSlat.Shelf:
      title: AutoSlat.Shelf
      required:
      - shelfIP
      - equipment
      - shelfAttrs
      type: object
      properties:
        shelfIP:
          $ref: '#/components/schemas/AutoSlat.ShelfIP'
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Equipment'
          description: ''
        gne:
          $ref: '#/components/schemas/AutoSlat.Gne'
        ots:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.OTS'
          description: ''
        dcnComms:
          $ref: '#/components/schemas/AutoSlat.DCnComms'
        shelfAttrs:
          $ref: '#/components/schemas/AutoSlat.ShelfAttrs'
        slotSequence:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.SlotSequence'
          description: ''
        pfg:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Pfg'
          description: ''
        license:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.LicenseObject'
          description: ''
    AutoSlat.EthDefaults:
      title: AutoSlat.EthDefaults
      required:
      - ETHGFPRFIUPI
      - CSFMCASTMAC
      - ETH10GMAPPING
      - ETHGFPRFI
      type: object
      properties:
        ETHGFPRFIUPI:
          type: string
        CSFMCASTMAC:
          type: string
        ETH10GMAPPING:
          type: string
        ETHGFPRFI:
          type: string
    AutoSlat.GCCDefaults:
      title: AutoSlat.GCCDefaults
      required:
      - gcc0Mode
      - gcc1Mode
      type: object
      properties:
        gcc0Mode:
          type: string
        gcc1Mode:
          type: string
    AutoSlat.EqptDefaults:
      title: AutoSlat.EqptDefaults
      required:
      - airFilterReplacementTimer
      - enhEqptMgmt
      - autoEquipping
      - minCooling
      - airFilterReplacementAlarm
      type: object
      properties:
        airFilterReplacementTimer:
          type: string
        enhEqptMgmt:
          type: string
        autoEquipping:
          type: string
        minCooling:
          type: string
        airFilterReplacementAlarm:
          type: string
    AutoSlat.Photonic:
      title: AutoSlat.Photonic
      required:
      - LASEROFFFARENDFAIL
      - fiberLossDetection
      - siteName
      - alarmCorrelation
      - siteId
      - csControl
      - oscMode
      - autoRoute
      - controlModeDefault
      - mcDeadband
      type: object
      properties:
        LASEROFFFARENDFAIL:
          type: string
        fiberLossDetection:
          type: string
        siteName:
          type: string
        alarmCorrelation:
          type: string
        siteId:
          type: string
        csControl:
          type: string
        oscMode:
          type: string
        autoRoute:
          type: string
        controlModeDefault:
          type: string
        mcDeadband:
          type: string
    AutoSlat.GenDefaults:
      title: AutoSlat.GenDefaults
      required:
      - subnetName
      - autoProvFac
      - shelfSync
      - bayFICinAO
      - bitsMode
      type: object
      properties:
        subnetName:
          type: string
        autoProvFac:
          type: string
        shelfSync:
          type: string
        bayFICinAO:
          type: string
        bitsMode:
          type: string
    AutoSlat.AlarmDefaults:
      title: AutoSlat.AlarmDefaults
      required:
      - ainsTimeout
      - alarmHoldoff
      - alarminfo
      - tcaSuppression
      type: object
      properties:
        ainsTimeout:
          type: string
        alarmHoldoff:
          type: string
        alarminfo:
          type: string
        tcaSuppression:
          type: string
    AutoSlat.DWDMLine:
      title: AutoSlat.DWDMLine
      required:
      - lineFlappingRaiseTime
      - lineFlappingClearTime
      - lineFlappingThreshold
      - lineFlappingAlarm
      type: object
      properties:
        lineFlappingRaiseTime:
          type: string
        lineFlappingClearTime:
          type: string
        lineFlappingThreshold:
          type: string
        lineFlappingAlarm:
          type: string
    AutoSlat.MSPPDefaults:
      title: AutoSlat.MSPPDefaults
      required:
      - NDPMode
      - PTHAISINSERT
      - PATHSDTH
      - LINEPEVSTAT
      - PATHSWCRIT
      - PATHPEVSTAT
      - PATHEBERTH
      type: object
      properties:
        NDPMode:
          type: string
        PTHAISINSERT:
          type: string
        PATHSDTH:
          type: string
        LINEPEVSTAT:
          type: string
        PATHSWCRIT:
          type: string
        PATHPEVSTAT:
          type: string
        PATHEBERTH:
          type: string
    AutoSlat.Defaults:
      title: AutoSlat.Defaults
      required:
      - ethDefaults
      - gccDefaults
      - eqptDefaults
      - photonic
      - genDefaults
      - alarmDefaults
      - dwdmLine
      - msppDefaults
      type: object
      properties:
        ethDefaults:
          $ref: '#/components/schemas/AutoSlat.EthDefaults'
        gccDefaults:
          $ref: '#/components/schemas/AutoSlat.GCCDefaults'
        eqptDefaults:
          $ref: '#/components/schemas/AutoSlat.EqptDefaults'
        photonic:
          $ref: '#/components/schemas/AutoSlat.Photonic'
        genDefaults:
          $ref: '#/components/schemas/AutoSlat.GenDefaults'
        alarmDefaults:
          $ref: '#/components/schemas/AutoSlat.AlarmDefaults'
        dwdmLine:
          $ref: '#/components/schemas/AutoSlat.DWDMLine'
        msppDefaults:
          $ref: '#/components/schemas/AutoSlat.MSPPDefaults'
    AutoSlat.TidSlotSequence:
      title: AutoSlat.TidSlotSequence
      required:
      - anchorPort
      - anchorSlot
      - addSequence
      - dropSequence
      type: object
      properties:
        anchorPort:
          type: string
        anchorSlot:
          type: string
        anchorShelf:
          type: string
        addSequence:
          $ref: '#/components/schemas/AutoSlat.AddSequence'
        ots:
          type: string
        dropSequence:
          $ref: '#/components/schemas/AutoSlat.DropSequence'
    AutoSlat.OsrpLine:
      title: AutoSlat.OsrpLine
      required:
      - name
      - nodeID
      - size
      - payloadType
      - muxPayload
      - protection
      - label
      - farEndAid
      type: object
      properties:
        name:
          type: string
        nodeID:
          type: string
        size:
          type: string
        payloadType:
          type: string
        muxPayload:
          type: string
        protection:
          type: string
        label:
          type: string
        farEndAid:
          type: string
    AutoSlat.OsrpLink:
      title: AutoSlat.OsrpLink
      required:
      - name
      - nodeID
      - linkIdAb
      - linkIdBa
      - adminWtAb
      - adminWtBa
      - latencyAb
      - latencyBa
      - channel
      - totalBw
      - standard
      - status
      - bundleId
      - label
      - farEndAid
      - osrpLine
      type: object
      properties:
        name:
          type: string
        nodeID:
          type: string
        linkIdAb:
          type: string
        linkIdBa:
          type: string
        adminWtAb:
          type: string
        adminWtBa:
          type: string
        latencyAb:
          type: string
        latencyBa:
          type: string
        channel:
          type: string
        totalBw:
          type: string
        standard:
          type: string
        status:
          type: string
        bundleId:
          type: string
        label:
          type: string
        farEndAid:
          type: string
        osrpLine:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.OsrpLine'
          description: ''
    AutoSlat.NeighborNode:
      title: AutoSlat.NeighborNode
      required:
      - shelfName
      type: object
      properties:
        shelfName:
          type: string
        ipAddress:
          type: string
    AutoSlat.Node:
      title: AutoSlat.Node
      required:
      - nodeFunction
      - product
      - clli
      - name
      - shelf
      - nodeID
      - location
      - release
      type: object
      properties:
        nodeFunction:
          $ref: '#/components/schemas/AutoSlat.NodeFunction'
        product:
          type: string
        clli:
          type: string
        ncId:
          type: string
        name:
          type: string
        link:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Link'
          description: ''
        connectionValidation:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.ConnectionValidation'
          description: ''
        fiberProfile:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.FiberProfile'
          description: ''
        otdr:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.OTDR'
          description: ''
        shelf:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Shelf'
          description: ''
        nodeID:
          type: string
        location:
          type: string
        latitude:
          type: string
        longitude:
          type: string
        defaults:
          $ref: '#/components/schemas/AutoSlat.Defaults'
        tidSlotSequence:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.TidSlotSequence'
          description: ''
        release:
          type: string
        osrpNodeName:
          type: string
        osrpNodeId:
          type: string
        cpMode:
          type: string
        osrpLink:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.OsrpLink'
          description: ''
        neighborNode:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.NeighborNode'
          description: ''
    AutoSlat.FileData:
      title: AutoSlat.FileData
      required:
      - applicationName
      - timestamp
      - applicationVersion
      - applicationBuildNumber
      type: object
      properties:
        applicationName:
          type: string
        timestamp:
          type: string
        applicationVersion:
          type: string
        applicationBuildNumber:
          type: string
    AutoSlat.Network:
      title: AutoSlat.Network
      required:
      - node
      - fileData
      type: object
      properties:
        node:
          type: array
          items:
            $ref: '#/components/schemas/AutoSlat.Node'
          description: ''
        fileData:
          $ref: '#/components/schemas/AutoSlat.FileData'
    EquipmentSummary.KitToOinMappingItem:
      title: EquipmentSummary.KitToOinMappingItem
      required:
      - kitName
      - oin
      type: object
      properties:
        kitName:
          type: string
        oin:
          type: string
        enabled:
          type: boolean
        comments:
          type: string
    EquipmentSummary.KitToOinMapping:
      title: EquipmentSummary.KitToOinMapping
      required:
      - kitToOinMapping
      type: object
      properties:
        kitToOinMapping:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentSummary.KitToOinMappingItem'
          description: ''
    Common.ErrorList:
      title: Common.ErrorList
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Common.Error'
          description: ''
    Common.Identifier:
      title: Common.Identifier
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    Common.NodeIdentity:
      title: Common.NodeIdentity
      type: object
      properties:
        clli:
          type: string
        nodeId:
          type: integer
          format: int64
        tid:
          type: string
        ncId:
          type: string
    Common.EquipmentSpec:
      title: Common.EquipmentSpec
      required:
      - partNumber
      type: object
      properties:
        partNumber:
          type: string
        description:
          type: string
        aidType:
          type: string
        mfgDate:
          type: string
    Equipment.Cmd:
      title: Equipment.Cmd
      required:
      - equipmentSpec
      - addDropBankId
      - totalCount
      type: object
      properties:
        equipmentSpec:
          $ref: '#/components/schemas/Common.EquipmentSpec'
        addDropBankId:
          type: integer
          format: int64
        totalCount:
          type: integer
          format: int64
    Common.AddDropBank:
      title: Common.AddDropBank
      required:
      - addDropBankId
      type: object
      properties:
        addDropBankId:
          type: integer
          format: int64
        totalCmdCount:
          type: integer
          format: int64
    LocationMgmtAccessTypes:
      title: LocationMgmtAccessTypes
      enum:
      - TL1_ACCESS
      - SAOS_ACCESS
      - CORBA_ACCESS
      type: string
    LocationAddressKeyTypes:
      title: LocationAddressKeyTypes
      enum:
      - RACK
      - SHELF
      - PHYSICAL_SHELF
      - SLOT
      - SUBSLOT
      - SUBSUBSLOT
      - PORT
      - SUBPORT
      type: string
    Common.LocationAddress:
      title: Common.LocationAddress
      required:
      - key
      - value
      type: object
      properties:
        key:
          $ref: '#/components/schemas/LocationAddressKeyTypes'
        value:
          type: string
        pattern:
          type: string
    Common.Location:
      title: Common.Location
      required:
      - mgmtAccess
      - address
      type: object
      properties:
        mgmtAccess:
          $ref: '#/components/schemas/LocationMgmtAccessTypes'
        address:
          type: array
          items:
            $ref: '#/components/schemas/Common.LocationAddress'
          description: ''
    Common.Pluggable:
      title: Common.Pluggable
      required:
      - equipmentSpec
      - location
      type: object
      properties:
        equipmentSpec:
          $ref: '#/components/schemas/Common.EquipmentSpec'
        location:
          $ref: '#/components/schemas/Common.Location'
        customerCode:
          type: string
    EquipmentEquipmentStateTypes:
      title: EquipmentEquipmentStateTypes
      enum:
      - SPARE
      - MAINTENANCESPARE
      - INSERVICE
      - OUTOFSERVICE
      - RESERVED
      type: string
    Common.LinePortConnection:
      title: Common.LinePortConnection
      required:
      - linePortId
      - photonicNodeIdentity
      - photonicPortLocation
      type: object
      properties:
        linePortId:
          type: integer
          format: int64
        photonicNodeIdentity:
          $ref: '#/components/schemas/Common.NodeIdentity'
        photonicPortLocation:
          $ref: '#/components/schemas/Common.Location'
    Common.LinePortConnections:
      title: Common.LinePortConnections
      required:
      - linePortConnections
      type: object
      properties:
        linePortConnections:
          type: array
          items:
            $ref: '#/components/schemas/Common.LinePortConnection'
          description: ''
    EquipmentKeyValuePairKeyTypes:
      title: EquipmentKeyValuePairKeyTypes
      enum:
      - ADDDROPBANK
      - TOTALCMDCOUNT
      - MATELINECARDSLOT
      - MATELINECARDPARTNUMBER
      - ADDDROPBANK1
      - ADDDROPBANK2
      type: string
    Common.EquipmentKeyValuePair:
      title: Common.EquipmentKeyValuePair
      required:
      - key
      - value
      type: object
      properties:
        key:
          $ref: '#/components/schemas/EquipmentKeyValuePairKeyTypes'
        value:
          type: string
    Common.Equipment:
      title: Common.Equipment
      required:
      - equipmentSpec
      type: object
      properties:
        equipmentSpec:
          $ref: '#/components/schemas/Common.EquipmentSpec'
        equipmentProfile:
          type: string
        location:
          $ref: '#/components/schemas/Common.Location'
        customerCode:
          type: string
        pluggables:
          type: array
          items:
            $ref: '#/components/schemas/Common.Pluggable'
          description: ''
        equipmentState:
          $ref: '#/components/schemas/EquipmentEquipmentStateTypes'
        serviceIdentifier:
          type: string
        lineSideConnection:
          $ref: '#/components/schemas/Common.Location'
        linePortConnections:
          $ref: '#/components/schemas/Common.LinePortConnections'
        maintenanceSpare:
          type: boolean
        regen:
          type: boolean
        additionalAttributes:
          type: array
          items:
            $ref: '#/components/schemas/Common.EquipmentKeyValuePair'
          description: ''
    Equipment.TerminationEquipmentGroup:
      title: Equipment.TerminationEquipmentGroup
      required:
      - equipments
      type: object
      properties:
        equipments:
          type: array
          items:
            $ref: '#/components/schemas/Common.Equipment'
          description: ''
        regen:
          type: boolean
    Common.Bay:
      title: Common.Bay
      required:
      - bayId
      type: object
      properties:
        bayId:
          type: integer
          format: int64
    Common.NodeAttributes:
      title: Common.NodeAttributes
      required:
      - siteId
      type: object
      properties:
        siteId:
          type: integer
          format: int64
        groupId:
          type: integer
          format: int64
        memberId:
          type: integer
          format: int64
        siteName:
          type: string
    Common.Chassis:
      title: Common.Chassis
      required:
      - equipmentSpec
      - location
      - nodeAttributes
      type: object
      properties:
        equipmentSpec:
          $ref: '#/components/schemas/Common.EquipmentSpec'
        location:
          $ref: '#/components/schemas/Common.Location'
        nodeAttributes:
          $ref: '#/components/schemas/Common.NodeAttributes'
    Equipment.CommonEquipment:
      title: Equipment.CommonEquipment
      required:
      - pec
      type: object
      properties:
        pec:
          type: string
        slot:
          type: integer
          format: int64
        subSlot:
          type: integer
          format: int64
    Equipment.Shelf:
      title: Equipment.Shelf
      required:
      - siteId
      - photonicNodeIdentity
      - shelfNumber
      - shelfPec
      - shelfRelease
      - shelfIntent
      - shelfType
      - commonEquipment
      type: object
      properties:
        siteId:
          type: integer
          format: int64
        photonicNodeIdentity:
          $ref: '#/components/schemas/Common.NodeIdentity'
        shelfNumber:
          type: integer
          format: int64
        shelfPec:
          type: string
        shelfRelease:
          type: string
        shelfIntent:
          type: string
        shelfType:
          type: string
        siteGroup:
          type: string
        location:
          type: string
        groupId:
          type: string
        memberId:
          type: string
        commonEquipment:
          type: array
          items:
            $ref: '#/components/schemas/Equipment.CommonEquipment'
          description: ''
    Equipment.EquipmentAddition:
      title: Equipment.EquipmentAddition
      required:
      - nodeIdentity
      type: object
      properties:
        nodeIdentity:
          $ref: '#/components/schemas/Common.NodeIdentity'
        cmds:
          type: array
          items:
            $ref: '#/components/schemas/Equipment.Cmd'
          description: ''
        addDropBanks:
          type: array
          items:
            $ref: '#/components/schemas/Common.AddDropBank'
          description: ''
        terminationEquipmentGroups:
          type: array
          items:
            $ref: '#/components/schemas/Equipment.TerminationEquipmentGroup'
          description: ''
        pluggables:
          type: array
          items:
            $ref: '#/components/schemas/Common.Pluggable'
          description: ''
        transponderBays:
          type: array
          items:
            $ref: '#/components/schemas/Common.Bay'
          description: ''
        Chassis:
          type: array
          items:
            $ref: '#/components/schemas/Common.Chassis'
          description: ''
        shelves:
          type: array
          items:
            $ref: '#/components/schemas/Equipment.Shelf'
          description: ''
    Equipment.AddEquipmentRequest:
      title: Equipment.AddEquipmentRequest
      required:
      - project
      - equipmentAdditions
      type: object
      properties:
        project:
          $ref: '#/components/schemas/Common.Identifier'
        projectList:
          $ref: '#/components/schemas/Common.Identifier'
        equipmentAdditions:
          type: array
          items:
            $ref: '#/components/schemas/Equipment.EquipmentAddition'
          description: ''
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
    HeatDissipationThresholdStatusStatusTypes:
      title: HeatDissipationThresholdStatusStatusTypes
      enum:
      - Ok
      - Warning
      - Exceeded
      type: string
    V1.ProposedLineEquipment:
      title: V1.ProposedLineEquipment
      type: object
      properties:
        Slot:
          type: string
        Shelf:
          type: string
        Tid:
          type: string
        Port:
          type: string
    Common.EndpointLocation:
      title: Common.EndpointLocation
      required:
      - nodeIdentity
      type: object
      properties:
        nodeIdentity:
          $ref: '#/components/schemas/Common.NodeIdentity'
        location:
          $ref: '#/components/schemas/Common.Location'
        proposedLineEquipment:
          $ref: '#/components/schemas/V1.ProposedLineEquipment'
    HeatDissipationThresholdPolicy.HeatDissipationThreshold:
      title: HeatDissipationThresholdPolicy.HeatDissipationThreshold
      type: object
      properties:
        warningThreshold:
          type: string
        blockingThreshold:
          type: string
    BayHeatDissipationThresholdTypeTypes:
      title: BayHeatDissipationThresholdTypeTypes
      enum:
      - Global
      - Site
      - Bay
      type: string
    HeatDissipationThresholdPolicy.BayHeatDissipation:
      title: HeatDissipationThresholdPolicy.BayHeatDissipation
      required:
      - bay
      - calculatedHeatDissipation
      - heatDissipationThreshold
      - thresholdType
      type: object
      properties:
        bay:
          $ref: '#/components/schemas/Common.EndpointLocation'
        calculatedHeatDissipation:
          type: integer
          format: int64
        heatDissipationThreshold:
          $ref: '#/components/schemas/HeatDissipationThresholdPolicy.HeatDissipationThreshold'
        thresholdType:
          $ref: '#/components/schemas/BayHeatDissipationThresholdTypeTypes'
    HeatDissipationThresholdPolicy.UnslottedEquipmentHeatDissipation:
      title: HeatDissipationThresholdPolicy.UnslottedEquipmentHeatDissipation
      required:
      - pec
      - power
      - isSpare
      type: object
      properties:
        pec:
          type: string
        power:
          type: integer
          format: int64
        isSpare:
          type: boolean
    HeatDissipationThresholdPolicy.UnslottedEquipmentGroup:
      title: HeatDissipationThresholdPolicy.UnslottedEquipmentGroup
      required:
      - unslottedEquipmentHeatDissipation
      type: object
      properties:
        unslottedEquipmentHeatDissipation:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationThresholdPolicy.UnslottedEquipmentHeatDissipation'
          description: ''
    Common.HeatDissipationThresholdStatus:
      title: Common.HeatDissipationThresholdStatus
      required:
      - status
      type: object
      properties:
        status:
          $ref: '#/components/schemas/HeatDissipationThresholdStatusStatusTypes'
        warningThreshold:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationThresholdPolicy.BayHeatDissipation'
          description: ''
        blockingThreshold:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationThresholdPolicy.BayHeatDissipation'
          description: ''
        unslottedEquipmentGroups:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationThresholdPolicy.UnslottedEquipmentGroup'
          description: ''
    Equipment.EquipmentResponse:
      title: Equipment.EquipmentResponse
      required:
      - heatDissipationThresholdStatus
      type: object
      properties:
        heatDissipationThresholdStatus:
          $ref: '#/components/schemas/Common.HeatDissipationThresholdStatus'
    Common.Source:
      title: Common.Source
      type: object
      properties:
        project:
          $ref: '#/components/schemas/Common.Identifier'
        projectList:
          $ref: '#/components/schemas/Common.Identifier'
    Common.GeoLocation:
      title: Common.GeoLocation
      required:
      - latitude
      - longitude
      type: object
      properties:
        latitude:
          type: number
        longitude:
          type: number
    NodeNodeTypeTypes:
      title: NodeNodeTypeTypes
      enum:
      - ILA
      - LGX
      - ROADM
      - ROADMSMALL
      - ROADMLARGE
      - SPLICEPOINT
      - DGE
      - ROADMETSI
      type: string
    NodeAmplifierConfigurationTypeTypes:
      title: NodeAmplifierConfigurationTypeTypes
      enum:
      - Unsupported
      - NoAmp
      - SingleAmp
      - DualAmps
      - SingleCascadedAmps_Aend
      - SingleCascadedAmps_Zend
      - DualCascadedAmps
      - DualSra
      - Sra_Aend
      - Sra_Zend
      - SraCascadedAmps_Aend
      - SraCascadedAmps_Zend
      type: string
    Common.Node:
      title: Common.Node
      required:
      - nodeIdentity
      - nodeType
      type: object
      properties:
        nodeIdentity:
          $ref: '#/components/schemas/Common.NodeIdentity'
        geoLocation:
          $ref: '#/components/schemas/Common.GeoLocation'
        nodeType:
          $ref: '#/components/schemas/NodeNodeTypeTypes'
        amplifierConfigurationType:
          $ref: '#/components/schemas/NodeAmplifierConfigurationTypeTypes'
    EquipmentSummary.EquipmentKit:
      title: EquipmentSummary.EquipmentKit
      required:
      - equipmentKitId
      type: object
      properties:
        equipmentKitId:
          type: string
        oin:
          type: string
        shelves:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/Common.LocationAddress'
        maintenanceSpare:
          type: boolean
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/Common.Equipment'
          description: ''
    EquipmentSummary.NodalEquipmentKitSummary:
      title: EquipmentSummary.NodalEquipmentKitSummary
      required:
      - node
      - equipmentKits
      type: object
      properties:
        node:
          $ref: '#/components/schemas/Common.Node'
        equipmentKits:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentSummary.EquipmentKit'
          description: ''
    EquipmentSummary.EquipmentSummaryResponse:
      title: EquipmentSummary.EquipmentSummaryResponse
      required:
      - source
      - equipmentSummary
      type: object
      properties:
        source:
          $ref: '#/components/schemas/Common.Source'
        equipmentSummary:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentSummary.NodalEquipmentKitSummary'
          description: ''
    EquipmentSummary.EquipmentSummaryResponseOrganizedByProject:
      title: EquipmentSummary.EquipmentSummaryResponseOrganizedByProject
      required:
      - projectEquipmentSummary
      type: object
      properties:
        source:
          $ref: '#/components/schemas/Common.Source'
        projectEquipmentSummary:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentSummary.EquipmentSummaryResponse'
          description: ''
    FiberFiberTypeTypes:
      title: FiberFiberTypeTypes
      enum:
      - NDSF
      - ELEAF
      - LEAF
      - TWRS
      - TWPLUS
      - TWC
      - DSF
      - LS
      - OTHER
      - TERA
      - TWREACH
      - PSC
      - NDSF_LWP
      - EX2000
      - EX3000
      - TERAWAVE_ULL
      type: string
    FiberFiberOrlTypes:
      title: FiberFiberOrlTypes
      enum:
      - NOT_YET_SPECIFIED
      - STANDARD
      - BAD
      type: string
    FiberRoute.Fiber:
      title: FiberRoute.Fiber
      required:
      - number
      - fiberType
      type: object
      properties:
        name:
          type: string
        number:
          type: integer
          format: int64
        fiberType:
          $ref: '#/components/schemas/FiberFiberTypeTypes'
        lossDb:
          type: number
        pmdMean:
          type: number
        fiberOrl:
          $ref: '#/components/schemas/FiberFiberOrlTypes'
        specialMaintenanceMarginDb:
          type: number
    FiberRoute.FiberPair:
      title: FiberRoute.FiberPair
      required:
      - aEndNode
      - zEndNode
      - cableId
      - aTozFiber
      - zToaFiber
      type: object
      properties:
        aEndNode:
          $ref: '#/components/schemas/Common.NodeIdentity'
        zEndNode:
          $ref: '#/components/schemas/Common.NodeIdentity'
        cableId:
          type: string
        lengthKm:
          type: number
        aTozFiber:
          $ref: '#/components/schemas/FiberRoute.Fiber'
        zToaFiber:
          $ref: '#/components/schemas/FiberRoute.Fiber'
    Common.EndPointAttributes:
      title: Common.EndPointAttributes
      type: object
      properties:
        directionId:
          type: integer
          format: int64
        shelf:
          type: integer
          format: int64
        totalNumberOfCmds:
          type: integer
          format: int64
    FiberRoute.SectionFacilityPair:
      title: FiberRoute.SectionFacilityPair
      required:
      - facilityAtoZ
      - facilityZtoA
      type: object
      properties:
        facilityAtoZ:
          type: string
        facilityZtoA:
          type: string
    FiberRoute.Section:
      title: FiberRoute.Section
      required:
      - fiberPairs
      - aEndPointAttributes
      - zEndPointAttributes
      - facilities
      type: object
      properties:
        fiberPairs:
          type: array
          items:
            $ref: '#/components/schemas/FiberRoute.FiberPair'
          description: ''
        aEndPointAttributes:
          $ref: '#/components/schemas/Common.EndPointAttributes'
        zEndPointAttributes:
          $ref: '#/components/schemas/Common.EndPointAttributes'
        facilities:
          $ref: '#/components/schemas/FiberRoute.SectionFacilityPair'
    FiberRoute.AdditionalEquipmentConfiguration:
      title: FiberRoute.AdditionalEquipmentConfiguration
      required:
      - nodeIdentity
      type: object
      properties:
        nodeIdentity:
          $ref: '#/components/schemas/Common.NodeIdentity'
        transponderBays:
          type: array
          items:
            $ref: '#/components/schemas/Common.Bay'
          description: ''
    FiberRoute.AddFiberRouteRequest:
      title: FiberRoute.AddFiberRouteRequest
      required:
      - project
      - sections
      - nodes
      type: object
      properties:
        project:
          $ref: '#/components/schemas/Common.Identifier'
        sections:
          type: array
          items:
            $ref: '#/components/schemas/FiberRoute.Section'
          description: ''
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Common.Node'
          description: ''
        additionalEquipmentConfiguration:
          type: array
          items:
            $ref: '#/components/schemas/FiberRoute.AdditionalEquipmentConfiguration'
          description: ''
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
    FiberRoute.FiberRouteDelta:
      title: FiberRoute.FiberRouteDelta
      type: object
      properties:
        addedNodes:
          type: array
          items:
            $ref: '#/components/schemas/Common.NodeIdentity'
          description: ''
        removedNodes:
          type: array
          items:
            $ref: '#/components/schemas/Common.NodeIdentity'
          description: ''
        addedFibers:
          type: array
          items:
            $ref: '#/components/schemas/FiberRoute.FiberPair'
          description: ''
        removedFibers:
          type: array
          items:
            $ref: '#/components/schemas/FiberRoute.FiberPair'
          description: ''
    GlobalConfigurationData.KeyValue:
      title: GlobalConfigurationData.KeyValue
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    GlobalConfigurationData.ConfigurationData:
      title: GlobalConfigurationData.ConfigurationData
      type: object
      properties:
        configurationData:
          type: array
          items:
            $ref: '#/components/schemas/GlobalConfigurationData.KeyValue'
          description: ''
    Logging.Severity:
      title: Logging.Severity
      enum:
      - _Critical
      - _Error
      - _Warning
      - _Verbose
      - _Information
      type: string
    Logging.Error:
      title: Logging.Error
      type: object
      properties:
        Severity:
          $ref: '#/components/schemas/Logging.Severity'
        Message:
          type: string
          readOnly: true
    Model.GlobalConfigurationData:
      title: Model.GlobalConfigurationData
      type: object
      properties:
        Key:
          type: string
          description: Gets or sets the Key
        Value:
          type: string
          description: Gets or sets the Value
      description: Provides a Global table to store configuration data in key value pair
    HeatDissipationReport.ShelfHeatDissipation:
      title: HeatDissipationReport.ShelfHeatDissipation
      required:
      - physicalShelf
      - calculatedHeatDissipationInWatts
      type: object
      properties:
        physicalShelf:
          type: integer
          format: int64
        calculatedHeatDissipationInWatts:
          type: integer
          format: int64
    RackHeatDissipationReportHeatDissipationThresholdCrossedTypes:
      title: RackHeatDissipationReportHeatDissipationThresholdCrossedTypes
      enum:
      - warning
      - blocking
      type: string
    RackHeatDissipationReportThresholdTypeTypes:
      title: RackHeatDissipationReportThresholdTypeTypes
      enum:
      - Global
      - Site
      - Rack
      - NotSet
      type: string
    HeatDissipationReport.RackHeatDissipationReport:
      title: HeatDissipationReport.RackHeatDissipationReport
      required:
      - rack
      - calculatedHeatDissipationInWatts
      - perShelfHeatDissipation
      - thresholdType
      type: object
      properties:
        rack:
          $ref: '#/components/schemas/Common.Location'
        calculatedHeatDissipationInWatts:
          type: integer
          format: int64
        perShelfHeatDissipation:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationReport.ShelfHeatDissipation'
          description: ''
        heatDissipationThresholdCrossed:
          $ref: '#/components/schemas/RackHeatDissipationReportHeatDissipationThresholdCrossedTypes'
        heatDissipationThreshold:
          $ref: '#/components/schemas/HeatDissipationThresholdPolicy.HeatDissipationThreshold'
        thresholdType:
          $ref: '#/components/schemas/RackHeatDissipationReportThresholdTypeTypes'
    HeatDissipationReport.TidHeatDissipationReport:
      title: HeatDissipationReport.TidHeatDissipationReport
      required:
      - nodeIdentity
      - racks
      type: object
      properties:
        nodeIdentity:
          $ref: '#/components/schemas/Common.NodeIdentity'
        racks:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationReport.RackHeatDissipationReport'
          description: ''
    HeatDissipationReport.SiteHeatDissipationReport:
      title: HeatDissipationReport.SiteHeatDissipationReport
      required:
      - name
      - tids
      type: object
      properties:
        name:
          type: string
        tids:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationReport.TidHeatDissipationReport'
          description: ''
    HeatDissipationReport.HeatDissipationReport:
      title: HeatDissipationReport.HeatDissipationReport
      required:
      - sites
      type: object
      properties:
        sites:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationReport.SiteHeatDissipationReport'
          description: ''
    FiberDataTypeTypes:
      title: FiberDataTypeTypes
      enum:
      - fiber
      type: string
    FiberAttributesFiberOrlTypes:
      title: FiberAttributesFiberOrlTypes
      enum:
      - NOT_YET_SPECIFIED
      - STANDARD
      - BAD
      type: string
    PlannedData.FiberAttributes:
      title: PlannedData.FiberAttributes
      type: object
      properties:
        fiberOrl:
          $ref: '#/components/schemas/FiberAttributesFiberOrlTypes'
        fiberType:
          type: string
        fiberId:
          type: string
        freId:
          type: string
        headPPL:
          type: string
        lengthKm:
          type: string
        lossDb:
          type: string
        fiberLossReconciled:
          type: boolean
        margin:
          type: string
        pmdCoefficient:
          type: string
        specialMaintMargin:
          type: string
        tailPPL:
          type: string
        notes:
          type: string
        cableId:
          type: string
        fiberNumber:
          type: string
        startDate:
          type: string
        endDate:
          type: string
    PlannedData.FiberData:
      title: PlannedData.FiberData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/FiberDataTypeTypes'
        attributes:
          $ref: '#/components/schemas/PlannedData.FiberAttributes'
    PlannedData.FiberList:
      title: PlannedData.FiberList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlannedData.FiberData'
          description: ''
    Common.TerminationEquipmentType:
      title: Common.TerminationEquipmentType
      enum:
      - UNKNOWN
      - DT10GCMB
      - DT10GWT
      - DTREGEN
      - GENERIC_DWDM
      - LH_OC48
      - OM5000_2P5G_FLEX_OCLD
      - OM5000_2P5G_FLEX_OTR_1310
      - OM5000_2P5G_FLEX_OTR_850
      - OM5000_10G_MOTR_VCAT
      - OM5000_10G_OTR
      - OM5000_10G_OTR_LAN
      - OM5000_10G_ULTRA_OTR_RS8
      - OM5000_10G_ULTRA_OTR_SCFEC
      - OM5000_10G_ULTRA_OTR_LAN
      - OM5000_10G_ULTRA_OTR_FC1200
      - OM5000_10G_TUNABLE_OTR
      - OM5000_10G_MOTR
      - OM5000_10G_MOTR_XR
      - OM5000_10G_TUNABLE_MOTR
      - OM3500_10G
      - OM3500_2P5G
      - OME_10G_NGM
      - OME_10G_NGM2
      - OME_10GbE_NGM
      - OME_10G_OTU2
      - OME_2P5G
      - OME_OTR_10GE_LAN
      - OME_OTR_MULTI_SERVICE
      - OME_NGM_WT_SONET_SDH_REGIONAL
      - OME_NGM_WT_10GE_LAN_REGIONAL
      - OME_NGM_WT_OTU
      - OME_NGM_WT_OTU_REGIONAL
      - OMETOTSC10GSSWSCFEC
      - OMETOTSCOTU210G7SCFEC
      - OMESMUX10G7SCFEC
      - OMETDWDM10G7SCFECAM
      - OMETOTSC10GBE11G1SCFEC
      - OMEEDC40GOCLDEPMD
      - OM5KTOTR10GBE10G7
      - OM5KTMOTROTN10G7SCFEC
      - MERS10GEEMLXFP
      - OM5KOTRFC4004G
      - OM5KMOTRFCGBE2G5
      - OMEDWDM2X2G5SFP
      - OTHER_DWDM_1
      - OTHER_DWDM_2
      - OTHER_DWDM_3
      - OTHER_DWDM_4
      - OTHER_DWDM_5
      - OTHER_DWDM_6
      - OTHER_DWDM_7
      - OTHER_DWDM_8
      - OTHER_DWDM_9
      - OTHER_DWDM_10
      - OMEEDC40GOCLD
      - OMEEDC40GOCLDR
      - OMEEDC40GOCLDM
      - OMETOTSCFC120011G3SCFEC
      - XFPDWDM_NTK588AA_DV_10G7RS8
      - XFPDWDM_NTK588AA_DV_11G1RS8
      - OMEEDC40GOCLDHSRX
      - OMEEDC40GOCLDSUB
      - OMEEDC40GOCLDULH
      - OMEEDC40GOCLDULHSUB
      - OMEEDC100GOCLDEPMD
      - OMEEDC100GOCLD
      - OMEEDC100GOCLDR
      - OMEEDC100GOCLDM
      - OMEEDC100GOCLDSUB
      - OMEEDC10G7SUB
      - OMEEDC11G1SUB
      - XFPDWDM_NTK588AA_DV_10G7SCFEC
      - XFPDWDM_NTK588AA_DV_11G1SCFEC
      - XFPDWDM_NTK583AA_10G7RS8
      - XFPDWDM_NTK583AA_11G1RS8
      - XFPDWDM_NTK583AA_10G7SCFEC
      - XFPDWDM_NTK583AA_11G1SCFEC
      - XFPDWDM_NTK587EA_HU_10G7RS8
      - XFPDWDM_NTK587EA_HU_11G1RS8
      - XFPDWDM_NTK587AA_10G7RS8
      - XFPDWDM_NTK587AA_11G1RS8
      - CD5430_XFPDWDM_1609002900_10G7FEC6DB
      - CD5430_XFPDWDM_1609002900_10G7FEC8DB
      - EDC40GWVSELOCLDEPMDCLD
      - EDC40GWVSELOCLDCLD
      - EDC40GWVSELOCLDRCLD
      - EDC40GWVSELOCLDMCLD
      - OMEEDC40GOCLDCOLORLESSSUB
      - OMEEDC40GOCLDCOLORLESSMH
      - OMEEDC100GOCLDCOLORLESSEPMD
      - OMEEDC100GOCLDCOLORLESS
      - OMEEDC100GOCLDCOLORLESSR
      - OMEEDC100GOCLDCOLORLESSM
      - OMEEDC100GOCLDCOLORLESSSUB
      - OMEEDC100GOCLDCOLORLESSMH
      - SFPDWDM_NTK586AA_HW_2G7
      - XFPDWDM_NTK583AB_10G7RS8
      - XFPDWDM_NTK583AB_11G1RS8
      - XFPDWDM_NTK583AB_10G7SCFEC
      - XFPDWDM_NTK583AB_11G1SCFEC
      - XFPDWDM_NTK589_CBAND_10G7RS8
      - XFPDWDM_NTK589_CBAND_11G1RS8
      - XFPDWDM_NTK589_CBAND_10G7SCFEC
      - XFPDWDM_NTK589_CBAND_11G1SCFEC
      - EDC100GWL3OCLDMCLD
      - EDC100GWL3OCLDRCLD
      - EDC100GWL3OCLDECLD
      - EDC100GWL3OCLDLHCLD
      - EDC100GWL3OCLDPCLD
      - EDC100GWL3OCLDSUBCLD
      - TSLM_1_134_5468_900
      - TSLM_1_134_5468_901
      - TSLM_1_134_5468_903
      - OSLM_1_134_5466_900
      - OSLM_1_134_5466_901
      - OSLM_1_134_5466_903
      - EDC40GWVSELOCLDEPMDCLS
      - EDC40GWVSELOCLDCLS
      - EDC40GWVSELOCLDRCLS
      - EDC40GWVSELOCLDMCLS
      - EDC100GWL3OCLDMCLS
      - EDC100GWL3OCLDRCLS
      - EDC100GWL3OCLDECLS
      - EDC100GWL3OCLDLHCLS
      - EDC100GWL3OCLDPCLS
      - TSLM_1_134_5468_904
      - OSLM_1_134_5466_904
      - OSLM_1_134_5466_905
      - TSLM_1_134_5468_905
      - OSLM_1_134_5466_904CLS
      - TSLM_1_134_5468_904CLS
      - OSLM_1_134_5466_900CLS
      - TSLM_1_134_5468_900CLS
      - OSLM_1_134_5466_903CLS
      - TSLM_1_134_5468_903CLS
      - OSLM_1_134_5466_901CLS
      - TSLM_1_134_5468_901CLS
      - OSLM_1_134_5466_905CLS
      - TSLM_1_134_5468_905CLS
      - OSLM_1_134_5466_904CNTLS
      - TSLM_1_134_5468_904CNTLS
      - OSLM_1_134_5466_900CNTLS
      - TSLM_1_134_5468_900CNTLS
      - OSLM_1_134_5466_903CNTLS
      - TSLM_1_134_5468_903CNTLS
      - OSLM_1_134_5466_901CNTLS
      - TSLM_1_134_5468_901CNTLS
      - OSLM_1_134_5466_905CNTLS
      - TSLM_1_134_5468_905CNTLS
      - EDC100GWL3OCLDECNTLS
      - EDC100GWL3OCLDPCNTLS
      - EDC100GWL3OCLDLHCNTLS
      - EDC100GWL3OCLDRCNTLS
      - EDC100GWL3OCLDMCNTLS
      - EDC100GWL3OCLDSUBCNTLS
      - EDC40GWVSELOCLDEPMDCNTLS
      - EDC40GWVSELOCLDCNTLS
      - EDC40GWVSELOCLDRCNTLS
      - EDC40GWVSELOCLDMCNTLS
      - EDC40GWVSELOCLDSUBCLD
      - EDC40GWVSELOCLDSUBCLS
      - EDC40GWVSELOCLDSUBCNTLS
      - FLEX3WL3EMDMQPSKCLD1A
      - FLEX3WL3EMDMQPSKCLD1A_SDD
      - FLEX3WL3EMDMQPSKCLD2A
      - FLEX3WL3EMDMQPSKCLD2A_SDD
      - FLEX3WL3EMDMQPSKCLD3A_SDD
      - FLEX3WL3EMDMQPSKCLD4A_SDD
      - FLEX3WL3EMDMQPSKCLD5A
      - FLEX3WL3EMDMQPSKCLD5A_SDD
      - FLEX3WL3EMDMQPSKCLS1A
      - FLEX3WL3EMDMQPSKCLS1A_SDD
      - FLEX3WL3EMDMQPSKCLS2A
      - FLEX3WL3EMDMQPSKCLS2A_SDD
      - FLEX3WL3EMDMQPSKCLS3A_SDD
      - FLEX3WL3EMDMQPSKCLS4A_SDD
      - FLEX3WL3EMDMQPSKCLS5A
      - FLEX3WL3EMDMQPSKCLS5A_SDD
      - FLEX3WL3EMDMQPSKCNTLS1A
      - FLEX3WL3EMDMQPSKCNTLS1A_SDD
      - FLEX3WL3EMDMQPSKCNTLS2A
      - FLEX3WL3EMDMQPSKCNTLS2A_SDD
      - FLEX3WL3EMDMQPSKCNTLS3A_SDD
      - FLEX3WL3EMDMQPSKCNTLS4A_SDD
      - FLEX3WL3EMDMQPSKCNTLS5A
      - FLEX3WL3EMDMQPSKCNTLS5A_SDD
      - FLEX3WL3EMDM16QAMCLD1
      - FLEX3WL3EMDM16QAMCLD2
      - FLEX3WL3EMDM16QAMCLD3
      - FLEX3WL3EMDM16QAMCLD4
      - FLEX3WL3EMDM16QAMCLD5
      - FLEX3WL3EMDM16QAMCLS1
      - FLEX3WL3EMDM16QAMCLS2
      - FLEX3WL3EMDM16QAMCLS3
      - FLEX3WL3EMDM16QAMCLS4
      - FLEX3WL3EMDM16QAMCLS5
      - FLEX3WL3EMDM16QAMCNTLS1
      - FLEX3WL3EMDM16QAMCNTLS2
      - FLEX3WL3EMDM16QAMCNTLS3
      - FLEX3WL3EMDM16QAMCNTLS4
      - FLEX3WL3EMDM16QAMCNTLS5
      - FLEX3WL3EMDMQPSKCLD1B
      - FLEX3WL3EMDMQPSKCLD1B_SDD
      - FLEX3WL3EMDMQPSKCLD2B
      - FLEX3WL3EMDMQPSKCLD2B_SDD
      - FLEX3WL3EMDMQPSKCLD3B_SDD
      - FLEX3WL3EMDMQPSKCLD4B_SDD
      - FLEX3WL3EMDMQPSKCLD5B
      - FLEX3WL3EMDMQPSKCLD5B_SDD
      - FLEX3WL3EMDMQPSKCLS1B
      - FLEX3WL3EMDMQPSKCLS1B_SDD
      - FLEX3WL3EMDMQPSKCLS2B
      - FLEX3WL3EMDMQPSKCLS2B_SDD
      - FLEX3WL3EMDMQPSKCLS3B_SDD
      - FLEX3WL3EMDMQPSKCLS4B_SDD
      - FLEX3WL3EMDMQPSKCLS5B
      - FLEX3WL3EMDMQPSKCLS5B_SDD
      - FLEX3WL3EMDMQPSKCNTLS1B
      - FLEX3WL3EMDMQPSKCNTLS1B_SDD
      - FLEX3WL3EMDMQPSKCNTLS2B
      - FLEX3WL3EMDMQPSKCNTLS2B_SDD
      - FLEX3WL3EMDMQPSKCNTLS3B_SDD
      - FLEX3WL3EMDMQPSKCNTLS4B_SDD
      - FLEX3WL3EMDMQPSKCNTLS5B
      - FLEX3WL3EMDMQPSKCNTLS5B_SDD
      - XCVR_T80W01
      - EDC100GWL3OCLDSUBCLS
      - WL3NMDM4ASKCLD1
      - WL3NMDM4ASKCLD2
      - WL3NMDMQPSKCLD3
      - WL3NMDM4ASKCLS1
      - WL3NMDM4ASKCLS2
      - WL3NMDMQPSKCLS3
      - WL3NMDM4ASKCNTLS1
      - WL3NMDM4ASKCNTLS2
      - WL3NMDMQPSKCNTLS3
      - WL3NMDM4ASKCS1
      - WL3NMDM4ASKCS2
      - WL3NMDMQPSKCS3
      - WL3EMDMQPSKCS1B
      - WL3EMDMQPSKCS1B_SDD
      - WL3EMDMQPSKCS2B
      - WL3EMDMQPSKCS2B_SDD
      - WL3EMDMQPSKCS3B_SDD
      - WL3EMDMQPSKCS4B_SDD
      - WL3EMDMQPSKCS5B
      - WL3EMDMQPSKCS5B_SDD
      - EDC100GWL3MDMCS1
      - EDC100GWL3MDMCS2
      - EDC100GWL3MDMCS3
      - EDC100GWL3MDMCS4
      - EDC100GWL3MDMCS5
      - EDC100GWL3MDMCS6
      - EDC100GWL3MDMCS7
      - EDC100GWL3MDMCS8
      - TSLM_1_134_5468_900CS
      - TSLM_1_134_5468_901CS
      - TSLM_1_134_5468_903CS
      - TSLM_1_134_5468_904CS
      - TSLM_1_134_5468_905CS
      - OSLM_1_134_5466_900CS
      - OSLM_1_134_5466_901CS
      - OSLM_1_134_5466_903CS
      - OSLM_1_134_5466_904CS
      - OSLM_1_134_5466_905CS
      - WL3EMDMQPSKCS1
      - WL3EMDMQPSKCS2
      - WL3EMDMQPSKCS5
      - WL3EMDMQPSKCS1_SDD
      - WL3EMDMQPSKCS2_SDD
      - WL3EMDMQPSKCS3_SDD
      - WL3EMDMQPSKCS4_SDD
      - WL3EMDMQPSKCS5_SDD
      - WL3EMDM16QAMCS1
      - WL3EMDM16QAMCS2
      - WL3EMDM16QAMCS3
      - WL3EMDM16QAMCS4
      - WL3EMDM16QAMCS5
      - WL3NMDMAMP4ASKCLD
      - WL3NMDMAMP4ASKCLS
      - WL3NMDMAMP4ASKCNTLS
      - WL3NMDMAMP4ASKCS
      - WL3NMDMQPSKCNTLS
      - WL3NMDM4ASKCNTLS3
      - WL3NMDM4ASKCNTLS4
      - WL3NMDMQPSKCLD4
      - WL3NMDMQPSKCLS4
      - WL3NMDMQPSKCNTLS4
      - WL3NMDMQPSKCS4
      - WL3NMDMQPSKCLD5
      - WL3NMDMQPSKCLS5
      - WL3NMDMQPSKCNTLS5
      - WL3NMDMQPSKCS5
      - WL3NMDMQPSKCLD6
      - WL3NMDMQPSKCLS6
      - WL3NMDMQPSKCNTLS6
      - WL3NMDMQPSKCS6
      - WL3NMDM4ASKCLD5
      - WL3NMDM4ASKCLD6
      - WL3NMDM4ASKCLS5
      - WL3NMDM4ASKCLS6
      - WL3NMDM4ASKCNTLS5
      - WL3NMDM4ASKCNTLS6
      - WL3NMDM4ASKCS5
      - WL3NMDM4ASKCS6
      - WL3EMDM8QAMCLD3
      - WL3EMDM8QAMCLS3
      - WL3EMDM8QAMCNTLS3
      - WL3EMDM8QAMCS3
      - WL3EMDM8QAMCLD2
      - WL3EMDM8QAMCLS2
      - WL3EMDM8QAMCNTLS2
      - WL3EMDM8QAMCS2
      - WL3EMDM8QAMCLD4
      - WL3EMDM8QAMCLS4
      - WL3EMDM8QAMCNTLS4
      - WL3EMDM8QAMCS4
      - WL3EMDM8QAMCLD5
      - WL3EMDM8QAMCLS5
      - WL3EMDM8QAMCNTLS5
      - WL3EMDM8QAMCS5
      - WL3EMDM8QAMCLD1
      - WL3EMDM8QAMCLS1
      - WL3EMDM8QAMCNTLS1
      - WL3EMDM8QAMCS1
      - SFP_1609201900_RS8
      - SFP_1609201900_NULL
      - FLEX3WL3MDMQPSKCLS6A
      - FLEX3WL3EMDMQPSKCLD7A_SDD
      - FLEX3WL3EMDMQPSKCLS7A_SDD
      - FLEX3WL3EMDMQPSKCNTLS7A_SDD
      - WL3EMDMQPSKCS7_SDD
      - FLEX3WL3EMDMQPSKCLD8A
      - FLEX3WL3EMDMQPSKCLS8A
      - FLEX3WL3EMDMQPSKCNTLS8A
      - WL3EMDMQPSKCS8
      - WL3EMDM16QAMCS6
      - WL3EMDM16QAMCS7
      - FLEX3WL3EMDM16QAMCNTLS6
      - FLEX3WL3EMDM16QAMCNTLS7
      - FLEX3WL3EMDM16QAMCLD6
      - FLEX3WL3EMDM16QAMCLD7
      - FLEX3WL3EMDM16QAMCLS6
      - FLEX3WL3EMDM16QAMCLS7
      - WL3NMDMQPSKCNTLS7
      - FLEX3WL3MDMQPSKCLD2B_1862002901
      - FLEX3WL3MDMQPSKCLD2B_1862003901
      - FLEX3WL3MDMQPSKCLD1B_1862004900
      - FLEX3WL3MDMQPSKCLD1B_1862005900
      - FLEX3WL3MDM16QAMCLD2_1862002901
      - FLEX3WL3MDM16QAMCLD2_1862003901
      - FLEX3WL3MDM16QAMCLD1_1862004900
      - FLEX3WL3MDM16QAMCLD1_1862005900
      - WL3EMDM8QAMCLD1_1862004900
      - WL3EMDM8QAMCLD1_1862005900
      - WL3NMDM4ASKCS3
      - WL3NMDM4ASKCLD3
      - WL3NMDM4ASKCLS3
      - WL3NMDM4ASKCNTLS7
      - WL3NMDMQPSKCLD7
      - WL3NMDMQPSKCLS7
      - WL3NMDMQPSKCNTLS8
      - WL3NMDMQPSKCS7
      - WL3NMDMQPSKCLD8
      - WL3NMDMQPSKCLS8
      - WL3NMDMQPSKCNTLS9
      - WL3NMDMQPSKCS8
      - WL3NMDM4ASKCLD9
      - WL3NMDM4ASKCLS9
      - WL3NMDM4ASKCNTLS8
      - WL3NMDM4ASKCS9
      - WL3NMDMQPSKCLD1
      - WL3NMDMQPSKCLD2
      - WL3NMDM4ASKCLD4
      - WL3NMDM4ASKCLD7
      - WL3NMDMQPSKCLS1
      - WL3NMDMQPSKCLS2
      - WL3NMDM4ASKCLS4
      - WL3NMDM4ASKCLS7
      - WL3NMDMQPSKCS1
      - WL3NMDMQPSKCS2
      - WL3NMDM4ASKCS4
      - WL3NMDM4ASKCS7
      - FLEX3WL3EMDM16QAMCLD2WS
      - FLEX3WL3EMDM16QAMCLS2WS
      - FLEX3WL3EMDM16QAMCNTLS2WS
      - WL3EMDM16QAMCS2WS
      - FLEX3WL3EMDMQPSKCLD2AWS
      - FLEX3WL3EMDMQPSKCLS2AWS
      - FLEX3WL3EMDMQPSKCNTLS2AWS
      - WL3EMDMQPSKCS2WS
      - WL3EMDM8QAMCLD2WS
      - WL3EMDM8QAMCLS2WS
      - WL3EMDM8QAMCNTLS2WS
      - WL3EMDM8QAMCS2WS
      - FLEX3WL3EMDM16QAMCLD2WS_DC
      - FLEX3WL3EMDM16QAMCLS2WS_DC
      - FLEX3WL3EMDM16QAMCNTLS2WS_DC
      - WL3EMDM16QAMCS2WS_DC
      - FLEX3WL3EMDMQPSKCLD2AWS_DC
      - FLEX3WL3EMDMQPSKCLS2AWS_DC
      - FLEX3WL3EMDMQPSKCNTLS2AWS_DC
      - WL3EMDMQPSKCS2WS_DC
      - WL3EMDM8QAMCLD2WS_DC
      - WL3EMDM8QAMCLS2WS_DC
      - WL3EMDM8QAMCNTLS2WS_DC
      - WL3EMDM8QAMCS2WS_DC
      - WLCFP2ACOBQPSKCLD
      - WLCFP2ACOBQPSKCLS
      - WLCFP2ACOBQPSKCNTLS
      - WLCFP2ACOCQPSKCLD
      - WLCFP2ACOCQPSKCLS
      - WLCFP2ACOCQPSKCNTLS
      - WLCFP2ACOAQPSKCLD
      - WLCFP2ACOAQPSKCLS
      - WLCFP2ACOAQPSKCNTLS
      - FLEX3WL3EMDMQPSKCLD1A_NTK539FJ
      - FLEX3WL3EMDM16QAMCLD1_NTK539FJ
      - FLEX3WL3EMDMQPSKCLD1A_1345550906
      - FLEX3WL3EMDM16QAMCLD1_1345550907
      - FLEX3WL3EMDM16QAMCLD3_1345550900
      - FLEX3WL3EMDMQPSKCLD3A_SDD_1345550900
      - FLEX3WL3EMDM16QAMCLD1_1345550901
      - FLEX3WL3EMDMQPSKCLD1A_1345550901
      - FLEX3WL3EMDM16QAMCLD2_1345550903
      - FLEX3WL3EMDMQPSKCLD2A_1345550903
      - FLEX3WL3EMDM16QAMCLD4_1345550904
      - FLEX3WL3EMDMQPSKCLD4A_SDD_1345550904
      - FLEX3WL3EMDM16QAMCLD5_1345550905
      - FLEX3WL3EMDMQPSKCLD5A_1345550905
      - FLEX3WL3EMDMQPSKCLD1A_NTK539UJ
      - WLAI56GBd200GCLD
      - WLAI56GBd200GCLS
      - WLAI56GBd200GCNTLS
      - WLAI56GBd200GCS
      - WLAI56GBd300GCLD
      - WLAI56GBd300GCLS
      - WLAI56GBd300GCNTLS
      - WLAI56GBd300GCS
      - WLAI56GBd400GCLD
      - WLAI56GBd400GCLS
      - WLAI56GBd400GCNTLS
      - WLAI56GBd400GCS
      - WLAI35GBd200GCLD_V2_1
      - WLAI35GBd200GCLS_V2_1
      - WLAI35GBd200GCNTLS_V2_1
      - WLAI35GBd200GCS_V2_1
      - WLAI35GBd150GCLD_V2_1
      - WLAI35GBd150GCLS_V2_1
      - WLAI35GBd150GCNTLS_V2_1
      - WLAI35GBd150GCS_V2_1
      - WLAI56GBd200GCLD_1861600900
      - WLAI56GBd200GCLD_1861601900
      - WLAI56GBd200GCLD_1861602900
      - WLAI56GBd200GCLD_1861603900
      - WLAI56GBd300GCLD_1861600900
      - WLAI56GBd300GCLD_1861601900
      - WLAI56GBd300GCLD_1861602900
      - WLAI56GBd300GCLD_1861603900
      - WLAI56GBd400GCLD_1861600900
      - WLAI56GBd400GCLD_1861601900
      - WLAI56GBd400GCLD_1861602900
      - WLAI56GBd400GCLD_1861603900
      - WLCFP2ACOCQPSKCLD_1345560900
      - FLEX3WL3MDMQPSKCNTLS6A
      - WLAI56GBd150GCLD_V2_1
      - WLAI56GBd150GCLS_V2_1
      - WLAI56GBd150GCNTLS_V2_1
      - WLAI56GBd150GCS_V2_1
      - WLAI56GBd100GCLD_V2_1
      - WLAI56GBd100GCLS_V2_1
      - WLAI56GBd100GCNTLS_V2_1
      - WLAI56GBd100GCS_V2_1
      - WLAI35GBd250GCLD_V2_1
      - WLAI35GBd250GCLS_V2_1
      - WLAI35GBd250GCNTLS_V2_1
      - WLAI35GBd250GCS_V2_1
      - WLAI35GBd100GCLD_V2_1
      - WLAI35GBd100GCLS_V2_1
      - WLAI35GBd100GCNTLS_V2_1
      - WLAI35GBd100GCS_V2_1
      - WLAI56GBd350GCLD_V2_1
      - WLAI56GBd350GCLS_V2_1
      - WLAI56GBd350GCNTLS_V2_1
      - WLAI56GBd350GCS_V2_1
      - WLAI56GBd250GCLD_V2_1
      - WLAI56GBd250GCLS_V2_1
      - WLAI56GBd250GCNTLS_V2_1
      - WLAI56GBd250GCS_V2_1
      - WLAI56GBd200GCLD_V2_1
      - WLAI56GBd200GCLS_V2_1
      - WLAI56GBd200GCNTLS_V2_1
      - WLAI56GBd200GCS_V2_1
      - WLAI56GBd300GCLD_V2_1
      - WLAI56GBd300GCLS_V2_1
      - WLAI56GBd300GCNTLS_V2_1
      - WLAI56GBd300GCS_V2_1
      - WLAI56GBd400GCLD_V2_1
      - WLAI56GBd400GCLS_V2_1
      - WLAI56GBd400GCNTLS_V2_1
      - WLAI56GBd400GCS_V2_1
      - FLEX3WL3EMDMQPSKCLD2AWS_1862002902
      - FLEX3WL3EMDMQPSKCLD2AWS_1862003902
      - FLEX3WL3EMDM16QAMCLD2WS_1862002902
      - FLEX3WL3EMDM16QAMCLD2WS_1862003902
      - WLAI56GBd400GCLD_V2_2
      - WLAI56GBd350GCLD_V2_2
      - WLAI56GBd300GCLD_V2_2
      - WLAI56GBd250GCLD_V2_2
      - WLAI56GBd200GCLD_V2_2
      - WLAI56GBd150GCLD_V2_2
      - WLAI56GBd100GCLD_V2_2
      - WLAI35GBd250GCLD_V2_2
      - WLAI35GBd200GCLD_V2_2
      - WLAI35GBd150GCLD_V2_2
      - WLAI35GBd100GCLD_V2_2
      - WLAI56GBd400GCLS_V2_2
      - WLAI56GBd350GCLS_V2_2
      - WLAI56GBd300GCLS_V2_2
      - WLAI56GBd250GCLS_V2_2
      - WLAI56GBd200GCLS_V2_2
      - WLAI56GBd150GCLS_V2_2
      - WLAI56GBd100GCLS_V2_2
      - WLAI35GBd250GCLS_V2_2
      - WLAI35GBd200GCLS_V2_2
      - WLAI35GBd150GCLS_V2_2
      - WLAI35GBd100GCLS_V2_2
      - WLAI56GBd400GCNTLS_V2_2
      - WLAI56GBd350GCNTLS_V2_2
      - WLAI56GBd300GCNTLS_V2_2
      - WLAI56GBd250GCNTLS_V2_2
      - WLAI56GBd200GCNTLS_V2_2
      - WLAI56GBd150GCNTLS_V2_2
      - WLAI56GBd100GCNTLS_V2_2
      - WLAI35GBd250GCNTLS_V2_2
      - WLAI35GBd200GCNTLS_V2_2
      - WLAI35GBd150GCNTLS_V2_2
      - WLAI35GBd100GCNTLS_V2_2
      - WLAI56GBd400GCS_V2_2
      - WLAI56GBd350GCS_V2_2
      - WLAI56GBd300GCS_V2_2
      - WLAI56GBd250GCS_V2_2
      - WLAI56GBd200GCS_V2_2
      - WLAI56GBd150GCS_V2_2
      - WLAI56GBd100GCS_V2_2
      - WLAI35GBd250GCS_V2_2
      - WLAI35GBd200GCS_V2_2
      - WLAI35GBd150GCS_V2_2
      - WLAI35GBd100GCS_V2_2
      - WLAI56GBd400GCLD_V2_3
      - WLAI56GBd350GCLD_V2_3
      - WLAI56GBd300GCLD_V2_3
      - WLAI56GBd250GCLD_V2_3
      - WLAI56GBd200GCLD_V2_3
      - WLAI56GBd150GCLD_V2_3
      - WLAI56GBd100GCLD_V2_3
      - WLAI35GBd250GCLD_V2_3
      - WLAI35GBd200GCLD_V2_3
      - WLAI35GBd150GCLD_V2_3
      - WLAI35GBd100GCLD_V2_3
      - WLAI56GBd400GCLS_V2_3
      - WLAI56GBd350GCLS_V2_3
      - WLAI56GBd300GCLS_V2_3
      - WLAI56GBd250GCLS_V2_3
      - WLAI56GBd200GCLS_V2_3
      - WLAI56GBd150GCLS_V2_3
      - WLAI56GBd100GCLS_V2_3
      - WLAI35GBd250GCLS_V2_3
      - WLAI35GBd200GCLS_V2_3
      - WLAI35GBd150GCLS_V2_3
      - WLAI35GBd100GCLS_V2_3
      - WLAI56GBd400GCNTLS_V2_3
      - WLAI56GBd350GCNTLS_V2_3
      - WLAI56GBd300GCNTLS_V2_3
      - WLAI56GBd250GCNTLS_V2_3
      - WLAI56GBd200GCNTLS_V2_3
      - WLAI56GBd150GCNTLS_V2_3
      - WLAI56GBd100GCNTLS_V2_3
      - WLAI35GBd250GCNTLS_V2_3
      - WLAI35GBd200GCNTLS_V2_3
      - WLAI35GBd150GCNTLS_V2_3
      - WLAI35GBd100GCNTLS_V2_3
      - WLAI56GBd400GCS_V2_3
      - WLAI56GBd350GCS_V2_3
      - WLAI56GBd300GCS_V2_3
      - WLAI56GBd250GCS_V2_3
      - WLAI56GBd200GCS_V2_3
      - WLAI56GBd150GCS_V2_3
      - WLAI56GBd100GCS_V2_3
      - WLAI35GBd250GCS_V2_3
      - WLAI35GBd200GCS_V2_3
      - WLAI35GBd150GCS_V2_3
      - WLAI35GBd100GCS_V2_3
      - WLAI56GBd400GCLD_V2_4
      - WLAI56GBd350GCLD_V2_4
      - WLAI56GBd300GCLD_V2_4
      - WLAI56GBd250GCLD_V2_4
      - WLAI56GBd200GCLD_V2_4
      - WLAI56GBd150GCLD_V2_4
      - WLAI56GBd100GCLD_V2_4
      - WLAI35GBd250GCLD_V2_4
      - WLAI35GBd200GCLD_V2_4
      - WLAI35GBd150GCLD_V2_4
      - WLAI35GBd100GCLD_V2_4
      - WLAI56GBd400GCLS_V2_4
      - WLAI56GBd350GCLS_V2_4
      - WLAI56GBd300GCLS_V2_4
      - WLAI56GBd250GCLS_V2_4
      - WLAI56GBd200GCLS_V2_4
      - WLAI56GBd150GCLS_V2_4
      - WLAI56GBd100GCLS_V2_4
      - WLAI35GBd250GCLS_V2_4
      - WLAI35GBd200GCLS_V2_4
      - WLAI35GBd150GCLS_V2_4
      - WLAI35GBd100GCLS_V2_4
      - WLAI56GBd400GCNTLS_V2_4
      - WLAI56GBd350GCNTLS_V2_4
      - WLAI56GBd300GCNTLS_V2_4
      - WLAI56GBd250GCNTLS_V2_4
      - WLAI56GBd200GCNTLS_V2_4
      - WLAI56GBd150GCNTLS_V2_4
      - WLAI56GBd100GCNTLS_V2_4
      - WLAI35GBd250GCNTLS_V2_4
      - WLAI35GBd200GCNTLS_V2_4
      - WLAI35GBd150GCNTLS_V2_4
      - WLAI35GBd100GCNTLS_V2_4
      - WLAI56GBd400GCS_V2_4
      - WLAI56GBd350GCS_V2_4
      - WLAI56GBd300GCS_V2_4
      - WLAI56GBd250GCS_V2_4
      - WLAI56GBd200GCS_V2_4
      - WLAI56GBd150GCS_V2_4
      - WLAI56GBd100GCS_V2_4
      - WLAI35GBd250GCS_V2_4
      - WLAI35GBd200GCS_V2_4
      - WLAI35GBd150GCS_V2_4
      - WLAI35GBd100GCS_V2_4
      - WLCFP2ACOA4ASKCLD
      - WLCFP2ACOA4ASKCLS
      - WLCFP2ACOA4ASKCNTLS
      - WLCFP2ACOA4ASKCLD2
      - WLCFP2ACOA4ASKCLS2
      - WLCFP2ACOA4ASKCNTLS2
      - WLAI56GBd400GCLD_V2_1_NTK538FR
      - WLAI56GBd350GCLD_V2_1_NTK538FR
      - WLAI56GBd300GCLD_V2_1_NTK538FR
      - WLAI56GBd250GCLD_V2_1_NTK538FR
      - WLAI56GBd200GCLD_V2_1_NTK538FR
      - WLAI56GBd150GCLD_V2_1_NTK538FR
      - WLAI56GBd100GCLD_V2_1_NTK538FR
      - WLAI35GBd250GCLD_V2_1_NTK538FR
      - WLAI35GBd200GCLD_V2_1_NTK538FR
      - WLAI35GBd150GCLD_V2_1_NTK538FR
      - WLAI35GBd100GCLD_V2_1_NTK538FR
      - WLAI56GBd400GCLD_V2_2_NTK538FR
      - WLAI56GBd350GCLD_V2_2_NTK538FR
      - WLAI56GBd300GCLD_V2_2_NTK538FR
      - WLAI56GBd250GCLD_V2_2_NTK538FR
      - WLAI56GBd200GCLD_V2_2_NTK538FR
      - WLAI56GBd150GCLD_V2_2_NTK538FR
      - WLAI56GBd100GCLD_V2_2_NTK538FR
      - WLAI35GBd250GCLD_V2_2_NTK538FR
      - WLAI35GBd200GCLD_V2_2_NTK538FR
      - WLAI35GBd150GCLD_V2_2_NTK538FR
      - WLAI35GBd100GCLD_V2_2_NTK538FR
      - WLAI56GBd400GCLD_V2_1_186_1601_900
      - WLAI56GBd300GCLD_V2_1_186_1601_900
      - WLAI56GBd250GCLD_V2_1_186_1601_900
      - WLAI56GBd200GCLD_V2_1_186_1601_900
      - WLAI56GBd150GCLD_V2_1_186_1601_900
      - WLAI35GBd200GCLD_V2_1_186_1601_900
      - WLAI35GBd150GCLD_V2_1_186_1601_900
      - WLAI56GBd400GCLD_V2_1_186_1603_900
      - WLAI56GBd300GCLD_V2_1_186_1603_900
      - WLAI56GBd250GCLD_V2_1_186_1603_900
      - WLAI56GBd200GCLD_V2_1_186_1603_900
      - WLAI56GBd150GCLD_V2_1_186_1603_900
      - WLAI35GBd200GCLD_V2_1_186_1603_900
      - WLAI35GBd150GCLD_V2_1_186_1603_900
      - WLAI56GBd400GCLD_V2_2_186_1601_900
      - WLAI56GBd350GCLD_V2_2_186_1601_900
      - WLAI56GBd300GCLD_V2_2_186_1601_900
      - WLAI56GBd250GCLD_V2_2_186_1601_900
      - WLAI56GBd200GCLD_V2_2_186_1601_900
      - WLAI56GBd150GCLD_V2_2_186_1601_900
      - WLAI56GBd100GCLD_V2_2_186_1601_900
      - WLAI35GBd250GCLD_V2_2_186_1601_900
      - WLAI35GBd200GCLD_V2_2_186_1601_900
      - WLAI35GBd150GCLD_V2_2_186_1601_900
      - WLAI35GBd100GCLD_V2_2_186_1601_900
      - WLAI56GBd400GCLD_V2_2_186_1603_900
      - WLAI56GBd350GCLD_V2_2_186_1603_900
      - WLAI56GBd300GCLD_V2_2_186_1603_900
      - WLAI56GBd250GCLD_V2_2_186_1603_900
      - WLAI56GBd200GCLD_V2_2_186_1603_900
      - WLAI56GBd150GCLD_V2_2_186_1603_900
      - WLAI56GBd100GCLD_V2_2_186_1603_900
      - WLAI35GBd250GCLD_V2_2_186_1603_900
      - WLAI35GBd200GCLD_V2_2_186_1603_900
      - WLAI35GBd150GCLD_V2_2_186_1603_900
      - WLAI35GBd100GCLD_V2_2_186_1603_900
      - WLAI56GBd350GCLD_V2_1_186_1601_900
      - WLAI56GBd100GCLD_V2_1_186_1601_900
      - WLAI35GBd250GCLD_V2_1_186_1601_900
      - WLAI35GBd100GCLD_V2_1_186_1601_900
      - WLAI56GBd350GCLD_V2_1_186_1603_900
      - WLAI56GBd100GCLD_V2_1_186_1603_900
      - WLAI35GBd250GCLD_V2_1_186_1603_900
      - WLAI35GBd100GCLD_V2_1_186_1603_900
      - WL3EMDM8QAMCLD2WS_1862002902
      - WL3EMDM8QAMCLD2WS_1862003902
      - WLAI56GBd200GCLD_1861606900
      - WLAI56GBd300GCLD_1861606900
      - WLAI56GBd400GCLD_1861606900
      - WLAI56GBd400GCLD_V2_1_186_1606_900
      - WLAI56GBd350GCLD_V2_1_186_1606_900
      - WLAI56GBd300GCLD_V2_1_186_1606_900
      - WLAI56GBd250GCLD_V2_1_186_1606_900
      - WLAI56GBd200GCLD_V2_1_186_1606_900
      - WLAI56GBd150GCLD_V2_1_186_1606_900
      - WLAI56GBd100GCLD_V2_1_186_1606_900
      - WLAI35GBd250GCLD_V2_1_186_1606_900
      - WLAI35GBd200GCLD_V2_1_186_1606_900
      - WLAI35GBd200GCLD_V2_2_186_1606_900
      - WLAI35GBd150GCLD_V2_1_186_1606_900
      - WLAI35GBd100GCLD_V2_1_186_1606_900
      - WLAI56GBd400GCLD_V2_2_186_1606_900
      - WLAI56GBd350GCLD_V2_2_186_1606_900
      - WLAI56GBd300GCLD_V2_2_186_1606_900
      - WLAI56GBd250GCLD_V2_2_186_1606_900
      - WLAI56GBd200GCLD_V2_2_186_1606_900
      - WLAI56GBd150GCLD_V2_2_186_1606_900
      - WLAI56GBd100GCLD_V2_2_186_1606_900
      - WLAI35GBd250GCLD_V2_2_186_1606_900
      - WLAI35GBd150GCLD_V2_2_186_1606_900
      - WLAI35GBd100GCLD_V2_2_186_1606_900
      - WLAI56GBd200GCLD_1920001900
      - WLAI56GBd300GCLD_1920001900
      - WLAI56GBd400GCLD_1920001900
      - WLAI56GBd400GCLD_V2_1_192_0001_900
      - WLAI56GBd350GCLD_V2_1_192_0001_900
      - WLAI56GBd300GCLD_V2_1_192_0001_900
      - WLAI56GBd250GCLD_V2_1_192_0001_900
      - WLAI56GBd200GCLD_V2_1_192_0001_900
      - WLAI56GBd150GCLD_V2_1_192_0001_900
      - WLAI56GBd100GCLD_V2_1_192_0001_900
      - WLAI35GBd250GCLD_V2_1_192_0001_900
      - WLAI35GBd200GCLD_V2_1_192_0001_900
      - WLAI35GBd200GCLD_V2_2_192_0001_900
      - WLAI35GBd150GCLD_V2_1_192_0001_900
      - WLAI35GBd100GCLD_V2_1_192_0001_900
      - WLAI56GBd400GCLD_V2_2_192_0001_900
      - WLAI56GBd350GCLD_V2_2_192_0001_900
      - WLAI56GBd300GCLD_V2_2_192_0001_900
      - WLAI56GBd250GCLD_V2_2_192_0001_900
      - WLAI56GBd200GCLD_V2_2_192_0001_900
      - WLAI56GBd150GCLD_V2_2_192_0001_900
      - WLAI56GBd100GCLD_V2_2_192_0001_900
      - WLAI35GBd250GCLD_V2_2_192_0001_900
      - WLAI35GBd150GCLD_V2_2_192_0001_900
      - WLAI35GBd100GCLD_V2_2_192_0001_900
      - WL5nCFP2DCO28GBd100GCLD_1
      - WL5nCFP2DCO32GBd100GCLD_1
      - WL5nCFP2DCO32GBd200GCLD_1
      - WL5nCFP2DCO28GBd100GCLD_1_180_2111_900
      - WL5nCFP2DCO28GBd100GCLD_1_180_2110_900
      - WL5nCFP2DCO28GBd100GCLD_1_180_2120_900
      - WL5nCFP2DCO32GBd100GCLD_1_180_2120_900
      - WL5nCFP2DCO32GBd200GCLD_1_180_2120_900
      - WLAI56GBd100GCLD_V2_1_174_0650_900
      - WLAI56GBd150GCLD_V2_1_174_0650_900
      - WLAI56GBd200GCLD_V2_1_174_0650_900
      - WLAI56GBd250GCLD_V2_1_174_0650_900
      - WLAI56GBd300GCLD_V2_1_174_0650_900
      - WLAI56GBd350GCLD_V2_1_174_0650_900
      - WLAI56GBd400GCLD_V2_1_174_0650_900
      - WLAI35GBd100GCLD_V2_1_174_0650_900
      - WLAI35GBd200GCLD_V2_1_174_0650_900
      - WLAI56GBd400GCLS_V2_1_174_0650_900
      - WLAI56GBd350GCLS_V2_1_174_0650_900
      - WLAI56GBd300GCLS_V2_1_174_0650_900
      - WLAI56GBd250GCLS_V2_1_174_0650_900
      - WLAI56GBd200GCLS_V2_1_174_0650_900
      - WLAI56GBd150GCLS_V2_1_174_0650_900
      - WLAI56GBd100GCLS_V2_1_174_0650_900
      - WLAI35GBd200GCLS_V2_1_174_0650_900
      - WLAI35GBd100GCLS_V2_1_174_0650_900
      - WLAI56GBd400GCNTLS_V2_1_174_0650_900
      - WLAI56GBd350GCNTLS_V2_1_174_0650_900
      - WLAI56GBd300GCNTLS_V2_1_174_0650_900
      - WLAI56GBd250GCNTLS_V2_1_174_0650_900
      - WLAI56GBd200GCNTLS_V2_1_174_0650_900
      - WLAI56GBd150GCNTLS_V2_1_174_0650_900
      - WLAI56GBd100GCNTLS_V2_1_174_0650_900
      - WLAI35GBd200GCNTLS_V2_1_174_0650_900
      - WLAI35GBd100GCNTLS_V2_1_174_0650_900
      - WLAI56GBd400GCS_V2_1_174_0650_900
      - WLAI56GBd350GCS_V2_1_174_0650_900
      - WLAI56GBd300GCS_V2_1_174_0650_900
      - WLAI56GBd250GCS_V2_1_174_0650_900
      - WLAI56GBd200GCS_V2_1_174_0650_900
      - WLAI56GBd150GCS_V2_1_174_0650_900
      - WLAI56GBd100GCS_V2_1_174_0650_900
      - WLAI35GBd200GCS_V2_1_174_0650_900
      - WLAI35GBd100GCS_V2_1_174_0650_900
      - WLAI35GBd250GCLD_V2_1_174_0650_900
      - WLAI35GBd150GCLD_V2_1_174_0650_900
      - WLAI35GBd250GCLS_V2_1_174_0650_900
      - WLAI35GBd150GCLS_V2_1_174_0650_900
      - WLAI35GBd250GCNTLS_V2_1_174_0650_900
      - WLAI35GBd150GCNTLS_V2_1_174_0650_900
      - WLAI35GBd250GCS_V2_1_174_0650_900
      - WLAI35GBd150GCS_V2_1_174_0650_900
      - WL5e95GBd200GCLD1_O
      - WL5e95GBd250GCLD1_O
      - WL5e95GBd300GCLD1_O
      - WL5e95GBd350GCLD1_O
      - WL5e95GBd400GCLD1_O
      - WL5e95GBd450GCLD1_O
      - WL5e95GBd500GCLD1_O
      - WL5e95GBd550GCLD1_O
      - WL5e95GBd600GCLD1_O
      - WL5e95GBd650GCLD1_O
      - WL5e95GBd700GCLD1_O
      - WL5e95GBd750GCLD1_O
      - WL5e95GBd800GCLD1_O
      - WL5e95GBd200GCLD1_E
      - WL5e95GBd250GCLD1_E
      - WL5e95GBd300GCLD1_E
      - WL5e95GBd350GCLD1_E
      - WL5e95GBd400GCLD1_E
      - WL5e95GBd450GCLD1_E
      - WL5e95GBd500GCLD1_E
      - WL5e95GBd550GCLD1_E
      - WL5e95GBd600GCLD1_E
      - WL5e95GBd650GCLD1_E
      - WL5e95GBd700GCLD1_E
      - WL5e95GBd750GCLD1_E
      - WL5e95GBd800GCLD1_E
      - WL5e95GBd200GCLS1_O
      - WL5e95GBd250GCLS1_O
      - WL5e95GBd300GCLS1_O
      - WL5e95GBd350GCLS1_O
      - WL5e95GBd400GCLS1_O
      - WL5e95GBd450GCLS1_O
      - WL5e95GBd500GCLS1_O
      - WL5e95GBd550GCLS1_O
      - WL5e95GBd600GCLS1_O
      - WL5e95GBd650GCLS1_O
      - WL5e95GBd700GCLS1_O
      - WL5e95GBd750GCLS1_O
      - WL5e95GBd800GCLS1_O
      - WL5e95GBd200GCLS1_E
      - WL5e95GBd250GCLS1_E
      - WL5e95GBd300GCLS1_E
      - WL5e95GBd350GCLS1_E
      - WL5e95GBd400GCLS1_E
      - WL5e95GBd450GCLS1_E
      - WL5e95GBd500GCLS1_E
      - WL5e95GBd550GCLS1_E
      - WL5e95GBd600GCLS1_E
      - WL5e95GBd650GCLS1_E
      - WL5e95GBd700GCLS1_E
      - WL5e95GBd750GCLS1_E
      - WL5e95GBd800GCLS1_E
      - WL5e95GBd200GCNTLS1_O
      - WL5e95GBd250GCNTLS1_O
      - WL5e95GBd300GCNTLS1_O
      - WL5e95GBd350GCNTLS1_O
      - WL5e95GBd400GCNTLS1_O
      - WL5e95GBd450GCNTLS1_O
      - WL5e95GBd500GCNTLS1_O
      - WL5e95GBd550GCNTLS1_O
      - WL5e95GBd600GCNTLS1_O
      - WL5e95GBd650GCNTLS1_O
      - WL5e95GBd700GCNTLS1_O
      - WL5e95GBd750GCNTLS1_O
      - WL5e95GBd800GCNTLS1_O
      - WL5e95GBd200GCNTLS1_E
      - WL5e95GBd250GCNTLS1_E
      - WL5e95GBd300GCNTLS1_E
      - WL5e95GBd350GCNTLS1_E
      - WL5e95GBd400GCNTLS1_E
      - WL5e95GBd450GCNTLS1_E
      - WL5e95GBd500GCNTLS1_E
      - WL5e95GBd550GCNTLS1_E
      - WL5e95GBd600GCNTLS1_E
      - WL5e95GBd650GCNTLS1_E
      - WL5e95GBd700GCNTLS1_E
      - WL5e95GBd750GCNTLS1_E
      - WL5e95GBd800GCNTLS1_E
      - WL5e95GBd200GCS1_O
      - WL5e95GBd250GCS1_O
      - WL5e95GBd300GCS1_O
      - WL5e95GBd350GCS1_O
      - WL5e95GBd400GCS1_O
      - WL5e95GBd450GCS1_O
      - WL5e95GBd500GCS1_O
      - WL5e95GBd550GCS1_O
      - WL5e95GBd600GCS1_O
      - WL5e95GBd650GCS1_O
      - WL5e95GBd700GCS1_O
      - WL5e95GBd750GCS1_O
      - WL5e95GBd800GCS1_O
      - WL5e95GBd200GCS1_E
      - WL5e95GBd250GCS1_E
      - WL5e95GBd300GCS1_E
      - WL5e95GBd350GCS1_E
      - WL5e95GBd400GCS1_E
      - WL5e95GBd450GCS1_E
      - WL5e95GBd500GCS1_E
      - WL5e95GBd550GCS1_E
      - WL5e95GBd600GCS1_E
      - WL5e95GBd650GCS1_E
      - WL5e95GBd700GCS1_E
      - WL5e95GBd750GCS1_E
      - WL5e95GBd800GCS1_E
      - WL5e95GBd200GCLD2_O
      - WL5e95GBd250GCLD2_O
      - WL5e95GBd300GCLD2_O
      - WL5e95GBd350GCLD2_O
      - WL5e95GBd400GCLD2_O
      - WL5e95GBd450GCLD2_O
      - WL5e95GBd500GCLD2_O
      - WL5e95GBd550GCLD2_O
      - WL5e95GBd600GCLD2_O
      - WL5e95GBd650GCLD2_O
      - WL5e95GBd700GCLD2_O
      - WL5e95GBd750GCLD2_O
      - WL5e95GBd800GCLD2_O
      - WL5e95GBd200GCLD2_E
      - WL5e95GBd250GCLD2_E
      - WL5e95GBd300GCLD2_E
      - WL5e95GBd350GCLD2_E
      - WL5e95GBd400GCLD2_E
      - WL5e95GBd450GCLD2_E
      - WL5e95GBd500GCLD2_E
      - WL5e95GBd550GCLD2_E
      - WL5e95GBd600GCLD2_E
      - WL5e95GBd650GCLD2_E
      - WL5e95GBd700GCLD2_E
      - WL5e95GBd750GCLD2_E
      - WL5e95GBd800GCLD2_E
      - WL5e95GBd200GCLS2_O
      - WL5e95GBd250GCLS2_O
      - WL5e95GBd300GCLS2_O
      - WL5e95GBd350GCLS2_O
      - WL5e95GBd400GCLS2_O
      - WL5e95GBd450GCLS2_O
      - WL5e95GBd500GCLS2_O
      - WL5e95GBd550GCLS2_O
      - WL5e95GBd600GCLS2_O
      - WL5e95GBd650GCLS2_O
      - WL5e95GBd700GCLS2_O
      - WL5e95GBd750GCLS2_O
      - WL5e95GBd800GCLS2_O
      - WL5e95GBd200GCLS2_E
      - WL5e95GBd250GCLS2_E
      - WL5e95GBd300GCLS2_E
      - WL5e95GBd350GCLS2_E
      - WL5e95GBd400GCLS2_E
      - WL5e95GBd450GCLS2_E
      - WL5e95GBd500GCLS2_E
      - WL5e95GBd550GCLS2_E
      - WL5e95GBd600GCLS2_E
      - WL5e95GBd650GCLS2_E
      - WL5e95GBd700GCLS2_E
      - WL5e95GBd750GCLS2_E
      - WL5e95GBd800GCLS2_E
      - WL5e95GBd200GCNTLS2_O
      - WL5e95GBd250GCNTLS2_O
      - WL5e95GBd300GCNTLS2_O
      - WL5e95GBd350GCNTLS2_O
      - WL5e95GBd400GCNTLS2_O
      - WL5e95GBd450GCNTLS2_O
      - WL5e95GBd500GCNTLS2_O
      - WL5e95GBd550GCNTLS2_O
      - WL5e95GBd600GCNTLS2_O
      - WL5e95GBd650GCNTLS2_O
      - WL5e95GBd700GCNTLS2_O
      - WL5e95GBd750GCNTLS2_O
      - WL5e95GBd800GCNTLS2_O
      - WL5e95GBd200GCNTLS2_E
      - WL5e95GBd250GCNTLS2_E
      - WL5e95GBd300GCNTLS2_E
      - WL5e95GBd350GCNTLS2_E
      - WL5e95GBd400GCNTLS2_E
      - WL5e95GBd450GCNTLS2_E
      - WL5e95GBd500GCNTLS2_E
      - WL5e95GBd550GCNTLS2_E
      - WL5e95GBd600GCNTLS2_E
      - WL5e95GBd650GCNTLS2_E
      - WL5e95GBd700GCNTLS2_E
      - WL5e95GBd750GCNTLS2_E
      - WL5e95GBd800GCNTLS2_E
      - WL5e95GBd200GCS2_O
      - WL5e95GBd250GCS2_O
      - WL5e95GBd300GCS2_O
      - WL5e95GBd350GCS2_O
      - WL5e95GBd400GCS2_O
      - WL5e95GBd450GCS2_O
      - WL5e95GBd500GCS2_O
      - WL5e95GBd550GCS2_O
      - WL5e95GBd600GCS2_O
      - WL5e95GBd650GCS2_O
      - WL5e95GBd700GCS2_O
      - WL5e95GBd750GCS2_O
      - WL5e95GBd800GCS2_O
      - WL5e95GBd200GCS2_E
      - WL5e95GBd250GCS2_E
      - WL5e95GBd300GCS2_E
      - WL5e95GBd350GCS2_E
      - WL5e95GBd400GCS2_E
      - WL5e95GBd450GCS2_E
      - WL5e95GBd500GCS2_E
      - WL5e95GBd550GCS2_E
      - WL5e95GBd600GCS2_E
      - WL5e95GBd650GCS2_E
      - WL5e95GBd700GCS2_E
      - WL5e95GBd750GCS2_E
      - WL5e95GBd800GCS2_E
      - WL5e95GBd200GCLD3_O
      - WL5e95GBd250GCLD3_O
      - WL5e95GBd300GCLD3_O
      - WL5e95GBd350GCLD3_O
      - WL5e95GBd400GCLD3_O
      - WL5e95GBd450GCLD3_O
      - WL5e95GBd500GCLD3_O
      - WL5e95GBd550GCLD3_O
      - WL5e95GBd600GCLD3_O
      - WL5e95GBd650GCLD3_O
      - WL5e95GBd700GCLD3_O
      - WL5e95GBd750GCLD3_O
      - WL5e95GBd800GCLD3_O
      - WL5e95GBd200GCLD3_E
      - WL5e95GBd250GCLD3_E
      - WL5e95GBd300GCLD3_E
      - WL5e95GBd350GCLD3_E
      - WL5e95GBd400GCLD3_E
      - WL5e95GBd450GCLD3_E
      - WL5e95GBd500GCLD3_E
      - WL5e95GBd550GCLD3_E
      - WL5e95GBd600GCLD3_E
      - WL5e95GBd650GCLD3_E
      - WL5e95GBd700GCLD3_E
      - WL5e95GBd750GCLD3_E
      - WL5e95GBd800GCLD3_E
      - WL5e95GBd200GCLS3_O
      - WL5e95GBd250GCLS3_O
      - WL5e95GBd300GCLS3_O
      - WL5e95GBd350GCLS3_O
      - WL5e95GBd400GCLS3_O
      - WL5e95GBd450GCLS3_O
      - WL5e95GBd500GCLS3_O
      - WL5e95GBd550GCLS3_O
      - WL5e95GBd600GCLS3_O
      - WL5e95GBd650GCLS3_O
      - WL5e95GBd700GCLS3_O
      - WL5e95GBd750GCLS3_O
      - WL5e95GBd800GCLS3_O
      - WL5e95GBd200GCLS3_E
      - WL5e95GBd250GCLS3_E
      - WL5e95GBd300GCLS3_E
      - WL5e95GBd350GCLS3_E
      - WL5e95GBd400GCLS3_E
      - WL5e95GBd450GCLS3_E
      - WL5e95GBd500GCLS3_E
      - WL5e95GBd550GCLS3_E
      - WL5e95GBd600GCLS3_E
      - WL5e95GBd650GCLS3_E
      - WL5e95GBd700GCLS3_E
      - WL5e95GBd750GCLS3_E
      - WL5e95GBd800GCLS3_E
      - WL5e95GBd200GCNTLS3_O
      - WL5e95GBd250GCNTLS3_O
      - WL5e95GBd300GCNTLS3_O
      - WL5e95GBd350GCNTLS3_O
      - WL5e95GBd400GCNTLS3_O
      - WL5e95GBd450GCNTLS3_O
      - WL5e95GBd500GCNTLS3_O
      - WL5e95GBd550GCNTLS3_O
      - WL5e95GBd600GCNTLS3_O
      - WL5e95GBd650GCNTLS3_O
      - WL5e95GBd700GCNTLS3_O
      - WL5e95GBd750GCNTLS3_O
      - WL5e95GBd800GCNTLS3_O
      - WL5e95GBd200GCNTLS3_E
      - WL5e95GBd250GCNTLS3_E
      - WL5e95GBd300GCNTLS3_E
      - WL5e95GBd350GCNTLS3_E
      - WL5e95GBd400GCNTLS3_E
      - WL5e95GBd450GCNTLS3_E
      - WL5e95GBd500GCNTLS3_E
      - WL5e95GBd550GCNTLS3_E
      - WL5e95GBd600GCNTLS3_E
      - WL5e95GBd650GCNTLS3_E
      - WL5e95GBd700GCNTLS3_E
      - WL5e95GBd750GCNTLS3_E
      - WL5e95GBd800GCNTLS3_E
      - WL5e95GBd200GCS3_O
      - WL5e95GBd250GCS3_O
      - WL5e95GBd300GCS3_O
      - WL5e95GBd350GCS3_O
      - WL5e95GBd400GCS3_O
      - WL5e95GBd450GCS3_O
      - WL5e95GBd500GCS3_O
      - WL5e95GBd550GCS3_O
      - WL5e95GBd600GCS3_O
      - WL5e95GBd650GCS3_O
      - WL5e95GBd700GCS3_O
      - WL5e95GBd750GCS3_O
      - WL5e95GBd800GCS3_O
      - WL5e95GBd200GCS3_E
      - WL5e95GBd250GCS3_E
      - WL5e95GBd300GCS3_E
      - WL5e95GBd350GCS3_E
      - WL5e95GBd400GCS3_E
      - WL5e95GBd450GCS3_E
      - WL5e95GBd500GCS3_E
      - WL5e95GBd550GCS3_E
      - WL5e95GBd600GCS3_E
      - WL5e95GBd650GCS3_E
      - WL5e95GBd700GCS3_E
      - WL5e95GBd750GCS3_E
      - WL5e95GBd800GCS3_E
      - WL5e95GBd200GCLD4_O
      - WL5e95GBd250GCLD4_O
      - WL5e95GBd300GCLD4_O
      - WL5e95GBd350GCLD4_O
      - WL5e95GBd400GCLD4_O
      - WL5e95GBd450GCLD4_O
      - WL5e95GBd500GCLD4_O
      - WL5e95GBd550GCLD4_O
      - WL5e95GBd600GCLD4_O
      - WL5e95GBd650GCLD4_O
      - WL5e95GBd700GCLD4_O
      - WL5e95GBd750GCLD4_O
      - WL5e95GBd800GCLD4_O
      - WL5e95GBd200GCLD4_E
      - WL5e95GBd250GCLD4_E
      - WL5e95GBd300GCLD4_E
      - WL5e95GBd350GCLD4_E
      - WL5e95GBd400GCLD4_E
      - WL5e95GBd450GCLD4_E
      - WL5e95GBd500GCLD4_E
      - WL5e95GBd550GCLD4_E
      - WL5e95GBd600GCLD4_E
      - WL5e95GBd650GCLD4_E
      - WL5e95GBd700GCLD4_E
      - WL5e95GBd750GCLD4_E
      - WL5e95GBd800GCLD4_E
      - WL5e95GBd200GCLS4_O
      - WL5e95GBd250GCLS4_O
      - WL5e95GBd300GCLS4_O
      - WL5e95GBd350GCLS4_O
      - WL5e95GBd400GCLS4_O
      - WL5e95GBd450GCLS4_O
      - WL5e95GBd500GCLS4_O
      - WL5e95GBd550GCLS4_O
      - WL5e95GBd600GCLS4_O
      - WL5e95GBd650GCLS4_O
      - WL5e95GBd700GCLS4_O
      - WL5e95GBd750GCLS4_O
      - WL5e95GBd800GCLS4_O
      - WL5e95GBd200GCLS4_E
      - WL5e95GBd250GCLS4_E
      - WL5e95GBd300GCLS4_E
      - WL5e95GBd350GCLS4_E
      - WL5e95GBd400GCLS4_E
      - WL5e95GBd450GCLS4_E
      - WL5e95GBd500GCLS4_E
      - WL5e95GBd550GCLS4_E
      - WL5e95GBd600GCLS4_E
      - WL5e95GBd650GCLS4_E
      - WL5e95GBd700GCLS4_E
      - WL5e95GBd750GCLS4_E
      - WL5e95GBd800GCLS4_E
      - WL5e95GBd200GCNTLS4_O
      - WL5e95GBd250GCNTLS4_O
      - WL5e95GBd300GCNTLS4_O
      - WL5e95GBd350GCNTLS4_O
      - WL5e95GBd400GCNTLS4_O
      - WL5e95GBd450GCNTLS4_O
      - WL5e95GBd500GCNTLS4_O
      - WL5e95GBd550GCNTLS4_O
      - WL5e95GBd600GCNTLS4_O
      - WL5e95GBd650GCNTLS4_O
      - WL5e95GBd700GCNTLS4_O
      - WL5e95GBd750GCNTLS4_O
      - WL5e95GBd800GCNTLS4_O
      - WL5e95GBd200GCNTLS4_E
      - WL5e95GBd250GCNTLS4_E
      - WL5e95GBd300GCNTLS4_E
      - WL5e95GBd350GCNTLS4_E
      - WL5e95GBd400GCNTLS4_E
      - WL5e95GBd450GCNTLS4_E
      - WL5e95GBd500GCNTLS4_E
      - WL5e95GBd550GCNTLS4_E
      - WL5e95GBd600GCNTLS4_E
      - WL5e95GBd650GCNTLS4_E
      - WL5e95GBd700GCNTLS4_E
      - WL5e95GBd750GCNTLS4_E
      - WL5e95GBd800GCNTLS4_E
      - WL5e95GBd200GCS4_O
      - WL5e95GBd250GCS4_O
      - WL5e95GBd300GCS4_O
      - WL5e95GBd350GCS4_O
      - WL5e95GBd400GCS4_O
      - WL5e95GBd450GCS4_O
      - WL5e95GBd500GCS4_O
      - WL5e95GBd550GCS4_O
      - WL5e95GBd600GCS4_O
      - WL5e95GBd650GCS4_O
      - WL5e95GBd700GCS4_O
      - WL5e95GBd750GCS4_O
      - WL5e95GBd800GCS4_O
      - WL5e95GBd200GCS4_E
      - WL5e95GBd250GCS4_E
      - WL5e95GBd300GCS4_E
      - WL5e95GBd350GCS4_E
      - WL5e95GBd400GCS4_E
      - WL5e95GBd450GCS4_E
      - WL5e95GBd500GCS4_E
      - WL5e95GBd550GCS4_E
      - WL5e95GBd600GCS4_E
      - WL5e95GBd650GCS4_E
      - WL5e95GBd700GCS4_E
      - WL5e95GBd750GCS4_E
      - WL5e95GBd800GCS4_E
      - WL5nCFP2DCO28GBd100GCLD_180_2130_900
      - WL5nCFP2DCO32GBd100GCLD_180_2130_900
      - WL5nCFP2DCO28GBd100GCLS_180_2130_900
      - WL5nCFP2DCO32GBd100GCLS_180_2130_900
      - WL5nCFP2DCO28GBd100GCNTLS_180_2130_900
      - WL5nCFP2DCO32GBd100GCNTLS_180_2130_900
      - WL5nCFP2DCO28GBd100GCS_180_2130_900
      - WL5nCFP2DCO32GBd100GCS_180_2130_900
      - WL5e95GBd200GCLD5_O
      - WL5e95GBd250GCLD5_O
      - WL5e95GBd300GCLD5_O
      - WL5e95GBd350GCLD5_O
      - WL5e95GBd400GCLD5_O
      - WL5e95GBd450GCLD5_O
      - WL5e95GBd500GCLD5_O
      - WL5e95GBd550GCLD5_O
      - WL5e95GBd600GCLD5_O
      - WL5e95GBd650GCLD5_O
      - WL5e95GBd700GCLD5_O
      - WL5e95GBd750GCLD5_O
      - WL5e95GBd800GCLD5_O
      - WL5e95GBd200GCLD5_E
      - WL5e95GBd250GCLD5_E
      - WL5e95GBd300GCLD5_E
      - WL5e95GBd350GCLD5_E
      - WL5e95GBd400GCLD5_E
      - WL5e95GBd450GCLD5_E
      - WL5e95GBd500GCLD5_E
      - WL5e95GBd550GCLD5_E
      - WL5e95GBd600GCLD5_E
      - WL5e95GBd650GCLD5_E
      - WL5e95GBd700GCLD5_E
      - WL5e95GBd750GCLD5_E
      - WL5e95GBd800GCLD5_E
      - WL5e95GBd200GCLS5_O
      - WL5e95GBd250GCLS5_O
      - WL5e95GBd300GCLS5_O
      - WL5e95GBd350GCLS5_O
      - WL5e95GBd400GCLS5_O
      - WL5e95GBd450GCLS5_O
      - WL5e95GBd500GCLS5_O
      - WL5e95GBd550GCLS5_O
      - WL5e95GBd600GCLS5_O
      - WL5e95GBd650GCLS5_O
      - WL5e95GBd700GCLS5_O
      - WL5e95GBd750GCLS5_O
      - WL5e95GBd800GCLS5_O
      - WL5e95GBd200GCLS5_E
      - WL5e95GBd250GCLS5_E
      - WL5e95GBd300GCLS5_E
      - WL5e95GBd350GCLS5_E
      - WL5e95GBd400GCLS5_E
      - WL5e95GBd450GCLS5_E
      - WL5e95GBd500GCLS5_E
      - WL5e95GBd550GCLS5_E
      - WL5e95GBd600GCLS5_E
      - WL5e95GBd650GCLS5_E
      - WL5e95GBd700GCLS5_E
      - WL5e95GBd750GCLS5_E
      - WL5e95GBd800GCLS5_E
      - WL5e95GBd200GCNTLS5_O
      - WL5e95GBd250GCNTLS5_O
      - WL5e95GBd300GCNTLS5_O
      - WL5e95GBd350GCNTLS5_O
      - WL5e95GBd400GCNTLS5_O
      - WL5e95GBd450GCNTLS5_O
      - WL5e95GBd500GCNTLS5_O
      - WL5e95GBd550GCNTLS5_O
      - WL5e95GBd600GCNTLS5_O
      - WL5e95GBd650GCNTLS5_O
      - WL5e95GBd700GCNTLS5_O
      - WL5e95GBd750GCNTLS5_O
      - WL5e95GBd800GCNTLS5_O
      - WL5e95GBd200GCNTLS5_E
      - WL5e95GBd250GCNTLS5_E
      - WL5e95GBd300GCNTLS5_E
      - WL5e95GBd350GCNTLS5_E
      - WL5e95GBd400GCNTLS5_E
      - WL5e95GBd450GCNTLS5_E
      - WL5e95GBd500GCNTLS5_E
      - WL5e95GBd550GCNTLS5_E
      - WL5e95GBd600GCNTLS5_E
      - WL5e95GBd650GCNTLS5_E
      - WL5e95GBd700GCNTLS5_E
      - WL5e95GBd750GCNTLS5_E
      - WL5e95GBd800GCNTLS5_E
      - WL5e95GBd200GCS5_O
      - WL5e95GBd250GCS5_O
      - WL5e95GBd300GCS5_O
      - WL5e95GBd350GCS5_O
      - WL5e95GBd400GCS5_O
      - WL5e95GBd450GCS5_O
      - WL5e95GBd500GCS5_O
      - WL5e95GBd550GCS5_O
      - WL5e95GBd600GCS5_O
      - WL5e95GBd650GCS5_O
      - WL5e95GBd700GCS5_O
      - WL5e95GBd750GCS5_O
      - WL5e95GBd800GCS5_O
      - WL5e95GBd200GCS5_E
      - WL5e95GBd250GCS5_E
      - WL5e95GBd300GCS5_E
      - WL5e95GBd350GCS5_E
      - WL5e95GBd400GCS5_E
      - WL5e95GBd450GCS5_E
      - WL5e95GBd500GCS5_E
      - WL5e95GBd550GCS5_E
      - WL5e95GBd600GCS5_E
      - WL5e95GBd650GCS5_E
      - WL5e95GBd700GCS5_E
      - WL5e95GBd750GCS5_E
      - WL5e95GBd800GCS5_E
      - WL5e95GBd200GCLD6_O
      - WL5e95GBd250GCLD6_O
      - WL5e95GBd300GCLD6_O
      - WL5e95GBd350GCLD6_O
      - WL5e95GBd400GCLD6_O
      - WL5e95GBd450GCLD6_O
      - WL5e95GBd500GCLD6_O
      - WL5e95GBd550GCLD6_O
      - WL5e95GBd600GCLD6_O
      - WL5e95GBd650GCLD6_O
      - WL5e95GBd700GCLD6_O
      - WL5e95GBd750GCLD6_O
      - WL5e95GBd800GCLD6_O
      - WL5e95GBd200GCLD6_E
      - WL5e95GBd250GCLD6_E
      - WL5e95GBd300GCLD6_E
      - WL5e95GBd350GCLD6_E
      - WL5e95GBd400GCLD6_E
      - WL5e95GBd450GCLD6_E
      - WL5e95GBd500GCLD6_E
      - WL5e95GBd550GCLD6_E
      - WL5e95GBd600GCLD6_E
      - WL5e95GBd650GCLD6_E
      - WL5e95GBd700GCLD6_E
      - WL5e95GBd750GCLD6_E
      - WL5e95GBd800GCLD6_E
      - WL5e95GBd200GCLS6_O
      - WL5e95GBd250GCLS6_O
      - WL5e95GBd300GCLS6_O
      - WL5e95GBd350GCLS6_O
      - WL5e95GBd400GCLS6_O
      - WL5e95GBd450GCLS6_O
      - WL5e95GBd500GCLS6_O
      - WL5e95GBd550GCLS6_O
      - WL5e95GBd600GCLS6_O
      - WL5e95GBd650GCLS6_O
      - WL5e95GBd700GCLS6_O
      - WL5e95GBd750GCLS6_O
      - WL5e95GBd800GCLS6_O
      - WL5e95GBd200GCLS6_E
      - WL5e95GBd250GCLS6_E
      - WL5e95GBd300GCLS6_E
      - WL5e95GBd350GCLS6_E
      - WL5e95GBd400GCLS6_E
      - WL5e95GBd450GCLS6_E
      - WL5e95GBd500GCLS6_E
      - WL5e95GBd550GCLS6_E
      - WL5e95GBd600GCLS6_E
      - WL5e95GBd650GCLS6_E
      - WL5e95GBd700GCLS6_E
      - WL5e95GBd750GCLS6_E
      - WL5e95GBd800GCLS6_E
      - WL5e95GBd200GCNTLS6_O
      - WL5e95GBd250GCNTLS6_O
      - WL5e95GBd300GCNTLS6_O
      - WL5e95GBd350GCNTLS6_O
      - WL5e95GBd400GCNTLS6_O
      - WL5e95GBd450GCNTLS6_O
      - WL5e95GBd500GCNTLS6_O
      - WL5e95GBd550GCNTLS6_O
      - WL5e95GBd600GCNTLS6_O
      - WL5e95GBd650GCNTLS6_O
      - WL5e95GBd700GCNTLS6_O
      - WL5e95GBd750GCNTLS6_O
      - WL5e95GBd800GCNTLS6_O
      - WL5e95GBd200GCNTLS6_E
      - WL5e95GBd250GCNTLS6_E
      - WL5e95GBd300GCNTLS6_E
      - WL5e95GBd350GCNTLS6_E
      - WL5e95GBd400GCNTLS6_E
      - WL5e95GBd450GCNTLS6_E
      - WL5e95GBd500GCNTLS6_E
      - WL5e95GBd550GCNTLS6_E
      - WL5e95GBd600GCNTLS6_E
      - WL5e95GBd650GCNTLS6_E
      - WL5e95GBd700GCNTLS6_E
      - WL5e95GBd750GCNTLS6_E
      - WL5e95GBd800GCNTLS6_E
      - WL5e95GBd200GCS6_O
      - WL5e95GBd250GCS6_O
      - WL5e95GBd300GCS6_O
      - WL5e95GBd350GCS6_O
      - WL5e95GBd400GCS6_O
      - WL5e95GBd450GCS6_O
      - WL5e95GBd500GCS6_O
      - WL5e95GBd550GCS6_O
      - WL5e95GBd600GCS6_O
      - WL5e95GBd650GCS6_O
      - WL5e95GBd700GCS6_O
      - WL5e95GBd750GCS6_O
      - WL5e95GBd800GCS6_O
      - WL5e95GBd200GCS6_E
      - WL5e95GBd250GCS6_E
      - WL5e95GBd300GCS6_E
      - WL5e95GBd350GCS6_E
      - WL5e95GBd400GCS6_E
      - WL5e95GBd450GCS6_E
      - WL5e95GBd500GCS6_E
      - WL5e95GBd550GCS6_E
      - WL5e95GBd600GCS6_E
      - WL5e95GBd650GCS6_E
      - WL5e95GBd700GCS6_E
      - WL5e95GBd750GCS6_E
      - WL5e95GBd800GCS6_E
      - WL5e91P6GBd200GCLD1_O
      - WL5e91P6GBd250GCLD1_O
      - WL5e91P6GBd300GCLD1_O
      - WL5e91P6GBd350GCLD1_O
      - WL5e91P6GBd400GCLD1_O
      - WL5e91P6GBd450GCLD1_O
      - WL5e91P6GBd500GCLD1_O
      - WL5e91P6GBd550GCLD1_O
      - WL5e91P6GBd600GCLD1_O
      - WL5e91P6GBd650GCLD1_O
      - WL5e91P6GBd700GCLD1_O
      - WL5e91P6GBd750GCLD1_O
      - WL5e91P6GBd800GCLD1_O
      - WL5e91P6GBd200GCLD1_E
      - WL5e91P6GBd250GCLD1_E
      - WL5e91P6GBd300GCLD1_E
      - WL5e91P6GBd350GCLD1_E
      - WL5e91P6GBd400GCLD1_E
      - WL5e91P6GBd450GCLD1_E
      - WL5e91P6GBd500GCLD1_E
      - WL5e91P6GBd550GCLD1_E
      - WL5e91P6GBd600GCLD1_E
      - WL5e91P6GBd650GCLD1_E
      - WL5e91P6GBd700GCLD1_E
      - WL5e91P6GBd750GCLD1_E
      - WL5e91P6GBd800GCLD1_E
      - WL5e91P6GBd200GCLS1_O
      - WL5e91P6GBd250GCLS1_O
      - WL5e91P6GBd300GCLS1_O
      - WL5e91P6GBd350GCLS1_O
      - WL5e91P6GBd400GCLS1_O
      - WL5e91P6GBd450GCLS1_O
      - WL5e91P6GBd500GCLS1_O
      - WL5e91P6GBd550GCLS1_O
      - WL5e91P6GBd600GCLS1_O
      - WL5e91P6GBd650GCLS1_O
      - WL5e91P6GBd700GCLS1_O
      - WL5e91P6GBd750GCLS1_O
      - WL5e91P6GBd800GCLS1_O
      - WL5e91P6GBd200GCLS1_E
      - WL5e91P6GBd250GCLS1_E
      - WL5e91P6GBd300GCLS1_E
      - WL5e91P6GBd350GCLS1_E
      - WL5e91P6GBd400GCLS1_E
      - WL5e91P6GBd450GCLS1_E
      - WL5e91P6GBd500GCLS1_E
      - WL5e91P6GBd550GCLS1_E
      - WL5e91P6GBd600GCLS1_E
      - WL5e91P6GBd650GCLS1_E
      - WL5e91P6GBd700GCLS1_E
      - WL5e91P6GBd750GCLS1_E
      - WL5e91P6GBd800GCLS1_E
      - WL5e91P6GBd200GCNTLS1_O
      - WL5e91P6GBd250GCNTLS1_O
      - WL5e91P6GBd300GCNTLS1_O
      - WL5e91P6GBd350GCNTLS1_O
      - WL5e91P6GBd400GCNTLS1_O
      - WL5e91P6GBd450GCNTLS1_O
      - WL5e91P6GBd500GCNTLS1_O
      - WL5e91P6GBd550GCNTLS1_O
      - WL5e91P6GBd600GCNTLS1_O
      - WL5e91P6GBd650GCNTLS1_O
      - WL5e91P6GBd700GCNTLS1_O
      - WL5e91P6GBd750GCNTLS1_O
      - WL5e91P6GBd800GCNTLS1_O
      - WL5e91P6GBd200GCNTLS1_E
      - WL5e91P6GBd250GCNTLS1_E
      - WL5e91P6GBd300GCNTLS1_E
      - WL5e91P6GBd350GCNTLS1_E
      - WL5e91P6GBd400GCNTLS1_E
      - WL5e91P6GBd450GCNTLS1_E
      - WL5e91P6GBd500GCNTLS1_E
      - WL5e91P6GBd550GCNTLS1_E
      - WL5e91P6GBd600GCNTLS1_E
      - WL5e91P6GBd650GCNTLS1_E
      - WL5e91P6GBd700GCNTLS1_E
      - WL5e91P6GBd750GCNTLS1_E
      - WL5e91P6GBd800GCNTLS1_E
      - WL5e91P6GBd200GCS1_O
      - WL5e91P6GBd250GCS1_O
      - WL5e91P6GBd300GCS1_O
      - WL5e91P6GBd350GCS1_O
      - WL5e91P6GBd400GCS1_O
      - WL5e91P6GBd450GCS1_O
      - WL5e91P6GBd500GCS1_O
      - WL5e91P6GBd550GCS1_O
      - WL5e91P6GBd600GCS1_O
      - WL5e91P6GBd650GCS1_O
      - WL5e91P6GBd700GCS1_O
      - WL5e91P6GBd750GCS1_O
      - WL5e91P6GBd800GCS1_O
      - WL5e91P6GBd200GCS1_E
      - WL5e91P6GBd250GCS1_E
      - WL5e91P6GBd300GCS1_E
      - WL5e91P6GBd350GCS1_E
      - WL5e91P6GBd400GCS1_E
      - WL5e91P6GBd450GCS1_E
      - WL5e91P6GBd500GCS1_E
      - WL5e91P6GBd550GCS1_E
      - WL5e91P6GBd600GCS1_E
      - WL5e91P6GBd650GCS1_E
      - WL5e91P6GBd700GCS1_E
      - WL5e91P6GBd750GCS1_E
      - WL5e91P6GBd800GCS1_E
      - WL5e91P6GBd200GCLD2_O
      - WL5e91P6GBd250GCLD2_O
      - WL5e91P6GBd300GCLD2_O
      - WL5e91P6GBd350GCLD2_O
      - WL5e91P6GBd400GCLD2_O
      - WL5e91P6GBd450GCLD2_O
      - WL5e91P6GBd500GCLD2_O
      - WL5e91P6GBd550GCLD2_O
      - WL5e91P6GBd600GCLD2_O
      - WL5e91P6GBd650GCLD2_O
      - WL5e91P6GBd700GCLD2_O
      - WL5e91P6GBd750GCLD2_O
      - WL5e91P6GBd800GCLD2_O
      - WL5e91P6GBd200GCLD2_E
      - WL5e91P6GBd250GCLD2_E
      - WL5e91P6GBd300GCLD2_E
      - WL5e91P6GBd350GCLD2_E
      - WL5e91P6GBd400GCLD2_E
      - WL5e91P6GBd450GCLD2_E
      - WL5e91P6GBd500GCLD2_E
      - WL5e91P6GBd550GCLD2_E
      - WL5e91P6GBd600GCLD2_E
      - WL5e91P6GBd650GCLD2_E
      - WL5e91P6GBd700GCLD2_E
      - WL5e91P6GBd750GCLD2_E
      - WL5e91P6GBd800GCLD2_E
      - WL5e91P6GBd200GCLS2_O
      - WL5e91P6GBd250GCLS2_O
      - WL5e91P6GBd300GCLS2_O
      - WL5e91P6GBd350GCLS2_O
      - WL5e91P6GBd400GCLS2_O
      - WL5e91P6GBd450GCLS2_O
      - WL5e91P6GBd500GCLS2_O
      - WL5e91P6GBd550GCLS2_O
      - WL5e91P6GBd600GCLS2_O
      - WL5e91P6GBd650GCLS2_O
      - WL5e91P6GBd700GCLS2_O
      - WL5e91P6GBd750GCLS2_O
      - WL5e91P6GBd800GCLS2_O
      - WL5e91P6GBd200GCLS2_E
      - WL5e91P6GBd250GCLS2_E
      - WL5e91P6GBd300GCLS2_E
      - WL5e91P6GBd350GCLS2_E
      - WL5e91P6GBd400GCLS2_E
      - WL5e91P6GBd450GCLS2_E
      - WL5e91P6GBd500GCLS2_E
      - WL5e91P6GBd550GCLS2_E
      - WL5e91P6GBd600GCLS2_E
      - WL5e91P6GBd650GCLS2_E
      - WL5e91P6GBd700GCLS2_E
      - WL5e91P6GBd750GCLS2_E
      - WL5e91P6GBd800GCLS2_E
      - WL5e91P6GBd200GCNTLS2_O
      - WL5e91P6GBd250GCNTLS2_O
      - WL5e91P6GBd300GCNTLS2_O
      - WL5e91P6GBd350GCNTLS2_O
      - WL5e91P6GBd400GCNTLS2_O
      - WL5e91P6GBd450GCNTLS2_O
      - WL5e91P6GBd500GCNTLS2_O
      - WL5e91P6GBd550GCNTLS2_O
      - WL5e91P6GBd600GCNTLS2_O
      - WL5e91P6GBd650GCNTLS2_O
      - WL5e91P6GBd700GCNTLS2_O
      - WL5e91P6GBd750GCNTLS2_O
      - WL5e91P6GBd800GCNTLS2_O
      - WL5e91P6GBd200GCNTLS2_E
      - WL5e91P6GBd250GCNTLS2_E
      - WL5e91P6GBd300GCNTLS2_E
      - WL5e91P6GBd350GCNTLS2_E
      - WL5e91P6GBd400GCNTLS2_E
      - WL5e91P6GBd450GCNTLS2_E
      - WL5e91P6GBd500GCNTLS2_E
      - WL5e91P6GBd550GCNTLS2_E
      - WL5e91P6GBd600GCNTLS2_E
      - WL5e91P6GBd650GCNTLS2_E
      - WL5e91P6GBd700GCNTLS2_E
      - WL5e91P6GBd750GCNTLS2_E
      - WL5e91P6GBd800GCNTLS2_E
      - WL5e91P6GBd200GCS2_O
      - WL5e91P6GBd250GCS2_O
      - WL5e91P6GBd300GCS2_O
      - WL5e91P6GBd350GCS2_O
      - WL5e91P6GBd400GCS2_O
      - WL5e91P6GBd450GCS2_O
      - WL5e91P6GBd500GCS2_O
      - WL5e91P6GBd550GCS2_O
      - WL5e91P6GBd600GCS2_O
      - WL5e91P6GBd650GCS2_O
      - WL5e91P6GBd700GCS2_O
      - WL5e91P6GBd750GCS2_O
      - WL5e91P6GBd800GCS2_O
      - WL5e91P6GBd200GCS2_E
      - WL5e91P6GBd250GCS2_E
      - WL5e91P6GBd300GCS2_E
      - WL5e91P6GBd350GCS2_E
      - WL5e91P6GBd400GCS2_E
      - WL5e91P6GBd450GCS2_E
      - WL5e91P6GBd500GCS2_E
      - WL5e91P6GBd550GCS2_E
      - WL5e91P6GBd600GCS2_E
      - WL5e91P6GBd650GCS2_E
      - WL5e91P6GBd700GCS2_E
      - WL5e91P6GBd750GCS2_E
      - WL5e91P6GBd800GCS2_E
      - WL5e91P6GBd200GCLD3_O
      - WL5e91P6GBd250GCLD3_O
      - WL5e91P6GBd300GCLD3_O
      - WL5e91P6GBd350GCLD3_O
      - WL5e91P6GBd400GCLD3_O
      - WL5e91P6GBd450GCLD3_O
      - WL5e91P6GBd500GCLD3_O
      - WL5e91P6GBd550GCLD3_O
      - WL5e91P6GBd600GCLD3_O
      - WL5e91P6GBd650GCLD3_O
      - WL5e91P6GBd700GCLD3_O
      - WL5e91P6GBd750GCLD3_O
      - WL5e91P6GBd800GCLD3_O
      - WL5e91P6GBd200GCLD3_E
      - WL5e91P6GBd250GCLD3_E
      - WL5e91P6GBd300GCLD3_E
      - WL5e91P6GBd350GCLD3_E
      - WL5e91P6GBd400GCLD3_E
      - WL5e91P6GBd450GCLD3_E
      - WL5e91P6GBd500GCLD3_E
      - WL5e91P6GBd550GCLD3_E
      - WL5e91P6GBd600GCLD3_E
      - WL5e91P6GBd650GCLD3_E
      - WL5e91P6GBd700GCLD3_E
      - WL5e91P6GBd750GCLD3_E
      - WL5e91P6GBd800GCLD3_E
      - WL5e91P6GBd200GCLS3_O
      - WL5e91P6GBd250GCLS3_O
      - WL5e91P6GBd300GCLS3_O
      - WL5e91P6GBd350GCLS3_O
      - WL5e91P6GBd400GCLS3_O
      - WL5e91P6GBd450GCLS3_O
      - WL5e91P6GBd500GCLS3_O
      - WL5e91P6GBd550GCLS3_O
      - WL5e91P6GBd600GCLS3_O
      - WL5e91P6GBd650GCLS3_O
      - WL5e91P6GBd700GCLS3_O
      - WL5e91P6GBd750GCLS3_O
      - WL5e91P6GBd800GCLS3_O
      - WL5e91P6GBd200GCLS3_E
      - WL5e91P6GBd250GCLS3_E
      - WL5e91P6GBd300GCLS3_E
      - WL5e91P6GBd350GCLS3_E
      - WL5e91P6GBd400GCLS3_E
      - WL5e91P6GBd450GCLS3_E
      - WL5e91P6GBd500GCLS3_E
      - WL5e91P6GBd550GCLS3_E
      - WL5e91P6GBd600GCLS3_E
      - WL5e91P6GBd650GCLS3_E
      - WL5e91P6GBd700GCLS3_E
      - WL5e91P6GBd750GCLS3_E
      - WL5e91P6GBd800GCLS3_E
      - WL5e91P6GBd200GCNTLS3_O
      - WL5e91P6GBd250GCNTLS3_O
      - WL5e91P6GBd300GCNTLS3_O
      - WL5e91P6GBd350GCNTLS3_O
      - WL5e91P6GBd400GCNTLS3_O
      - WL5e91P6GBd450GCNTLS3_O
      - WL5e91P6GBd500GCNTLS3_O
      - WL5e91P6GBd550GCNTLS3_O
      - WL5e91P6GBd600GCNTLS3_O
      - WL5e91P6GBd650GCNTLS3_O
      - WL5e91P6GBd700GCNTLS3_O
      - WL5e91P6GBd750GCNTLS3_O
      - WL5e91P6GBd800GCNTLS3_O
      - WL5e91P6GBd200GCNTLS3_E
      - WL5e91P6GBd250GCNTLS3_E
      - WL5e91P6GBd300GCNTLS3_E
      - WL5e91P6GBd350GCNTLS3_E
      - WL5e91P6GBd400GCNTLS3_E
      - WL5e91P6GBd450GCNTLS3_E
      - WL5e91P6GBd500GCNTLS3_E
      - WL5e91P6GBd550GCNTLS3_E
      - WL5e91P6GBd600GCNTLS3_E
      - WL5e91P6GBd650GCNTLS3_E
      - WL5e91P6GBd700GCNTLS3_E
      - WL5e91P6GBd750GCNTLS3_E
      - WL5e91P6GBd800GCNTLS3_E
      - WL5e91P6GBd200GCS3_O
      - WL5e91P6GBd250GCS3_O
      - WL5e91P6GBd300GCS3_O
      - WL5e91P6GBd350GCS3_O
      - WL5e91P6GBd400GCS3_O
      - WL5e91P6GBd450GCS3_O
      - WL5e91P6GBd500GCS3_O
      - WL5e91P6GBd550GCS3_O
      - WL5e91P6GBd600GCS3_O
      - WL5e91P6GBd650GCS3_O
      - WL5e91P6GBd700GCS3_O
      - WL5e91P6GBd750GCS3_O
      - WL5e91P6GBd800GCS3_O
      - WL5e91P6GBd200GCS3_E
      - WL5e91P6GBd250GCS3_E
      - WL5e91P6GBd300GCS3_E
      - WL5e91P6GBd350GCS3_E
      - WL5e91P6GBd400GCS3_E
      - WL5e91P6GBd450GCS3_E
      - WL5e91P6GBd500GCS3_E
      - WL5e91P6GBd550GCS3_E
      - WL5e91P6GBd600GCS3_E
      - WL5e91P6GBd650GCS3_E
      - WL5e91P6GBd700GCS3_E
      - WL5e91P6GBd750GCS3_E
      - WL5e91P6GBd800GCS3_E
      - WL5e91P6GBd200GCLD4_O
      - WL5e91P6GBd250GCLD4_O
      - WL5e91P6GBd300GCLD4_O
      - WL5e91P6GBd350GCLD4_O
      - WL5e91P6GBd400GCLD4_O
      - WL5e91P6GBd450GCLD4_O
      - WL5e91P6GBd500GCLD4_O
      - WL5e91P6GBd550GCLD4_O
      - WL5e91P6GBd600GCLD4_O
      - WL5e91P6GBd650GCLD4_O
      - WL5e91P6GBd700GCLD4_O
      - WL5e91P6GBd750GCLD4_O
      - WL5e91P6GBd800GCLD4_O
      - WL5e91P6GBd200GCLD4_E
      - WL5e91P6GBd250GCLD4_E
      - WL5e91P6GBd300GCLD4_E
      - WL5e91P6GBd350GCLD4_E
      - WL5e91P6GBd400GCLD4_E
      - WL5e91P6GBd450GCLD4_E
      - WL5e91P6GBd500GCLD4_E
      - WL5e91P6GBd550GCLD4_E
      - WL5e91P6GBd600GCLD4_E
      - WL5e91P6GBd650GCLD4_E
      - WL5e91P6GBd700GCLD4_E
      - WL5e91P6GBd750GCLD4_E
      - WL5e91P6GBd800GCLD4_E
      - WL5e91P6GBd200GCLS4_O
      - WL5e91P6GBd250GCLS4_O
      - WL5e91P6GBd300GCLS4_O
      - WL5e91P6GBd350GCLS4_O
      - WL5e91P6GBd400GCLS4_O
      - WL5e91P6GBd450GCLS4_O
      - WL5e91P6GBd500GCLS4_O
      - WL5e91P6GBd550GCLS4_O
      - WL5e91P6GBd600GCLS4_O
      - WL5e91P6GBd650GCLS4_O
      - WL5e91P6GBd700GCLS4_O
      - WL5e91P6GBd750GCLS4_O
      - WL5e91P6GBd800GCLS4_O
      - WL5e91P6GBd200GCLS4_E
      - WL5e91P6GBd250GCLS4_E
      - WL5e91P6GBd300GCLS4_E
      - WL5e91P6GBd350GCLS4_E
      - WL5e91P6GBd400GCLS4_E
      - WL5e91P6GBd450GCLS4_E
      - WL5e91P6GBd500GCLS4_E
      - WL5e91P6GBd550GCLS4_E
      - WL5e91P6GBd600GCLS4_E
      - WL5e91P6GBd650GCLS4_E
      - WL5e91P6GBd700GCLS4_E
      - WL5e91P6GBd750GCLS4_E
      - WL5e91P6GBd800GCLS4_E
      - WL5e91P6GBd200GCNTLS4_O
      - WL5e91P6GBd250GCNTLS4_O
      - WL5e91P6GBd300GCNTLS4_O
      - WL5e91P6GBd350GCNTLS4_O
      - WL5e91P6GBd400GCNTLS4_O
      - WL5e91P6GBd450GCNTLS4_O
      - WL5e91P6GBd500GCNTLS4_O
      - WL5e91P6GBd550GCNTLS4_O
      - WL5e91P6GBd600GCNTLS4_O
      - WL5e91P6GBd650GCNTLS4_O
      - WL5e91P6GBd700GCNTLS4_O
      - WL5e91P6GBd750GCNTLS4_O
      - WL5e91P6GBd800GCNTLS4_O
      - WL5e91P6GBd200GCNTLS4_E
      - WL5e91P6GBd250GCNTLS4_E
      - WL5e91P6GBd300GCNTLS4_E
      - WL5e91P6GBd350GCNTLS4_E
      - WL5e91P6GBd400GCNTLS4_E
      - WL5e91P6GBd450GCNTLS4_E
      - WL5e91P6GBd500GCNTLS4_E
      - WL5e91P6GBd550GCNTLS4_E
      - WL5e91P6GBd600GCNTLS4_E
      - WL5e91P6GBd650GCNTLS4_E
      - WL5e91P6GBd700GCNTLS4_E
      - WL5e91P6GBd750GCNTLS4_E
      - WL5e91P6GBd800GCNTLS4_E
      - WL5e91P6GBd200GCS4_O
      - WL5e91P6GBd250GCS4_O
      - WL5e91P6GBd300GCS4_O
      - WL5e91P6GBd350GCS4_O
      - WL5e91P6GBd400GCS4_O
      - WL5e91P6GBd450GCS4_O
      - WL5e91P6GBd500GCS4_O
      - WL5e91P6GBd550GCS4_O
      - WL5e91P6GBd600GCS4_O
      - WL5e91P6GBd650GCS4_O
      - WL5e91P6GBd700GCS4_O
      - WL5e91P6GBd750GCS4_O
      - WL5e91P6GBd800GCS4_O
      - WL5e91P6GBd200GCS4_E
      - WL5e91P6GBd250GCS4_E
      - WL5e91P6GBd300GCS4_E
      - WL5e91P6GBd350GCS4_E
      - WL5e91P6GBd400GCS4_E
      - WL5e91P6GBd450GCS4_E
      - WL5e91P6GBd500GCS4_E
      - WL5e91P6GBd550GCS4_E
      - WL5e91P6GBd600GCS4_E
      - WL5e91P6GBd650GCS4_E
      - WL5e91P6GBd700GCS4_E
      - WL5e91P6GBd750GCS4_E
      - WL5e91P6GBd800GCS4_E
      - WL5e91P6GBd200GCLD5_O
      - WL5e91P6GBd250GCLD5_O
      - WL5e91P6GBd300GCLD5_O
      - WL5e91P6GBd350GCLD5_O
      - WL5e91P6GBd400GCLD5_O
      - WL5e91P6GBd450GCLD5_O
      - WL5e91P6GBd500GCLD5_O
      - WL5e91P6GBd550GCLD5_O
      - WL5e91P6GBd600GCLD5_O
      - WL5e91P6GBd650GCLD5_O
      - WL5e91P6GBd700GCLD5_O
      - WL5e91P6GBd750GCLD5_O
      - WL5e91P6GBd800GCLD5_O
      - WL5e91P6GBd200GCLD5_E
      - WL5e91P6GBd250GCLD5_E
      - WL5e91P6GBd300GCLD5_E
      - WL5e91P6GBd350GCLD5_E
      - WL5e91P6GBd400GCLD5_E
      - WL5e91P6GBd450GCLD5_E
      - WL5e91P6GBd500GCLD5_E
      - WL5e91P6GBd550GCLD5_E
      - WL5e91P6GBd600GCLD5_E
      - WL5e91P6GBd650GCLD5_E
      - WL5e91P6GBd700GCLD5_E
      - WL5e91P6GBd750GCLD5_E
      - WL5e91P6GBd800GCLD5_E
      - WL5e91P6GBd200GCLS5_O
      - WL5e91P6GBd250GCLS5_O
      - WL5e91P6GBd300GCLS5_O
      - WL5e91P6GBd350GCLS5_O
      - WL5e91P6GBd400GCLS5_O
      - WL5e91P6GBd450GCLS5_O
      - WL5e91P6GBd500GCLS5_O
      - WL5e91P6GBd550GCLS5_O
      - WL5e91P6GBd600GCLS5_O
      - WL5e91P6GBd650GCLS5_O
      - WL5e91P6GBd700GCLS5_O
      - WL5e91P6GBd750GCLS5_O
      - WL5e91P6GBd800GCLS5_O
      - WL5e91P6GBd200GCLS5_E
      - WL5e91P6GBd250GCLS5_E
      - WL5e91P6GBd300GCLS5_E
      - WL5e91P6GBd350GCLS5_E
      - WL5e91P6GBd400GCLS5_E
      - WL5e91P6GBd450GCLS5_E
      - WL5e91P6GBd500GCLS5_E
      - WL5e91P6GBd550GCLS5_E
      - WL5e91P6GBd600GCLS5_E
      - WL5e91P6GBd650GCLS5_E
      - WL5e91P6GBd700GCLS5_E
      - WL5e91P6GBd750GCLS5_E
      - WL5e91P6GBd800GCLS5_E
      - WL5e91P6GBd200GCNTLS5_O
      - WL5e91P6GBd250GCNTLS5_O
      - WL5e91P6GBd300GCNTLS5_O
      - WL5e91P6GBd350GCNTLS5_O
      - WL5e91P6GBd400GCNTLS5_O
      - WL5e91P6GBd450GCNTLS5_O
      - WL5e91P6GBd500GCNTLS5_O
      - WL5e91P6GBd550GCNTLS5_O
      - WL5e91P6GBd600GCNTLS5_O
      - WL5e91P6GBd650GCNTLS5_O
      - WL5e91P6GBd700GCNTLS5_O
      - WL5e91P6GBd750GCNTLS5_O
      - WL5e91P6GBd800GCNTLS5_O
      - WL5e91P6GBd200GCNTLS5_E
      - WL5e91P6GBd250GCNTLS5_E
      - WL5e91P6GBd300GCNTLS5_E
      - WL5e91P6GBd350GCNTLS5_E
      - WL5e91P6GBd400GCNTLS5_E
      - WL5e91P6GBd450GCNTLS5_E
      - WL5e91P6GBd500GCNTLS5_E
      - WL5e91P6GBd550GCNTLS5_E
      - WL5e91P6GBd600GCNTLS5_E
      - WL5e91P6GBd650GCNTLS5_E
      - WL5e91P6GBd700GCNTLS5_E
      - WL5e91P6GBd750GCNTLS5_E
      - WL5e91P6GBd800GCNTLS5_E
      - WL5e91P6GBd200GCS5_O
      - WL5e91P6GBd250GCS5_O
      - WL5e91P6GBd300GCS5_O
      - WL5e91P6GBd350GCS5_O
      - WL5e91P6GBd400GCS5_O
      - WL5e91P6GBd450GCS5_O
      - WL5e91P6GBd500GCS5_O
      - WL5e91P6GBd550GCS5_O
      - WL5e91P6GBd600GCS5_O
      - WL5e91P6GBd650GCS5_O
      - WL5e91P6GBd700GCS5_O
      - WL5e91P6GBd750GCS5_O
      - WL5e91P6GBd800GCS5_O
      - WL5e91P6GBd200GCS5_E
      - WL5e91P6GBd250GCS5_E
      - WL5e91P6GBd300GCS5_E
      - WL5e91P6GBd350GCS5_E
      - WL5e91P6GBd400GCS5_E
      - WL5e91P6GBd450GCS5_E
      - WL5e91P6GBd500GCS5_E
      - WL5e91P6GBd550GCS5_E
      - WL5e91P6GBd600GCS5_E
      - WL5e91P6GBd650GCS5_E
      - WL5e91P6GBd700GCS5_E
      - WL5e91P6GBd750GCS5_E
      - WL5e91P6GBd800GCS5_E
      - WL5e91P6GBd200GCLD6_O
      - WL5e91P6GBd250GCLD6_O
      - WL5e91P6GBd300GCLD6_O
      - WL5e91P6GBd350GCLD6_O
      - WL5e91P6GBd400GCLD6_O
      - WL5e91P6GBd450GCLD6_O
      - WL5e91P6GBd500GCLD6_O
      - WL5e91P6GBd550GCLD6_O
      - WL5e91P6GBd600GCLD6_O
      - WL5e91P6GBd650GCLD6_O
      - WL5e91P6GBd700GCLD6_O
      - WL5e91P6GBd750GCLD6_O
      - WL5e91P6GBd800GCLD6_O
      - WL5e91P6GBd200GCLD6_E
      - WL5e91P6GBd250GCLD6_E
      - WL5e91P6GBd300GCLD6_E
      - WL5e91P6GBd350GCLD6_E
      - WL5e91P6GBd400GCLD6_E
      - WL5e91P6GBd450GCLD6_E
      - WL5e91P6GBd500GCLD6_E
      - WL5e91P6GBd550GCLD6_E
      - WL5e91P6GBd600GCLD6_E
      - WL5e91P6GBd650GCLD6_E
      - WL5e91P6GBd700GCLD6_E
      - WL5e91P6GBd750GCLD6_E
      - WL5e91P6GBd800GCLD6_E
      - WL5e91P6GBd200GCLS6_O
      - WL5e91P6GBd250GCLS6_O
      - WL5e91P6GBd300GCLS6_O
      - WL5e91P6GBd350GCLS6_O
      - WL5e91P6GBd400GCLS6_O
      - WL5e91P6GBd450GCLS6_O
      - WL5e91P6GBd500GCLS6_O
      - WL5e91P6GBd550GCLS6_O
      - WL5e91P6GBd600GCLS6_O
      - WL5e91P6GBd650GCLS6_O
      - WL5e91P6GBd700GCLS6_O
      - WL5e91P6GBd750GCLS6_O
      - WL5e91P6GBd800GCLS6_O
      - WL5e91P6GBd200GCLS6_E
      - WL5e91P6GBd250GCLS6_E
      - WL5e91P6GBd300GCLS6_E
      - WL5e91P6GBd350GCLS6_E
      - WL5e91P6GBd400GCLS6_E
      - WL5e91P6GBd450GCLS6_E
      - WL5e91P6GBd500GCLS6_E
      - WL5e91P6GBd550GCLS6_E
      - WL5e91P6GBd600GCLS6_E
      - WL5e91P6GBd650GCLS6_E
      - WL5e91P6GBd700GCLS6_E
      - WL5e91P6GBd750GCLS6_E
      - WL5e91P6GBd800GCLS6_E
      - WL5e91P6GBd200GCNTLS6_O
      - WL5e91P6GBd250GCNTLS6_O
      - WL5e91P6GBd300GCNTLS6_O
      - WL5e91P6GBd350GCNTLS6_O
      - WL5e91P6GBd400GCNTLS6_O
      - WL5e91P6GBd450GCNTLS6_O
      - WL5e91P6GBd500GCNTLS6_O
      - WL5e91P6GBd550GCNTLS6_O
      - WL5e91P6GBd600GCNTLS6_O
      - WL5e91P6GBd650GCNTLS6_O
      - WL5e91P6GBd700GCNTLS6_O
      - WL5e91P6GBd750GCNTLS6_O
      - WL5e91P6GBd800GCNTLS6_O
      - WL5e91P6GBd200GCNTLS6_E
      - WL5e91P6GBd250GCNTLS6_E
      - WL5e91P6GBd300GCNTLS6_E
      - WL5e91P6GBd350GCNTLS6_E
      - WL5e91P6GBd400GCNTLS6_E
      - WL5e91P6GBd450GCNTLS6_E
      - WL5e91P6GBd500GCNTLS6_E
      - WL5e91P6GBd550GCNTLS6_E
      - WL5e91P6GBd600GCNTLS6_E
      - WL5e91P6GBd650GCNTLS6_E
      - WL5e91P6GBd700GCNTLS6_E
      - WL5e91P6GBd750GCNTLS6_E
      - WL5e91P6GBd800GCNTLS6_E
      - WL5e91P6GBd200GCS6_O
      - WL5e91P6GBd250GCS6_O
      - WL5e91P6GBd300GCS6_O
      - WL5e91P6GBd350GCS6_O
      - WL5e91P6GBd400GCS6_O
      - WL5e91P6GBd450GCS6_O
      - WL5e91P6GBd500GCS6_O
      - WL5e91P6GBd550GCS6_O
      - WL5e91P6GBd600GCS6_O
      - WL5e91P6GBd650GCS6_O
      - WL5e91P6GBd700GCS6_O
      - WL5e91P6GBd750GCS6_O
      - WL5e91P6GBd800GCS6_O
      - WL5e91P6GBd200GCS6_E
      - WL5e91P6GBd250GCS6_E
      - WL5e91P6GBd300GCS6_E
      - WL5e91P6GBd350GCS6_E
      - WL5e91P6GBd400GCS6_E
      - WL5e91P6GBd450GCS6_E
      - WL5e91P6GBd500GCS6_E
      - WL5e91P6GBd550GCS6_E
      - WL5e91P6GBd600GCS6_E
      - WL5e91P6GBd650GCS6_E
      - WL5e91P6GBd700GCS6_E
      - WL5e91P6GBd750GCS6_E
      - WL5e91P6GBd800GCS6_E
      - WLAI35GBd100GCLD_V2_1_186_1608_900
      - WLAI56GBd400GCLD_V2_1_186_1608_900
      - WLAI56GBd300GCLD_V2_1_186_1608_900
      - WLAI56GBd200GCLD_V2_1_186_1608_900
      - WLAI56GBd100GCLD_V2_1_186_1608_900
      - WLAI35GBd200GCLD_V2_1_186_1608_900
      - WLAI56GBd200GCLD_V2_2_186_1608_900
      - WLAI56GBd100GCLD_V2_2_186_1608_900
      - WLAI35GBd100GCLD_V2_2_186_1608_900
      - WL5e95GBd200GCLD1_O_NL
      - WL5e95GBd200GCLS1_O_NL
      - WL5e95GBd200GCNTLS1_O_NL
      - WL5e95GBd200GCS1_O_NL
      - WL5e95GBd200GCLD2_O_NL
      - WL5e95GBd200GCLS2_O_NL
      - WL5e95GBd200GCNTLS2_O_NL
      - WL5e95GBd200GCS2_O_NL
      - WL5e95GBd200GCLD3_O_NL
      - WL5e95GBd200GCLS3_O_NL
      - WL5e95GBd200GCNTLS3_O_NL
      - WL5e95GBd200GCS3_O_NL
      - WL5e95GBd200GCLD4_O_NL
      - WL5e95GBd200GCLS4_O_NL
      - WL5e95GBd200GCNTLS4_O_NL
      - WL5e95GBd200GCS4_O_NL
      - WL5e95GBd200GCLD_SNR_5_O
      - WL5e95GBd250GCLD_SNR_5_O
      - WL5e95GBd300GCLD_SNR_5_O
      - WL5e95GBd350GCLD_SNR_5_O
      - WL5e95GBd400GCLD_SNR_5_O
      - WL5e95GBd450GCLD_SNR_5_O
      - WL5e95GBd500GCLD_SNR_5_O
      - WL5e95GBd550GCLD_SNR_5_O
      - WL5e95GBd600GCLD_SNR_5_O
      - WL5e95GBd650GCLD_SNR_5_O
      - WL5e95GBd700GCLD_SNR_5_O
      - WL5e95GBd750GCLD_SNR_5_O
      - WL5e95GBd800GCLD_SNR_5_O
      - WL5e95GBd200GCLD_SNR_5_E
      - WL5e95GBd250GCLD_SNR_5_E
      - WL5e95GBd300GCLD_SNR_5_E
      - WL5e95GBd350GCLD_SNR_5_E
      - WL5e95GBd400GCLD_SNR_5_E
      - WL5e95GBd450GCLD_SNR_5_E
      - WL5e95GBd500GCLD_SNR_5_E
      - WL5e95GBd550GCLD_SNR_5_E
      - WL5e95GBd600GCLD_SNR_5_E
      - WL5e95GBd650GCLD_SNR_5_E
      - WL5e95GBd700GCLD_SNR_5_E
      - WL5e95GBd750GCLD_SNR_5_E
      - WL5e95GBd800GCLD_SNR_5_E
      - WL5e95GBd200GCLS_SNR_5_O
      - WL5e95GBd250GCLS_SNR_5_O
      - WL5e95GBd300GCLS_SNR_5_O
      - WL5e95GBd350GCLS_SNR_5_O
      - WL5e95GBd400GCLS_SNR_5_O
      - WL5e95GBd450GCLS_SNR_5_O
      - WL5e95GBd500GCLS_SNR_5_O
      - WL5e95GBd550GCLS_SNR_5_O
      - WL5e95GBd600GCLS_SNR_5_O
      - WL5e95GBd650GCLS_SNR_5_O
      - WL5e95GBd700GCLS_SNR_5_O
      - WL5e95GBd750GCLS_SNR_5_O
      - WL5e95GBd800GCLS_SNR_5_O
      - WL5e95GBd200GCLS_SNR_5_E
      - WL5e95GBd250GCLS_SNR_5_E
      - WL5e95GBd300GCLS_SNR_5_E
      - WL5e95GBd350GCLS_SNR_5_E
      - WL5e95GBd400GCLS_SNR_5_E
      - WL5e95GBd450GCLS_SNR_5_E
      - WL5e95GBd500GCLS_SNR_5_E
      - WL5e95GBd550GCLS_SNR_5_E
      - WL5e95GBd600GCLS_SNR_5_E
      - WL5e95GBd650GCLS_SNR_5_E
      - WL5e95GBd700GCLS_SNR_5_E
      - WL5e95GBd750GCLS_SNR_5_E
      - WL5e95GBd800GCLS_SNR_5_E
      - WL5e95GBd200GCNTLS_SNR_5_O
      - WL5e95GBd250GCNTLS_SNR_5_O
      - WL5e95GBd300GCNTLS_SNR_5_O
      - WL5e95GBd350GCNTLS_SNR_5_O
      - WL5e95GBd400GCNTLS_SNR_5_O
      - WL5e95GBd450GCNTLS_SNR_5_O
      - WL5e95GBd500GCNTLS_SNR_5_O
      - WL5e95GBd550GCNTLS_SNR_5_O
      - WL5e95GBd600GCNTLS_SNR_5_O
      - WL5e95GBd650GCNTLS_SNR_5_O
      - WL5e95GBd700GCNTLS_SNR_5_O
      - WL5e95GBd750GCNTLS_SNR_5_O
      - WL5e95GBd800GCNTLS_SNR_5_O
      - WL5e95GBd200GCNTLS_SNR_5_E
      - WL5e95GBd250GCNTLS_SNR_5_E
      - WL5e95GBd300GCNTLS_SNR_5_E
      - WL5e95GBd350GCNTLS_SNR_5_E
      - WL5e95GBd400GCNTLS_SNR_5_E
      - WL5e95GBd450GCNTLS_SNR_5_E
      - WL5e95GBd500GCNTLS_SNR_5_E
      - WL5e95GBd550GCNTLS_SNR_5_E
      - WL5e95GBd600GCNTLS_SNR_5_E
      - WL5e95GBd650GCNTLS_SNR_5_E
      - WL5e95GBd700GCNTLS_SNR_5_E
      - WL5e95GBd750GCNTLS_SNR_5_E
      - WL5e95GBd800GCNTLS_SNR_5_E
      - WL5e95GBd200GCS_SNR_5_O
      - WL5e95GBd250GCS_SNR_5_O
      - WL5e95GBd300GCS_SNR_5_O
      - WL5e95GBd350GCS_SNR_5_O
      - WL5e95GBd400GCS_SNR_5_O
      - WL5e95GBd450GCS_SNR_5_O
      - WL5e95GBd500GCS_SNR_5_O
      - WL5e95GBd550GCS_SNR_5_O
      - WL5e95GBd600GCS_SNR_5_O
      - WL5e95GBd650GCS_SNR_5_O
      - WL5e95GBd700GCS_SNR_5_O
      - WL5e95GBd750GCS_SNR_5_O
      - WL5e95GBd800GCS_SNR_5_O
      - WL5e95GBd200GCS_SNR_5_E
      - WL5e95GBd250GCS_SNR_5_E
      - WL5e95GBd300GCS_SNR_5_E
      - WL5e95GBd350GCS_SNR_5_E
      - WL5e95GBd400GCS_SNR_5_E
      - WL5e95GBd450GCS_SNR_5_E
      - WL5e95GBd500GCS_SNR_5_E
      - WL5e95GBd550GCS_SNR_5_E
      - WL5e95GBd600GCS_SNR_5_E
      - WL5e95GBd650GCS_SNR_5_E
      - WL5e95GBd700GCS_SNR_5_E
      - WL5e95GBd750GCS_SNR_5_E
      - WL5e95GBd800GCS_SNR_5_E
      - WL5e95GBd200GCLD_SNR_6_O
      - WL5e95GBd250GCLD_SNR_6_O
      - WL5e95GBd300GCLD_SNR_6_O
      - WL5e95GBd350GCLD_SNR_6_O
      - WL5e95GBd400GCLD_SNR_6_O
      - WL5e95GBd450GCLD_SNR_6_O
      - WL5e95GBd500GCLD_SNR_6_O
      - WL5e95GBd550GCLD_SNR_6_O
      - WL5e95GBd600GCLD_SNR_6_O
      - WL5e95GBd650GCLD_SNR_6_O
      - WL5e95GBd700GCLD_SNR_6_O
      - WL5e95GBd750GCLD_SNR_6_O
      - WL5e95GBd800GCLD_SNR_6_O
      - WL5e95GBd200GCLD_SNR_6_E
      - WL5e95GBd250GCLD_SNR_6_E
      - WL5e95GBd300GCLD_SNR_6_E
      - WL5e95GBd350GCLD_SNR_6_E
      - WL5e95GBd400GCLD_SNR_6_E
      - WL5e95GBd450GCLD_SNR_6_E
      - WL5e95GBd500GCLD_SNR_6_E
      - WL5e95GBd550GCLD_SNR_6_E
      - WL5e95GBd600GCLD_SNR_6_E
      - WL5e95GBd650GCLD_SNR_6_E
      - WL5e95GBd700GCLD_SNR_6_E
      - WL5e95GBd750GCLD_SNR_6_E
      - WL5e95GBd800GCLD_SNR_6_E
      - WL5e95GBd200GCLS_SNR_6_O
      - WL5e95GBd250GCLS_SNR_6_O
      - WL5e95GBd300GCLS_SNR_6_O
      - WL5e95GBd350GCLS_SNR_6_O
      - WL5e95GBd400GCLS_SNR_6_O
      - WL5e95GBd450GCLS_SNR_6_O
      - WL5e95GBd500GCLS_SNR_6_O
      - WL5e95GBd550GCLS_SNR_6_O
      - WL5e95GBd600GCLS_SNR_6_O
      - WL5e95GBd650GCLS_SNR_6_O
      - WL5e95GBd700GCLS_SNR_6_O
      - WL5e95GBd750GCLS_SNR_6_O
      - WL5e95GBd800GCLS_SNR_6_O
      - WL5e95GBd200GCLS_SNR_6_E
      - WL5e95GBd250GCLS_SNR_6_E
      - WL5e95GBd300GCLS_SNR_6_E
      - WL5e95GBd350GCLS_SNR_6_E
      - WL5e95GBd400GCLS_SNR_6_E
      - WL5e95GBd450GCLS_SNR_6_E
      - WL5e95GBd500GCLS_SNR_6_E
      - WL5e95GBd550GCLS_SNR_6_E
      - WL5e95GBd600GCLS_SNR_6_E
      - WL5e95GBd650GCLS_SNR_6_E
      - WL5e95GBd700GCLS_SNR_6_E
      - WL5e95GBd750GCLS_SNR_6_E
      - WL5e95GBd800GCLS_SNR_6_E
      - WL5e95GBd200GCNTLS_SNR_6_O
      - WL5e95GBd250GCNTLS_SNR_6_O
      - WL5e95GBd300GCNTLS_SNR_6_O
      - WL5e95GBd350GCNTLS_SNR_6_O
      - WL5e95GBd400GCNTLS_SNR_6_O
      - WL5e95GBd450GCNTLS_SNR_6_O
      - WL5e95GBd500GCNTLS_SNR_6_O
      - WL5e95GBd550GCNTLS_SNR_6_O
      - WL5e95GBd600GCNTLS_SNR_6_O
      - WL5e95GBd650GCNTLS_SNR_6_O
      - WL5e95GBd700GCNTLS_SNR_6_O
      - WL5e95GBd750GCNTLS_SNR_6_O
      - WL5e95GBd800GCNTLS_SNR_6_O
      - WL5e95GBd200GCNTLS_SNR_6_E
      - WL5e95GBd250GCNTLS_SNR_6_E
      - WL5e95GBd300GCNTLS_SNR_6_E
      - WL5e95GBd350GCNTLS_SNR_6_E
      - WL5e95GBd400GCNTLS_SNR_6_E
      - WL5e95GBd450GCNTLS_SNR_6_E
      - WL5e95GBd500GCNTLS_SNR_6_E
      - WL5e95GBd550GCNTLS_SNR_6_E
      - WL5e95GBd600GCNTLS_SNR_6_E
      - WL5e95GBd650GCNTLS_SNR_6_E
      - WL5e95GBd700GCNTLS_SNR_6_E
      - WL5e95GBd750GCNTLS_SNR_6_E
      - WL5e95GBd800GCNTLS_SNR_6_E
      - WL5e95GBd200GCS_SNR_6_O
      - WL5e95GBd250GCS_SNR_6_O
      - WL5e95GBd300GCS_SNR_6_O
      - WL5e95GBd350GCS_SNR_6_O
      - WL5e95GBd400GCS_SNR_6_O
      - WL5e95GBd450GCS_SNR_6_O
      - WL5e95GBd500GCS_SNR_6_O
      - WL5e95GBd550GCS_SNR_6_O
      - WL5e95GBd600GCS_SNR_6_O
      - WL5e95GBd650GCS_SNR_6_O
      - WL5e95GBd700GCS_SNR_6_O
      - WL5e95GBd750GCS_SNR_6_O
      - WL5e95GBd800GCS_SNR_6_O
      - WL5e95GBd200GCS_SNR_6_E
      - WL5e95GBd250GCS_SNR_6_E
      - WL5e95GBd300GCS_SNR_6_E
      - WL5e95GBd350GCS_SNR_6_E
      - WL5e95GBd400GCS_SNR_6_E
      - WL5e95GBd450GCS_SNR_6_E
      - WL5e95GBd500GCS_SNR_6_E
      - WL5e95GBd550GCS_SNR_6_E
      - WL5e95GBd600GCS_SNR_6_E
      - WL5e95GBd650GCS_SNR_6_E
      - WL5e95GBd700GCS_SNR_6_E
      - WL5e95GBd750GCS_SNR_6_E
      - WL5e95GBd800GCS_SNR_6_E
      - WL5e95GBd800GCLS_V2_SNR_1_E
      - WL5e95GBd800GCLS_V2_SNR_2_E
      - FOREIGN_DWDM_START
      - FOREIGN_DWDM_1
      - FOREIGN_DWDM_2
      - FOREIGN_DWDM_3
      - FOREIGN_DWDM_4
      - FOREIGN_DWDM_5
      - FOREIGN_DWDM_6
      - FOREIGN_DWDM_7
      - FOREIGN_DWDM_8
      - FOREIGN_DWDM_9
      - FOREIGN_DWDM_10
      - FOREIGN_DWDM_11
      - FOREIGN_DWDM_12
      - FOREIGN_DWDM_13
      - FOREIGN_DWDM_14
      - FOREIGN_DWDM_15
      - FOREIGN_DWDM_16
      - FOREIGN_DWDM_17
      - FOREIGN_DWDM_18
      - FOREIGN_DWDM_19
      - FOREIGN_DWDM_20
      - FOREIGN_DWDM_TEMPLATE_END
      - FOREIGN_DWDM_1_CLS
      - FOREIGN_DWDM_1_CNTLS
      - FOREIGN_DWDM_1_CS
      - FOREIGN_DWDM_2_CLS
      - FOREIGN_DWDM_2_CNTLS
      - FOREIGN_DWDM_2_CS
      - FOREIGN_DWDM_3_CLS
      - FOREIGN_DWDM_3_CNTLS
      - FOREIGN_DWDM_3_CS
      - FOREIGN_DWDM_4_CLS
      - FOREIGN_DWDM_4_CNTLS
      - FOREIGN_DWDM_4_CS
      - FOREIGN_DWDM_5_CLS
      - FOREIGN_DWDM_5_CNTLS
      - FOREIGN_DWDM_5_CS
      - FOREIGN_DWDM_6_CLS
      - FOREIGN_DWDM_6_CNTLS
      - FOREIGN_DWDM_6_CS
      - FOREIGN_DWDM_7_CLS
      - FOREIGN_DWDM_7_CNTLS
      - FOREIGN_DWDM_7_CS
      - FOREIGN_DWDM_8_CLS
      - FOREIGN_DWDM_8_CNTLS
      - FOREIGN_DWDM_8_CS
      - FOREIGN_DWDM_9_CLS
      - FOREIGN_DWDM_9_CNTLS
      - FOREIGN_DWDM_9_CS
      - FOREIGN_DWDM_10_CLS
      - FOREIGN_DWDM_10_CNTLS
      - FOREIGN_DWDM_10_CS
      - FOREIGN_DWDM_11_CLS
      - FOREIGN_DWDM_11_CNTLS
      - FOREIGN_DWDM_11_CS
      - FOREIGN_DWDM_12_CLS
      - FOREIGN_DWDM_12_CNTLS
      - FOREIGN_DWDM_12_CS
      - FOREIGN_DWDM_13_CLS
      - FOREIGN_DWDM_13_CNTLS
      - FOREIGN_DWDM_13_CS
      - FOREIGN_DWDM_14_CLS
      - FOREIGN_DWDM_14_CNTLS
      - FOREIGN_DWDM_14_CS
      - FOREIGN_DWDM_15_CLS
      - FOREIGN_DWDM_15_CNTLS
      - FOREIGN_DWDM_15_CS
      - FOREIGN_DWDM_16_CLS
      - FOREIGN_DWDM_16_CNTLS
      - FOREIGN_DWDM_16_CS
      - FOREIGN_DWDM_17_CLS
      - FOREIGN_DWDM_17_CNTLS
      - FOREIGN_DWDM_17_CS
      - FOREIGN_DWDM_18_CLS
      - FOREIGN_DWDM_18_CNTLS
      - FOREIGN_DWDM_18_CS
      - FOREIGN_DWDM_19_CLS
      - FOREIGN_DWDM_19_CNTLS
      - FOREIGN_DWDM_19_CS
      - FOREIGN_DWDM_20_CLS
      - FOREIGN_DWDM_20_CNTLS
      - FOREIGN_DWDM_20_CS
      - FOREIGN_DWDM_END_ALL
      - UNMODELED_EDC40G
      - UNMODELED_16QAM200G
      - UNMODELED_8QAM150G
      - UNMODELED_4ASK100G
      - UNMODELED_QPSK100G
      type: string
    PlannedData.OmsValidationFrequencyData:
      title: PlannedData.OmsValidationFrequencyData
      type: object
      properties:
        frequency_GHz:
          type: number
        inputPower_mW:
          type: number
        inputLinearNoise_mW:
          type: number
        outputPower_mW:
          type: number
        outputLinearNoise_mW:
          type: number
        incrementalLinearNoise_mW:
          type: number
        incrementalNonlinearNoise_mW:
          type: number
        incrementalSnrExt:
          type: number
    PlannedData.OmsValidationResults:
      title: PlannedData.OmsValidationResults
      type: object
      properties:
        dwdmEquipType:
          $ref: '#/components/schemas/Common.TerminationEquipmentType'
        bias_dB:
          type: number
        bwEff_GHz:
          type: number
        omsValidationFrequencyData:
          type: array
          items:
            $ref: '#/components/schemas/PlannedData.OmsValidationFrequencyData'
          description: ''
    PlannedData.OmsAttributes:
      title: PlannedData.OmsAttributes
      type: object
      properties:
        omsValidationResults:
          type: array
          items:
            $ref: '#/components/schemas/PlannedData.OmsValidationResults'
          description: ''
    PlannedData.OmsData:
      title: PlannedData.OmsData
      type: object
      properties:
        id:
          type: string
        attributes:
          $ref: '#/components/schemas/PlannedData.OmsAttributes'
    PlannedData.OmsList:
      title: PlannedData.OmsList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlannedData.OmsData'
          description: ''
    Common.Rate:
      title: Common.Rate
      enum:
      - DSR_10GE
      - DSR_100GE
      - DSR_400GE
      - OTM2
      - OTM4
      - OC192
      - STM64
      type: string
    ServiceProvisioningPolicy.PluggableRecord:
      title: ServiceProvisioningPolicy.PluggableRecord
      required:
      - rate
      - pec
      type: object
      properties:
        rate:
          $ref: '#/components/schemas/Common.Rate'
        pec:
          type: string
    ServiceProvisioningPolicy.CardPolicy:
      title: ServiceProvisioningPolicy.CardPolicy
      required:
      - cardPec
      - certifiedMatePecs
      - certifiedClientPluggables
      type: object
      properties:
        cardPec:
          type: string
        certifiedMatePecs:
          type: array
          items:
            type: string
          description: ''
        certifiedClientPluggables:
          type: array
          items:
            $ref: '#/components/schemas/ServiceProvisioningPolicy.PluggableRecord'
          description: ''
        certifiedTPTs:
          type: array
          items:
            type: string
          description: ''
    ServiceProvisioningPolicy.ServiceProvisioningPolicy:
      title: ServiceProvisioningPolicy.ServiceProvisioningPolicy
      required:
      - cardPolicies
      type: object
      properties:
        cardPolicies:
          type: array
          items:
            $ref: '#/components/schemas/ServiceProvisioningPolicy.CardPolicy'
          description: ''
    HeatDissipationThresholdPolicy.SiteHeatDissipationPolicy:
      title: HeatDissipationThresholdPolicy.SiteHeatDissipationPolicy
      required:
      - clli
      - heatDissipationThreshold
      type: object
      properties:
        clli:
          type: string
        heatDissipationThreshold:
          $ref: '#/components/schemas/HeatDissipationThresholdPolicy.HeatDissipationThreshold'
    HeatDissipationThresholdPolicy.BayHeatDissipationPolicy:
      title: HeatDissipationThresholdPolicy.BayHeatDissipationPolicy
      required:
      - bay
      - heatDissipationThreshold
      type: object
      properties:
        bay:
          $ref: '#/components/schemas/Common.EndpointLocation'
        heatDissipationThreshold:
          $ref: '#/components/schemas/HeatDissipationThresholdPolicy.HeatDissipationThreshold'
    HeatDissipationThresholdPolicy.HeatDissipationThresholdPolicy:
      title: HeatDissipationThresholdPolicy.HeatDissipationThresholdPolicy
      type: object
      properties:
        globalHeatDissipationPolicy:
          $ref: '#/components/schemas/HeatDissipationThresholdPolicy.HeatDissipationThreshold'
        siteHeatDissipationPolicies:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationThresholdPolicy.SiteHeatDissipationPolicy'
          description: ''
        bayHeatDissipationPolicies:
          type: array
          items:
            $ref: '#/components/schemas/HeatDissipationThresholdPolicy.BayHeatDissipationPolicy'
          description: ''
    PlanningPolicy.UserActivityInfo:
      title: PlanningPolicy.UserActivityInfo
      type: object
      properties:
        createdByUserName:
          type: string
        creationTime:
          type: string
          format: date-time
        lastModifiedByUserName:
          type: string
        lastModifiedTime:
          type: string
          format: date-time
    PlanningPolicy.PlanningPolicy:
      title: PlanningPolicy.PlanningPolicy
      required:
      - name
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        serviceProvisioningPolicy:
          $ref: '#/components/schemas/ServiceProvisioningPolicy.ServiceProvisioningPolicy'
        heatDissipationThresholdPolicy:
          $ref: '#/components/schemas/HeatDissipationThresholdPolicy.HeatDissipationThresholdPolicy'
        userActivityInfo:
          $ref: '#/components/schemas/PlanningPolicy.UserActivityInfo'
    Reports.OmsNode:
      title: Reports.OmsNode
      required:
      - node
      - aid
      type: object
      properties:
        node:
          $ref: '#/components/schemas/Common.NodeIdentity'
        aid:
          type: string
    Reports.Oms:
      title: Reports.Oms
      required:
      - sourceNode
      - destinationNode
      type: object
      properties:
        sourceNode:
          $ref: '#/components/schemas/Reports.OmsNode'
        destinationNode:
          $ref: '#/components/schemas/Reports.OmsNode'
        domain:
          type: string
        roadmLineLabel:
          type: string
    Reports.OmsReport:
      title: Reports.OmsReport
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Reports.Oms'
          description: ''
    EquipmentReportItemChangeTypeTypes:
      title: EquipmentReportItemChangeTypeTypes
      enum:
      - Added
      - Removed
      - Modified
      - Undefined
      type: string
    Reports.EquipmentReportItem:
      title: Reports.EquipmentReportItem
      required:
      - equipmentSpec
      - location
      - changeType
      type: object
      properties:
        node:
          $ref: '#/components/schemas/Common.NodeIdentity'
        equipmentSpec:
          $ref: '#/components/schemas/Common.EquipmentSpec'
        location:
          $ref: '#/components/schemas/Common.Location'
        changeType:
          $ref: '#/components/schemas/EquipmentReportItemChangeTypeTypes'
    Reports.EquipmentReport:
      title: Reports.EquipmentReport
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Reports.EquipmentReportItem'
          description: ''
    Automation.PhotonicNodeReportItem:
      title: Automation.PhotonicNodeReportItem
      type: object
      properties:
        Tid:
          type: string
        SiteName:
          type: string
        SiteId:
          type: integer
          format: int32
        SiteType:
          type: string
        IsControlPlaneAvailable:
          type: boolean
        CpMode:
          type: string
        TotalFlexgridEnabledRoadmDegrees:
          type: integer
          format: int32
        TotalNumOfShelves:
          type: integer
          format: int32
        PhotonicShelfCount:
          type: integer
          format: int32
        ShelfType:
          type: string
        ShelfPEC:
          type: string
        IsDge:
          type: string
        IsAccessAllowed:
          type: string
        MaxOtsPerShelf:
          type: integer
          format: int32
        IsConnectToLocalOpm:
          type: string
        Lattitude:
          type: number
        Longitude:
          type: number
        OsrpNodeName:
          type: string
        OsrpNodeId:
          type: string
        Notes:
          type: string
        WssType:
          type: string
        LongName:
          type: string
    Automation.TdmNodeReportItem:
      title: Automation.TdmNodeReportItem
      type: object
      properties:
        NodeName:
          type: string
        NodeType:
          type: string
    Automation.TdmOSRPReportItem:
      title: Automation.TdmOSRPReportItem
      type: object
      properties:
        FromNodeName:
          type: string
        ToNodeName:
          type: string
        AdminWt:
          type: string
        Delay:
          type: string
        TotalBW:
          type: string
        Status:
          type: string
        Label:
          type: string
        Utilization:
          type: string
    Automation.TdmLineReportItem:
      title: Automation.TdmLineReportItem
      type: object
      properties:
        Size:
          type: string
        TdmSncs:
          type: string
        TdmSncps:
          type: string
        Label:
          type: string
        Utilization:
          type: string
    Automation.TdmSncReportItem:
      title: Automation.TdmSncReportItem
      type: object
      properties:
        SourceNode:
          type: string
        DestinationNode:
          type: string
        Size:
          type: string
        PrimaryOVPN:
          type: string
        SecondaryOVPN:
          type: string
        Status:
          type: string
        IsOnHomeRoute:
          type: string
        Label:
          type: string
        IsMeshRestorable:
          type: boolean
        Name:
          type: string
        SourceClientPortAid:
          type: string
        DestinationClientPortAid:
          type: string
        Customer:
          type: string
        ClientType:
          type: string
        McpNotes:
          type: string
    Automation.TdmSncpReportItem:
      title: Automation.TdmSncpReportItem
      type: object
      properties:
        Size:
          type: string
        PrimaryOVPN:
          type: string
        SecondaryOVPN:
          type: string
        Status:
          type: string
        Label:
          type: string
        MeshRestorable:
          type: string
    Automation.TransportTunnelReportItem:
      title: Automation.TransportTunnelReportItem
      type: object
      properties:
        ClientService:
          type: string
        Status:
          type: string
        Type:
          type: string
    Automation.ClientServiceReportItem:
      title: Automation.ClientServiceReportItem
      type: object
      properties:
        Status:
          type: string
        Type:
          type: string
    Automation.PhotonicSncReportItem:
      title: Automation.PhotonicSncReportItem
      type: object
      properties:
        Name:
          type: string
        CircuitId:
          type: string
        Label:
          type: string
        Notes:
          type: string
        ImportNotes:
          type: string
        IsOpsEnabled:
          type: boolean
        CurrentSourceAddDrop:
          type: string
        CurrentDestinationAddDrop:
          type: string
        Sncp:
          type: string
        SourceSite:
          type: string
        DestinationSite:
          type: string
        SourceNetworkElement:
          type: string
        DestinationNetworkElement:
          type: string
        ModulationClass:
          type: string
        PhotonicDWDMInterface:
          type: string
        LineCard:
          type: string
        LineCardPEC:
          type: string
        SAStatus:
          type: string
        PhotonicSncg:
          type: string
        PlanningStatus:
          type: string
        OpticalChannel:
          type: string
        Wavelength:
          type: string
        CentralFrequency:
          type: number
        SelectedSourceCMDAid:
          type: string
        SelectedDestinationCMDAid:
          type: string
        SelectedSourceCMDPort:
          type: string
        SelectedDestinationCMDPort:
          type: string
        ControlPlane:
          type: boolean
        PlanningTimeStamp:
          type: string
        Cktid:
          type: string
        ArdType:
          type: string
        ServiceId:
          type: string
        SncMate:
          type: string
        Role:
          type: string
        RegenSites:
          type: string
    Automation.OpticalChannelReportItem:
      title: Automation.OpticalChannelReportItem
      type: object
      properties:
        OchName:
          type: string
        PreFecBitErrorRate:
          type: string
        PostFecBitErrorRate:
          type: string
        MeasuredCD:
          type: number
        MeasuredPMD:
          type: number
        MeasuredLatency:
          type: number
    Automation.PhotonicDtlTxInfoReportItem:
      title: Automation.PhotonicDtlTxInfoReportItem
      type: object
      properties:
        TransmissionMode:
          type: string
        CmdAid:
          type: string
        CentralFrequency:
          type: number
        LinkOptimizationMode:
          type: string
        OnepSncgs:
          type: string
        OnepSncs:
          type: string
    Automation.PhotonicDtlReportItem:
      title: Automation.PhotonicDtlReportItem
      type: object
      properties:
        Name:
          type: string
        SourceSite:
          type: string
        DestinationSite:
          type: string
        ChannelCapacity:
          type: string
        PhotonicDtlTxInfo:
          type: array
          items:
            $ref: '#/components/schemas/Automation.PhotonicDtlTxInfoReportItem'
          description: ''
        CascadedDTLsOrder:
          type: string
        CascadedDTLsAdjacency:
          type: string
        RegenLocation:
          type: string
        NumberOfRegens:
          type: integer
          format: int32
        DtlProvisioningData:
          type: string
    Automation.OpsSncpsReportItem:
      title: Automation.OpsSncpsReportItem
      type: object
      properties:
        ServiceId:
          type: string
        SourceId:
          type: string
        DestinationId:
          type: string
        Sncs:
          type: string
        Status:
          type: string
    Automation.DtlSetReportItem:
      title: Automation.DtlSetReportItem
      type: object
      properties:
        Id:
          type: string
        SourceId:
          type: string
        DestinationId:
          type: string
        DtlOrder:
          type: string
        PSncs:
          type: string
    Automation.CcmdLocReportItem:
      title: Automation.CcmdLocReportItem
      type: object
      properties:
        Filter:
          type: string
        Site:
          type: string
        Tid:
          type: string
        Shelf:
          type: integer
          format: int32
        Slot:
          type: integer
          format: int32
        LocMode:
          type: string
        RefTxRx:
          type: string
        McpoValue:
          type: number
    Automation.DwdmAdjacencyReportItem:
      title: Automation.DwdmAdjacencyReportItem
      type: object
      properties:
        SncName:
          type: string
        TxMinpower:
          type: string
        TxMaxpower:
          type: string
        TxCurpower:
          type: string
        TxExcessloss:
          type: string
        RxNominput:
          type: string
        RxOverthereshold:
          type: string
        RxSensthreshold:
          type: string
        RxExcessloss:
          type: string
    Automation.FiberTlReportItem:
      title: Automation.FiberTlReportItem
      type: object
      properties:
        Status:
          type: string
        SimualtionAction:
          type: string
        Notes:
          type: string
        FiberName:
          type: string
        Label:
          type: string
    Automation.PhotonicOsrpSncpReportItem:
      title: Automation.PhotonicOsrpSncpReportItem
      type: object
      properties:
        ServiceId:
          type: string
        SourceId:
          type: string
        DestinationId:
          type: string
        Sncs:
          type: string
        Status:
          type: string
        SimulationAction:
          type: string
    Automation.ShelfReportItem:
      title: Automation.ShelfReportItem
      type: object
      properties:
        Tid:
          type: string
        ShelfId:
          type: integer
          format: int32
        SiteId:
          type: integer
          format: int32
        SiteGroup:
          type: string
        ShelfVersion:
          type: string
    Automation.NetworkReportData:
      title: Automation.NetworkReportData
      type: object
      properties:
        PhotonicNodeData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.PhotonicNodeReportItem'
          description: ''
        TdmNodeData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.TdmNodeReportItem'
          description: ''
        TdmOSRPData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.TdmOSRPReportItem'
          description: ''
        TdmLineData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.TdmLineReportItem'
          description: ''
        TdmSncData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.TdmSncReportItem'
          description: ''
        TdmSncpData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.TdmSncpReportItem'
          description: ''
        TransportTunnelData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.TransportTunnelReportItem'
          description: ''
        ClientServiceData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.ClientServiceReportItem'
          description: ''
        PhotonicNodeDataCount:
          type: integer
          format: int32
        PhotonicSnc:
          type: array
          items:
            $ref: '#/components/schemas/Automation.PhotonicSncReportItem'
          description: ''
        PhotonicSncDataCount:
          type: integer
          format: int32
        OpticalChannelData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.OpticalChannelReportItem'
          description: ''
        OpticalChannelDataCount:
          type: integer
          format: int32
        PhotonicDtl:
          type: array
          items:
            $ref: '#/components/schemas/Automation.PhotonicDtlReportItem'
          description: ''
        PhotonicDtlDataCount:
          type: integer
          format: int32
        OpsSncps:
          type: array
          items:
            $ref: '#/components/schemas/Automation.OpsSncpsReportItem'
          description: ''
        OpsSncpsDataCount:
          type: integer
          format: int32
        DtlSets:
          type: array
          items:
            $ref: '#/components/schemas/Automation.DtlSetReportItem'
          description: ''
        DtlSetDataCount:
          type: integer
          format: int32
        CcmdLocData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.CcmdLocReportItem'
          description: ''
        DwdmAdjacencyData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.DwdmAdjacencyReportItem'
          description: ''
        DwdmAdjacencyDataCount:
          type: integer
          format: int32
        EquipmentData:
          type: array
          items:
            $ref: '#/components/schemas/Reports.EquipmentReportItem'
          description: ''
        EquipmentDataCount:
          type: integer
          format: int32
        CcmdLocDataCount:
          type: integer
          format: int32
        FiberDataCount:
          type: integer
          format: int32
        FiberData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.FiberTlReportItem'
          description: ''
        PhotonicOsrpSncpsData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.PhotonicOsrpSncpReportItem'
          description: ''
        ShelvesData:
          type: array
          items:
            $ref: '#/components/schemas/Automation.ShelfReportItem'
          description: ''
    Reports.EquipmentDeltaReport:
      title: Reports.EquipmentDeltaReport
      required:
      - added
      - removed
      type: object
      properties:
        added:
          type: array
          items:
            $ref: '#/components/schemas/Reports.EquipmentReportItem'
          description: ''
        removed:
          type: array
          items:
            $ref: '#/components/schemas/Reports.EquipmentReportItem'
          description: ''
    ProjectNodeAndEquipmentDataItemChangeTypeTypes:
      title: ProjectNodeAndEquipmentDataItemChangeTypeTypes
      enum:
      - Added
      - Removed
      - Modified
      - Undefined
      type: string
    Reports.ProjectNodeAndEquipmentDataItem:
      title: Reports.ProjectNodeAndEquipmentDataItem
      required:
      - node
      - changeType
      type: object
      properties:
        node:
          $ref: '#/components/schemas/Common.NodeIdentity'
        changeType:
          $ref: '#/components/schemas/ProjectNodeAndEquipmentDataItemChangeTypeTypes'
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/Reports.EquipmentReportItem'
          description: ''
    Reports.ProjectNodeAndEquipmentDataReport:
      title: Reports.ProjectNodeAndEquipmentDataReport
      required:
      - source
      type: object
      properties:
        generationDate:
          type: string
          format: date-time
        source:
          $ref: '#/components/schemas/Common.Source'
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Reports.ProjectNodeAndEquipmentDataItem'
          description: ''
    RuleExecutionResultStatusTypes:
      title: RuleExecutionResultStatusTypes
      enum:
      - Passed
      - Failed
      type: string
    RuleExecutionResultSeverityTypes:
      title: RuleExecutionResultSeverityTypes
      enum:
      - Error
      - Warning
      - Information
      type: string
    Common.RuleExecutionResult:
      title: Common.RuleExecutionResult
      type: object
      properties:
        generationDate:
          type: string
          format: date-time
        version:
          type: string
        source:
          $ref: '#/components/schemas/Common.Source'
        status:
          $ref: '#/components/schemas/RuleExecutionResultStatusTypes'
        severity:
          $ref: '#/components/schemas/RuleExecutionResultSeverityTypes'
        title:
          type: string
        description:
          type: string
        details:
          type: string
    Reports.RuleExecutionReport:
      title: Reports.RuleExecutionReport
      type: object
      properties:
        generationDate:
          type: string
          format: date-time
        version:
          type: string
        source:
          $ref: '#/components/schemas/Common.Source'
        results:
          type: array
          items:
            $ref: '#/components/schemas/Common.RuleExecutionResult'
          description: ''
    EquipmentGroupAttributesRO:
      title: EquipmentGroupAttributesRO
      type: object
      properties:
        name:
          type: string
          description: Deprecated
        type:
          type: string
          description: The equipment group type
        subType:
          type: string
          description: The equipment group sub type
        userData:
          type: object
        identifiers:
          type: array
          items:
            type: object
          description: ''
        additionalAttributes:
          type: object
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
    EquipmentGroupDataRO:
      title: EquipmentGroupDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the equipment group resource
        type:
          $ref: '#/components/schemas/Type27'
        attributes:
          $ref: '#/components/schemas/EquipmentGroupAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentGroupRelationshipsRO'
    EquipmentGroupElementAttributesRO:
      title: EquipmentGroupElementAttributesRO
      type: object
      properties:
        name:
          type: string
        startDate:
          type: string
          description: The scheduled start date and time of the expectation, with RFC 3339 date-time format
        endDate:
          type: string
          description: The scheduled end date and time of the expectation, with RFC 3339 date-time format
        additionalAttributes:
          type: object
    EquipmentGroupExpectationDataRO:
      title: EquipmentGroupExpectationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the equipment group expectation
        type:
          $ref: '#/components/schemas/Type28'
        attributes:
          $ref: '#/components/schemas/EquipmentGroupElementAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentGroupExpectationRelationshipsRO'
    EquipmentGroupExpectationListRO:
      title: EquipmentGroupExpectationListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentGroupExpectationDataRO'
          description: ''
    EquipmentGroupExpectationRO:
      title: EquipmentGroupExpectationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentGroupExpectationDataRO'
    EquipmentGroupExpectationRelationshipsRO:
      title: EquipmentGroupExpectationRelationshipsRO
      type: object
      properties:
        equipment:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        parent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        intent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    EquipmentGroupListRO:
      title: EquipmentGroupListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentGroupDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Referenced sub-resources
    EquipmentGroupRO:
      title: EquipmentGroupRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        data:
          $ref: '#/components/schemas/EquipmentGroupDataRO'
        included:
          type: array
          items:
            type: object
          description: Referenced sub-resources
    EquipmentGroupRelationshipsRO:
      title: EquipmentGroupRelationshipsRO
      type: object
      properties:
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipment:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        parent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        expectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        discovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        planned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    EquipmentHolderAttributesRO:
      title: EquipmentHolderAttributesRO
      type: object
      properties:
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
        nativeName:
          type: string
        category:
          $ref: '#/components/schemas/Category3'
        state:
          $ref: '#/components/schemas/State4'
        parentEquipmentLocation:
          $ref: '#/components/schemas/LocationRO'
        userData:
          type: object
        identifiers:
          type: array
          items:
            type: object
          description: ''
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
        additionalAttributes:
          type: object
    EquipmentHolderDataRO:
      title: EquipmentHolderDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the equipment holder resource
        type:
          $ref: '#/components/schemas/Type29'
        attributes:
          $ref: '#/components/schemas/EquipmentHolderAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentHolderRelationshipsRO'
    EquipmentHolderRO:
      title: EquipmentHolderRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        data:
          $ref: '#/components/schemas/EquipmentHolderDataRO'
    EquipmentHolderRelationshipsRO:
      title: EquipmentHolderRelationshipsRO
      type: object
      properties:
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    AccessPoint:
      title: AccessPoint
      type: object
      properties:
        adaptsToLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        adaptsToLayerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        cardinality:
          type: string
          description: Number of possible potential TPEs. Can be a numeric (eg '1', '96', '1000', ...) or can be categorical (eg 'indirect').
        clientTpeRulesInOwnLayer:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRule'
          description: Directions of how to instantiate client TPE(s) for this access point, including indirect (client over client) client TPE instantiation.
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRule'
        regenIdPackage:
          $ref: '#/components/schemas/RegenIdPackage'
        eDtlRegenIdPackage:
          $ref: '#/components/schemas/eDtlRegenIdPackage'
        cascadedDtlTpePackage:
          $ref: '#/components/schemas/CascadedDtlTpePackage'
        mirroringBandwidthRules:
          type: string
          description: The mirroringBandwithRules for capacity calculation
        mirroringNamingRules:
          type: string
          description: The mirroringNamingRules for capacity calculation
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        potentialGrowthCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        namingRules:
          type: array
          items:
            $ref: '#/components/schemas/NamingRules'
          description: ''
        stitchingConstraint:
          $ref: '#/components/schemas/StitchingConstraint'
    AdaptationPool:
      title: AdaptationPool
      type: object
      properties:
        name:
          type: string
          description: Name of the AdaptationPool. Unique in the scope of this TPE.
        logicalRule:
          $ref: '#/components/schemas/LogicalRule'
        poolAdapters:
          type: array
          items:
            $ref: '#/components/schemas/Adapter'
          description: ''
        memberAdaptationPools:
          type: array
          items:
            type: string
          description: Reference(s) to 0 or more member AdaptationPool-s. Allows for nesting of AdaptationPools.
        namingRules:
          type: object
    Adapter:
      title: Adapter
      type: object
      properties:
        name:
          type: string
          description: Name of the Adapter. Unique in the scope of this TPE.
        adaptsToLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        adaptsToLayerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        poolAdapterType:
          type: string
          description: The type for the adapter.
        connectionRulesInAdaptationLayer:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRule'
          description: Directions of how to instantiate client TPE(s) for this adapter, including indirect (client over client) client TPE instantiation.
        cardinality:
          type: string
          description: Number of possible potential TPEs. Can be a numeric (eg '1', '96', '1000', ...) or can be categorical (eg 'indirect').
        continuousAdapterRulesPackage:
          $ref: '#/components/schemas/ContinuousAdapterRulesPackage'
        mappingInteractionRules:
          type: array
          items:
            $ref: '#/components/schemas/MappingInteractionRule'
          description: The specification of the interaction between the support for different client layer protocols signals.
        potentialAdapterCapacities:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: Total potential capacity of this Adapter.
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRule'
        photonicSpectrumPackage:
          $ref: '#/components/schemas/PhotonicSpectrumPackage'
        nameToCapacityMappingRules:
          type: array
          items:
            $ref: '#/components/schemas/NameToCapacityMappingRules'
          description: ''
        eFreTerminationState:
          $ref: '#/components/schemas/EFreTerminationState'
        additionalAttributes:
          type: object
        mirroringBandwidthRules:
          type: string
          description: The mirroringBandwithRules for capacity calculation
        mirroringNamingRules:
          type: string
          description: The mirroringNamingRules for capacity calculation
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        potentialGrowthCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        namingRules:
          type: array
          items:
            $ref: '#/components/schemas/NamingRules'
          description: ''
        stitchingConstraint:
          $ref: '#/components/schemas/StitchingConstraint'
    AdjacencyPackage:
      title: AdjacencyPackage
      type: object
      properties:
        adjacencyType:
          type: string
          description: 'This field delimits the adjacency type between two network elements (Ex: LIM, LINE, etc...).'
        localTag:
          type: string
          description: The actual tag of the originating network element.
        localTagFormat:
          type: string
          description: The format of the local adjacency tag.
        provisionedRemoteTag:
          type: string
          description: The provisioned remote tag is the expected destination defined by the user that adheres to the remoteTagFormat.
        provisionedRemoteTagFormat:
          type: string
          description: The format of the remote provisioning adjacency tag.
        remoteTag:
          type: string
          description: The actual remote tag as discovered by the network element.
        remoteTagFormat:
          type: string
          description: The format of the remote adjacency tag.
        topologySourceTag:
          type: string
          description: The tag representing the topological state. This could be 'DISCOVERED', for example.
        adjacencyMechanism:
          type: string
          description: The attribute defining the adjacency mechanism used.
        linkAttributes:
          $ref: '#/components/schemas/LinkAttributes'
    BandwidthThreshold:
      title: BandwidthThreshold
      type: object
      properties:
        ODU0:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU0) advertised for a link.
        ODU1:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU1) advertised for a link.
        ODU2:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU2) advertised for a link.
        ODU2E:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU2E) advertised for a link.
        ODU3:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU3) advertised for a link.
        ODU4:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU4) advertised for a link.
        ODUFLEXRSZ:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (in Bps) for Resizable ODU Flex advertised for a link.
        ODUFLEXNRSZ:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (in Bps) for Non-Resizable ODU Flex advertised for a link.
    Bfd:
      title: Bfd
      type: object
      properties:
        bfdType:
          $ref: '#/components/schemas/BfdType'
        configured:
          type: boolean
          description: True when BFD is enabled on this endpoint
          default: false
        profileName:
          type: string
          description: The profile name associated with this set of BFD attributes
        adminState:
          $ref: '#/components/schemas/AdminState'
        operationalState:
          $ref: '#/components/schemas/OperationalState'
        role:
          $ref: '#/components/schemas/Role1'
        transmitInterval:
          type: string
          description: The interval between transmitting BFD messages
        receiveInterval:
          type: string
          description: The interval between receiving BFD messages
        ipEncapsulation:
          type: boolean
          description: To report IP settings on the interface
          default: false
        pathType:
          $ref: '#/components/schemas/PathType'
        srcAddress:
          type: string
          description: Local IP address
        destAddress:
          type: string
          description: IP address of the peer
        localMultiplier:
          type: integer
          description: The negotiated transmit interval, multiplied by this value, provides the Detection Time for the receiving system
          format: int32
        desiredMinTxInterval:
          type: string
          description: Rate at which BFD Control packets are transmitted to the remote system
        requiredMinRxInterval:
          type: string
          description: Rate at which BFD Control packets arrive from the remote system
        sourcePort:
          type: integer
          description: Source UDP port valid only when IP encapsulation is used
          format: int32
        destPort:
          type: integer
          description: Destination UDP port valid only when IP encapsulation is used
          format: int32
        diagnostic:
          type: string
          description: A diagnostic code specifying the local system's reason for the last change in session state
        mhop:
          type: boolean
          description: True when multihop IP BFD is enabled for BGP on this endpoint
          default: false
    BgpAddPath:
      title: BgpAddPath
      type: object
      properties:
        capability:
          $ref: '#/components/schemas/Capability'
        advertise:
          $ref: '#/components/schemas/Advertise'
        diversePath:
          type: boolean
          description: BGP PIC Diverse Path.
          default: false
    BgpAfiSafi:
      title: BgpAfiSafi
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        activated:
          type: boolean
          description: true if activated otherwise false
          default: false
        grCapability:
          $ref: '#/components/schemas/GrCapability'
        prefixList:
          $ref: '#/components/schemas/AfiSafiPrefixList'
        orf:
          $ref: '#/components/schemas/AfiSafiOrf'
        addPath:
          $ref: '#/components/schemas/BgpAddPath'
        routeMap:
          type: array
          items:
            $ref: '#/components/schemas/BgpRouteMap'
          description: ''
        rrEnabled:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
        nextHopSelf:
          $ref: '#/components/schemas/AfiSafiNextHopSelf'
    BgpBfd:
      title: BgpBfd
      type: object
      properties:
        configured:
          type: boolean
          description: True when BFD is enabled on this endpoint
          default: false
        profileName:
          type: string
          description: The profile name associated with this set of BFD attributes
        adminState:
          $ref: '#/components/schemas/AdminState'
        operationalState:
          $ref: '#/components/schemas/OperationalState'
        role:
          $ref: '#/components/schemas/Role1'
        transmitInterval:
          type: string
          description: The interval between transmitting BFD messages
        receiveInterval:
          type: string
          description: The interval between receiving BFD messages
        mhop:
          type: boolean
          description: True when BFD is enabled on this endpoint
          default: false
    BgpMsgs:
      title: BgpMsgs
      type: object
      properties:
        peerInUpdates:
          type: string
          description: Number of peer in updates
        peerOutUpdates:
          type: string
          description: Number of peer out updates
        peerInTotalMessages:
          type: string
          description: Total Number of peer messages
        peerOutTotalMessages:
          type: string
          description: Total number of peer out messages
        peerInUpdateElapsedTime:
          type: string
          description: Peer updated elapsed time in seconds
        lastError:
          $ref: '#/components/schemas/MsgsLastError'
    BgpPackage:
      title: BgpPackage
      type: object
      properties:
        peerType:
          $ref: '#/components/schemas/PeerType'
        peerAs:
          type: integer
          description: Autonomous System number configured for the peer.
          format: int64
        peerBgpIdentifier:
          type: string
          description: BGP identifier of the peer. Learned only in OPEN CONFIRM and ESTABLISHED states.
        peerState:
          $ref: '#/components/schemas/PeerState'
        peerNegotiatedBGPVersion:
          type: string
          description: Learned only in OPENCONFIRM and ESTABLISHED states.
        peerFsmEstablishedTransitions:
          type: string
          description: Peer Fsm established transitions.
        security:
          $ref: '#/components/schemas/BgpSecurity'
        peerFsmEstablishedTime:
          type: string
          description: Peer Fsm established time in seconds.
        bfd:
          $ref: '#/components/schemas/BgpBfd'
        transport:
          $ref: '#/components/schemas/BgpTransport'
        timers:
          $ref: '#/components/schemas/BgpTimers'
        rr:
          $ref: '#/components/schemas/BgpRr'
        msgs:
          $ref: '#/components/schemas/BgpMsgs'
        afiSafi:
          type: array
          items:
            $ref: '#/components/schemas/BgpAfiSafi'
          description: ''
    BgpRouteMap:
      title: BgpRouteMap
      type: object
      properties:
        name:
          type: string
          description: The route-map name.
        direction:
          $ref: '#/components/schemas/Direction3'
    BgpRr:
      title: BgpRr
      type: object
      properties:
        peerClusterId:
          type: string
          description: The cluster-id to which peer belongs if it is configured as RR client.
        peerRole:
          $ref: '#/components/schemas/PeerRole'
        role:
          $ref: '#/components/schemas/Role3'
    BgpSecurity:
      title: BgpSecurity
      type: object
      properties:
        md5Authentication:
          $ref: '#/components/schemas/Md5Authentication'
    BgpTimers:
      title: BgpTimers
      type: object
      properties:
        peerConnectRetryInterval:
          type: string
          description: Peer connection retry intervel in seconds.
        peerNegotiatedHoldTime:
          type: string
          description: Peer negotiation hold time in seconds
        peerConfiguredHoldTime:
          type: string
          description: Peer configured hold time in seconds
        peerNegotiatedKeepAliveTime:
          type: string
          description: Peer negotiation keep alive time in seconds
        peerConfiguredKeepAliveTime:
          type: string
          description: Peer configured keep alive time in seconds
        peerMinASOriginationInterval:
          type: string
          description: Peer minimum AS origination intervel in seconds
        peerMinRouteAdvertisementInterval:
          type: string
          description: Peer minimum advertised intervel in seconds
    BgpTransport:
      title: BgpTransport
      type: object
      properties:
        updateSource:
          type: string
          description: The name of IP interface used with update-source.
        localIp:
          type: string
          description: If update-source is configured then IP address of the interface. Rely on learned localIp if it is reported. Reported in OPENCONFIRM and ESTABLISHED states.
        localPort:
          type: string
          description: Local port reported in OPENCONFIRM and ESTABLISHED states.
        peerIp:
          type: string
          description: Peer Ip configured as part of BGP peer configuration.
        peerPort:
          type: string
          description: Peer port reported in OPENCONFIRM and ESTABLISHED states.
    Bw:
      title: Bw
      type: object
      properties:
        unit:
          $ref: '#/components/schemas/Unit'
        total:
          type: number
          description: The total bandwidth configured for supported clients
        used:
          type: number
          description: The current used bandwidth by all supported clients
        available:
          type: number
          description: The remaining bandwidth available for supported clients
    CalendarChannelDetails:
      title: CalendarChannelDetails
      type: object
      properties:
        calendars:
          type: array
          items:
            $ref: '#/components/schemas/CalendarDetails'
          description: List of calendar details for the FlexE group
        channels:
          type: object
    CalendarDetails:
      title: CalendarDetails
      type: object
      properties:
        calendarName:
          type: string
          description: Name for FlexE calendar
        calendarMappings:
          type: array
          items:
            $ref: '#/components/schemas/PhyDetails'
          description: List of calendar-slot mappings of the FlexE calendar for the FlexE group
    Capacity:
      title: Capacity
      type: object
      properties:
        layer:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        capacityClass:
          $ref: '#/components/schemas/CapacityClass'
        capacity:
          type: integer
          description: Number of potential client instances or usage instances
          format: int32
        capacityType:
          $ref: '#/components/schemas/CapacityType'
        capacitySize:
          $ref: '#/components/schemas/CapacitySize'
        capacityCalculationRule:
          type: string
          description: Core logic that will be used on capacity calculation
        source:
          type: string
          description: Source of the capacity
        maxLimit:
          type: integer
          description: Maximum potential client instances
          format: int32
    CapacityPattern:
      title: CapacityPattern
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type30'
        format:
          type: string
          description: An optional regex expression or format string describing how to parse the size string in case of multiple values, e.g. CIR:EIR
    CapacitySize:
      title: CapacitySize
      type: object
      properties:
        size:
          type: array
          items:
            type: string
          description: Capacity size to be interpreted with CapacityPattern
        pattern:
          $ref: '#/components/schemas/CapacityPattern'
        unit:
          type: string
          description: unit for size string value
    CascadedDtlTpePackage:
      title: CascadedDtlTpePackage
      type: object
      properties:
        cascadedDtlIdTuple:
          type: string
          description: This field Cascaded DTL ID Tuple info..
    ClientPortRequest:
      title: ClientPortRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClientPortRequestData'
    ClientPortRequestAttributes:
      title: ClientPortRequestAttributes
      type: object
      properties:
        ncId:
          type: string
          description: The NetworkConstruct Id for the Client Port
        location:
          type: string
          description: Location of the client port
        locationFormat:
          type: string
          description: 'Location format, for example: shelf-slot-port'
        portType:
          type: string
          description: Rate of the Client port
    ClientPortRequestData:
      title: ClientPortRequestData
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op3'
        attributes:
          $ref: '#/components/schemas/ClientPortRequestAttributes'
    ClientPortResponse:
      title: ClientPortResponse
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ClientPortResponseAttributes'
    ClientPortResponseAttributes:
      title: ClientPortResponseAttributes
      type: object
      properties:
        op:
          type: string
          description: The requested client port operation
        ncId:
          type: string
          description: The NetworkConstruct Id for the Client Port
        location:
          type: string
          description: Location of the client port
        statusMessage:
          type: string
          description: status message of the operation requested
    ColorEntry:
      title: ColorEntry
      type: object
      properties:
        name:
          type: string
          description: The name of the color
        bitmask:
          type: string
          description: The 32-bit hexadecimal bitmask of the color
    ColorGroup:
      title: ColorGroup
      type: object
      properties:
        name:
          type: string
          description: The name of the color group
        bitmask:
          type: string
          description: The 32-bit hexadecimal bitmask of the color group
        colors:
          type: array
          items:
            $ref: '#/components/schemas/ColorEntry'
          description: ''
    ConnectionPoint:
      title: ConnectionPoint
      type: object
      properties:
        owningPoolAdapterType:
          type: string
          description: Type of the owner Adapter.
        dynamicOwningPoolAdapterFgiRules:
          type: array
          items:
            type: string
          description: dynamicOwningPoolAdapterFgiRules
        mirroringBandwidthRules:
          type: string
          description: The mirroringBandwithRules for capacity calculation
        mirroringNamingRules:
          type: string
          description: The mirroringNamingRules for capacity calculation
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        potentialGrowthCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        namingRules:
          type: array
          items:
            $ref: '#/components/schemas/NamingRules'
          description: ''
        stitchingConstraint:
          $ref: '#/components/schemas/StitchingConstraint'
    ConnectionRule:
      title: ConnectionRule
      type: object
      properties:
        targetLayer:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        rule:
          $ref: '#/components/schemas/Rule'
        immediateClientPotential:
          type: string
          description: 'If describing connectionRulesInAdaptationLayer: names of TPESpec of immediate client TPE. If describing connectionRulesInOwnLayer: null (not relevant). If describing mustConnectInternally: null (not relevant).'
        immediateDualPortPeerPotential:
          type: string
          description: 'If describing connectionRulesInAdaptationLayer: names of TPESpec of dual port peer TPE. If describing connectionRulesInOwnLayer: null (not relevant). If describing mustConnectInternally: null (not relevant).'
    ContinuousAdapterRulesPackage:
      title: ContinuousAdapterRulesPackage
      type: object
      properties:
        segmentationRule:
          $ref: '#/components/schemas/SegmentationRule'
        widthRule:
          $ref: '#/components/schemas/WidthRule'
        lowerBoundaryRule:
          $ref: '#/components/schemas/LowerBoundaryRule'
        upperBoundaryRule:
          $ref: '#/components/schemas/LowerBoundaryRule'
        centerFrequencyRule:
          $ref: '#/components/schemas/CenterFrequencyRule'
    ControlPlaneLine:
      title: ControlPlaneLine
      type: object
      properties:
        id:
          type: string
          description: Control Plane Line Id e.g. 1101
        shelf:
          type: string
          description: Control Plane Line Shelf e.g. 11
        lineTerminationPoint:
          type: string
          description: 'Control Plane Line Termination Point (source endpoint). Should follow the format: ADJ-SH-SL-PRT (ADJ-11-1-5)'
    ControlPlanePackage:
      title: ControlPlanePackage
      type: object
      properties:
        osrpCommChannel:
          $ref: '#/components/schemas/OsrpCommChannel'
        ovpnIds:
          type: array
          items:
            type: string
          description: The optical virtual private network ID list
        applicableRates:
          type: string
          description: Applicable Rates list
        holdBackSdThresholds:
          type: string
          description: Holdback signal degrade threshold
        bwThresholdMode:
          $ref: '#/components/schemas/BwThresholdMode'
        commonId:
          type: integer
          description: Common identifier of the OSRP line
          format: int32
        holdOffTimer:
          type: integer
          description: Line-Level hold-off timer
          format: int32
        configuredLatencyType:
          $ref: '#/components/schemas/ConfiguredLatencyType'
        isMaster:
          type: boolean
          description: Specifies if this end of the OSRP link is the master.
          default: false
        commState:
          type: string
          description: State of the Hello protocol finite state machine.
        bwLockOut:
          $ref: '#/components/schemas/BwLockOut'
        bwThreshold:
          $ref: '#/components/schemas/BandwidthThreshold'
        preemptionBandwidth:
          $ref: '#/components/schemas/PreemptionBandwidth'
    EquipmentIntentEditAdjTargetLocation:
      title: EquipmentIntentEditAdjTargetLocation
      type: object
      properties:
        networkElement:
          type: string
          description: The name/tid of the Network Element.
        layerRate:
          type: string
          description: layer rate on which topology is created.
        layerRateQualifier:
          type: string
          description: layer rate Qualifier on which topology is created.
        shelf:
          type: string
          description: The shelf associated with this equipment.
        slot:
          type: string
          description: The slot associated with this equipment.
        subslot:
          type: string
          description: The subslot associated with this equipment.
        port:
          type: string
          description: The port value associated with this endpoint.
    EquipmentIntentEditRequest:
      title: EquipmentIntentEditRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentIntentEditRequestData'
    EquipmentIntentEditRequestAdj:
      title: EquipmentIntentEditRequestAdj
      type: object
      properties:
        userLabel:
          type: string
          description: user label of the topology
        targetLocation:
          $ref: '#/components/schemas/EquipmentIntentEditAdjTargetLocation'
    EquipmentIntentEditRequestAttributes:
      title: EquipmentIntentEditRequestAttributes
      type: object
      properties:
        intentId:
          type: string
          description: Intent ID of planned intent
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentIntentEditRequestEqp'
          description: The equipment associated with this intent (shelves, cards, pluggables, fans, etc).
    EquipmentIntentEditRequestData:
      title: EquipmentIntentEditRequestData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/EquipmentIntentEditRequestAttributes'
    EquipmentIntentEditRequestEqp:
      title: EquipmentIntentEditRequestEqp
      type: object
      properties:
        eqpId:
          type: string
          description: Unique identifier associated with this equipment.
        customerCode:
          type: string
          description: Customer Code
        editAdj:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentIntentEditRequestAdj'
          description: Attribute details need to be updated on equipment. like user label.
    EquipmentIntentRequest:
      title: EquipmentIntentRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentIntentRequestData'
    EquipmentIntentRequestAttributes:
      title: EquipmentIntentRequestAttributes
      type: object
      properties:
        planningProjectId:
          type: string
          description: The planning project identifier associated with this intent. This field is required for any commissioning actions that take place after equipment provisioning is complete (required for add/drop for example).
        turnUpDateTime:
          type: string
          description: For most users, a hard date as to when committed equipment should be deployed/installed.  For other customers, a soft/best guesstimate date for equipment deployment. If equipment arrives before this date, it will be provisioned immediately.
          format: date-time
        turnDownDateTime:
          type: string
          description: The expected date associated with decommissioning the equipment.
          format: date-time
        equipmentGroups:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentIntentRequestEqpGrp'
          description: The groups of equipment (OTS, Mating, etc.). Not all equipment must participate in a group.
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentIntentRequestEqp'
          description: The equipment associated with this intent (shelves, cards, pluggables, fans, etc).
    EquipmentIntentRequestData:
      title: EquipmentIntentRequestData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/EquipmentIntentRequestAttributes'
    EquipmentIntentRequestEndPoint:
      title: EquipmentIntentRequestEndPoint
      type: object
      properties:
        port:
          type: string
          description: The port value associated with this endpoint.
        layerTerminations:
          type: array
          items:
            $ref: '#/components/schemas/LayerTermination'
          description: Transmission parameters to be provisioned on TPE layer terminations
    EquipmentIntentRequestEqp:
      title: EquipmentIntentRequestEqp
      type: object
      properties:
        eqpId:
          type: string
          description: Unique identifier associated with this equipment.
        projectID:
          type: string
          description: 0-16 character alphanumeric text field to be stored against the relevant equipment. This field maps to the projectName field in the Resource Planning Tool.
        networkElement:
          $ref: '#/components/schemas/NetworkElement'
        shelf:
          type: string
          description: The shelf associated with this equipment (may be none).
        subshelf:
          type: string
          description: The subshelf associated with this equipment (may be none).
        slot:
          type: string
          description: The slot associated with this equipment (may be none).
        subslot:
          type: string
          description: The subslot associated with this equipment (may be none).
        partNumber:
          type: string
          description: The part number the uniquely identifies the type of this piece of equipment.
        maintenanceMode:
          type: boolean
          description: Determines whether events for this piece of equipment will be responded to. Note that it is possible to deactivate maintenance mode at a later date.
          default: false
        reservedForMaintenance:
          type: boolean
          description: If reserved for maintenance is set to true Equipment primary state is set to OOS during provisioning.
          default: false
        samData:
          $ref: '#/components/schemas/SamData'
        nodeType:
          $ref: '#/components/schemas/NodeType'
        cardType:
          type: string
          description: The card type of this equipment. Required for filler or common equipment
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentIntentRequestEndPoint'
          description: Endpoints associated with this piece of equipment. Note that only those endpoints with associated adjacencies need to be specified.
        additionalAttributes:
          type: object
    EquipmentIntentRequestEqpGrp:
      title: EquipmentIntentRequestEqpGrp
      type: object
      properties:
        eqpGrpId:
          type: string
          description: Unique identifier associated with this equipment group.
        networkElement:
          $ref: '#/components/schemas/NetworkElement'
        name:
          type: string
          description: The name of this equipment group.
        type:
          $ref: '#/components/schemas/Type31'
        subEquipmentGroupReferences:
          type: array
          items:
            type: string
          description: In some cases equipment groups can reference other equipment groups, this is done by adding the ids of these sub-groups to this array.
        equipmentReferences:
          type: array
          items:
            type: string
          description: An array of equipment ids for equipment associated with this group.
        additionalAttributes:
          type: object
    EquipmentIntentResponse:
      title: EquipmentIntentResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentIntentResponseData'
    EquipmentIntentResponseArray:
      title: EquipmentIntentResponseArray
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentIntentResponseData'
          description: An array of equipment intent response data objects.
    EquipmentIntentResponseAttributes:
      title: EquipmentIntentResponseAttributes
      type: object
      properties:
        creationTime:
          type: string
          description: The date that this intent was created.
          format: date-time
        request:
          $ref: '#/components/schemas/EquipmentIntentRequestData'
    EquipmentIntentResponseData:
      title: EquipmentIntentResponseData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of this equipment intent.
        type:
          type: string
          description: The type of this EquipmentIntentResponseData.
        attributes:
          $ref: '#/components/schemas/EquipmentIntentResponseAttributes'
    EquipmentStateRequest:
      title: EquipmentStateRequest
      type: object
      properties:
        serviceIntentId:
          type: string
          description: Service Intent ID
        serviceIntentOperation:
          $ref: '#/components/schemas/ServiceIntentOperation'
    FbProfile:
      title: FbProfile
      type: object
      properties:
        profileName:
          type: string
          description: The profile name associated with this set of Fb attributes
        index:
          type: integer
          description: Index count of profile
          format: int32
        associatedInterfaces:
          type: array
          items:
            type: string
          description: List of IP interfaces this FB profile is associated with
        nodesShareSrlg:
          type: array
          items:
            type: string
          description: List of srlg that represents sharable srlg for source node of IP interfaces this fb profile is protecting
        linksShareSrlg:
          type: array
          items:
            type: string
          description: List of srlg that represents sharable srlg for source and remote nodes of IP interfaces this fb profile is protecting
        srlgMode:
          $ref: '#/components/schemas/SrlgMode'
    FlexePackage:
      title: FlexePackage
      type: object
      properties:
        groupId:
          type: integer
          description: FlexE group number associated to the FlexE group
          format: int32
        groupName:
          type: string
          description: Name for FlexE group
        calendarSlotGranularity:
          type: string
          description: The granularity of calendar slot is 5G or 25G
        phyType:
          type: string
          description: Type of PHY used in the FlexE group, such as 50/100/200/400GBASE-R. All PHYs in a FlexE group should be of same type
        activeCalendar:
          type: string
          description: Calendar configuration used by the FlexE group in FlexE Mux/Demux
        calendarProtocol:
          $ref: '#/components/schemas/CalendarProtocol'
        overheadStatus:
          type: array
          items:
            type: string
          description: List of overhead status conditions in the FlexE group
        misconfigurations:
          type: array
          items:
            type: string
          description: List of misconfigurations in the FlexE group
        calendarChannelDetails:
          $ref: '#/components/schemas/CalendarChannelDetails'
        totalSlots:
          type: integer
          description: Total number of slots in FlexE group
          format: int32
        allocatedSlots:
          type: integer
          description: Number of slots in use by FlexE channels associated to FlexE group
          format: int32
        availableSlots:
          type: integer
          description: Number of slots available in active calendar of FlexE group
          format: int32
        bandwidth:
          $ref: '#/components/schemas/Bw'
    G8032Package:
      title: G8032Package
      type: object
      properties:
        ringId:
          type: string
          description: The logical ring ID
        logicalRingName:
          type: string
          description: The logical ring name
        virtualRingName:
          type: string
          description: the virtual ring name
        rapsVid:
          type: string
          description: the R-APS VID of the ring
        rplOwner:
          type: boolean
          description: True if the port is configured as RPL-owner.
          default: false
        operationalChannelBlock:
          type: boolean
          description: True if the port is blocked, i.e portState == Blocked
          default: false
        ringType:
          $ref: '#/components/schemas/RingType'
        sharedPort:
          type: string
          description: sharedPort information for the sub-ring (ONLY for sub-ring endNode)
        sharedPortRef:
          type: string
          description: the ID of the PTP on the shared port
        vlanGroupId:
          type: integer
          description: the ID used for L2Motr devices in parallel to sharedPort in SAOS devices
          format: int32
        forceSwitch:
          type: boolean
          description: a flag indicating whether the switching is forced or not.
          default: false
        subRingTermination:
          type: boolean
          description: flag indicating whether the subring is terminating or not
          default: false
        portDirection:
          $ref: '#/components/schemas/PortDirection'
        revertive:
          type: boolean
          description: revertive
          default: false
        holdOffTime:
          type: integer
          description: hold off time in milliseconds
          format: int32
        holdOffTimeUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        waitToRestore:
          type: integer
          description: wait to restore time in minute.
          format: int32
        waitToRestoreUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        waitToBlock:
          type: integer
          description: wait to block time in milliseconds.
          format: int32
        waitToBlockUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        guardTime:
          type: integer
          description: guard time in millisecond.
          format: int32
        guardTimeUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        ringMembers:
          type: string
          description: a comma separated list of virtual ring members.
        ringState:
          $ref: '#/components/schemas/RingState'
        ringStatus:
          $ref: '#/components/schemas/RingStatus'
        portState:
          $ref: '#/components/schemas/PortState'
        portStatus:
          $ref: '#/components/schemas/PortStatus'
    GlobalConstraints:
      title: GlobalConstraints
      type: object
      properties:
        site-restriction:
          $ref: '#/components/schemas/SiteRestrictions'
        node-restriction:
          $ref: '#/components/schemas/NodeRestrictions'
        regeneration-node-restriction:
          $ref: '#/components/schemas/RegenerationNodeRestrictions'
        supporting-service-restriction:
          $ref: '#/components/schemas/Supporting_service_restriction'
    GlobalConstraintsRequest:
      title: GlobalConstraintsRequest
      type: object
      properties:
        customerName:
          type: string
          description: The Name of the customer
        metricPolicy:
          $ref: '#/components/schemas/MetricPolicy'
        globalRestrictions:
          $ref: '#/components/schemas/GlobalConstraints'
    GlobalConstraintsRequestBO:
      title: GlobalConstraintsRequestBO
      type: object
      properties:
        metricPolicyBO:
          $ref: '#/components/schemas/MetricPolicyBO'
        globalConstraintsRequestDataBOS:
          type: array
          items:
            $ref: '#/components/schemas/GlobalConstraintsRequestDataBO'
          description: ''
    GlobalConstraintsRequestDataBO:
      title: GlobalConstraintsRequestDataBO
      type: object
      properties:
        customerName:
          type: string
        type:
          type: string
        restrictionScopes:
          type: array
          items:
            type: string
          description: ''
        equipmentsMap:
          type: object
          additionalProperties:
            type: string
    GlobalRestrictionNode:
      title: GlobalRestrictionNode
      type: object
      properties:
        node-id:
          type: string
          description: Node Id Type
        restriction-type:
          $ref: '#/components/schemas/RestrictionType'
    GlobalRestrictionRegenerationNode:
      title: GlobalRestrictionRegenerationNode
      type: object
      properties:
        node-id:
          type: string
          description: Node Id Type
        regeneration-restriction-type:
          $ref: '#/components/schemas/RegenerationRestrictionType'
    GlobalRestrictionSite:
      title: GlobalRestrictionSite
      type: object
      properties:
        site-id:
          type: string
          description: Site id
        restriction-type:
          $ref: '#/components/schemas/RestrictionType'
    HopEntry:
      title: HopEntry
      type: object
      properties:
        hopAddress:
          type: string
          description: The IP-data interface address for this hop
        hopType:
          $ref: '#/components/schemas/HopType'
    IpInterfacePackage:
      title: IpInterfacePackage
      type: object
      properties:
        bfd:
          $ref: '#/components/schemas/Bfd'
        isis:
          $ref: '#/components/schemas/IsIs'
    IsIs:
      title: IsIs
      type: object
      properties:
        instanceTag:
          type: string
          description: Protocol instance Tag
        levelType:
          $ref: '#/components/schemas/LevelType'
        levels:
          type: array
          items:
            $ref: '#/components/schemas/IsIsLevelData'
          description: Contains IsIs Level attribute details
        interfaceType:
          type: string
          description: point-to-point or point-to-multipoint network
        lspInterval:
          type: integer
          description: Interval between LSP transmissions, unit:milliseconds
          format: int64
        lspRetransmitInterval:
          type: integer
          description: Interval between LSP retransmissions, unit:seconds
          format: int32
        helloPadding:
          type: boolean
          description: ISIS hello padding activation
          default: false
        ipv4UnicastDefaultDisable:
          type: boolean
          description: disable default config for IPv4 AF on interface
          default: false
        ldpIgpSyncLevelType:
          $ref: '#/components/schemas/LdpIgpSyncLevelType'
        ldpIgpSyncHoldDown:
          type: string
          description: 'hold down timer for the ISIS LDP/IGP synchronization configuration, unit : seconds'
        isisEnabled:
          type: boolean
          description: enable MPLS isis routing
          default: false
        srEnabled:
          type: boolean
          description: enable MPLS segment routing
          default: false
        bfdEnabled:
          type: boolean
          description: Bidirectional forwarding detection for ISIS
          default: false
        metricStyle:
          $ref: '#/components/schemas/MetricStyle'
    IsIsLevelData:
      title: IsIsLevelData
      type: object
      properties:
        levelType:
          type: string
          description: Level of an IS-IS node - can be level-1, level-2 or level-1-2
        helloInterval:
          type: integer
          description: Interval between hello messages, unit:seconds
          format: int32
        helloMultiplier:
          type: integer
          description: Number of missed hello messages prior to adjacency down grouping, unit:seconds
          format: int32
        csnpInterval:
          type: integer
          description: Interval between CSNP messages, unit:seconds
          format: int32
        priority:
          type: integer
          description: priority for DIS election
          format: int32
        metric:
          type: integer
          description: Metric associated with the links having range 1-63, i.e. default-10, delay, expense etc.
          format: int32
        wideMetric:
          type: integer
          description: wide-metric configuration
          format: int32
        lfaCandidateEnable:
          type: boolean
          description: Enable/disable the interface from being used as LFA for level-1, level-2 or level-1-2 primary route
          default: false
        tiLfaEnable:
          type: boolean
          description: Enable/DIsable TI-LFA on the interface Same for LFA
          default: false
    ItsPackage:
      title: ItsPackage
      type: object
      properties:
        itsMode:
          type: string
          description: Specify supported ITS mode
    L2Transform:
      title: L2Transform
      type: object
      properties:
        name:
          type: string
          description: Need a key for this list. It cannot be a choice of several objects but objects that will always be specified.
        operation:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: List of operations
    LayerProtocol:
      title: LayerProtocol
      type: object
      properties:
        termination:
          $ref: '#/components/schemas/Termination'
        adaptationPools:
          type: array
          items:
            $ref: '#/components/schemas/AdaptationPool'
          description: ''
        layeredAttributes:
          type: array
          items:
            $ref: '#/components/schemas/LayeredAttribute'
          description: ''
        accessPoint:
          $ref: '#/components/schemas/AccessPoint'
        connectionPoint:
          $ref: '#/components/schemas/ConnectionPoint'
        tandemConnectionMonitoring:
          type: array
          items:
            $ref: '#/components/schemas/TandemConnectionMonitoring'
          description: ''
    LayerTermination:
      title: LayerTermination
      type: object
      properties:
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        nativeLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        dynamicLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        layerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        structureType:
          $ref: '#/components/schemas/StructureType'
        terminationState:
          $ref: '#/components/schemas/TerminationState'
        adminState:
          $ref: '#/components/schemas/AdminState2'
        operationalState:
          $ref: '#/components/schemas/OperationalState2'
        active:
          type: boolean
          description: Whether or not an inactive layer appears to be absent from the layer stack.
          default: false
        adjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage'
        retainedAdjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage'
        manualAdjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage'
        powerPackage:
          $ref: '#/components/schemas/PowerPackage'
        photonicSpectrumPackage:
          $ref: '#/components/schemas/PhotonicSpectrumPackage'
        cfmPackages:
          type: array
          items:
            $ref: '#/components/schemas/TpeCfmPackage'
          description: Holds data related to CFM services configured on an Ethernet service
        mplsPackage:
          $ref: '#/components/schemas/MplsPackage'
        g8032Package:
          $ref: '#/components/schemas/G8032Package'
        flexePackage:
          $ref: '#/components/schemas/FlexePackage'
        signalIndex:
          $ref: '#/components/schemas/SignalIndex'
        segmentId:
          type: string
          description: The Segment Id of this layer termination
        classOfServices:
          type: array
          items:
            $ref: '#/components/schemas/ClassOfServices'
          description: The list of class of services in this layer termination
        nativeName:
          type: string
          description: The name of the TPE that is native to the network element.
        oduFlexPackage:
          $ref: '#/components/schemas/OduFlexPackage'
        layerProtocol:
          $ref: '#/components/schemas/LayerProtocol'
        trafficProfiles:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfile'
          description: Traffic profile characteristics used to data-drive provisioning workflows.
        serviceLabel:
          type: string
          description: The service-identifiying label
        boundaries:
          type: array
          items:
            type: string
          description: Array of strings to track boundaries of Layer Termination
        ttiPackage:
          $ref: '#/components/schemas/TtiPackage'
        controlPlanePackage:
          $ref: '#/components/schemas/ControlPlanePackage'
        resiliencyTopologyPackage:
          $ref: '#/components/schemas/ResiliencyTopologyPackage'
        adminWt:
          type: number
          description: Administrative weight which specifies the level of importance given to the OSRP link
        bundleIds:
          type: array
          items:
            type: string
          description: List of up to 20 protection bundles to which the OSRP link belongs
        latency:
          type: number
          description: Indicates the delay in mic'roseconds.
        bgpPackage:
          $ref: '#/components/schemas/BgpPackage'
        parentPolicers:
          type: array
          items:
            $ref: '#/components/schemas/ParentPolicer'
          description: ''
        additionalAttributes:
          type: object
        txInfo:
          $ref: '#/components/schemas/TxInfo'
        ipInterfacePackage:
          $ref: '#/components/schemas/IpInterfacePackage'
        lastUpdatedAdminStateTimeStamp:
          type: string
          description: TimeStamp when the adminState was last changed
        lastUpdatedOperationalStateTimeStamp:
          type: string
          description: TimeStamp when the operational state was last changed
        L2Transform:
          $ref: '#/components/schemas/TransformTypes'
    LayeredAttribute:
      title: LayeredAttribute
      type: object
      properties:
        layer:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        additionalAttributes:
          type: object
        loopbackPackage:
          $ref: '#/components/schemas/LoopbackPackage'
        itsPackage:
          type: array
          items:
            $ref: '#/components/schemas/ItsPackage'
          description: ''
    LifeCycleRule:
      title: LifeCycleRule
      type: object
      properties:
        autoCreatedByNetwork:
          type: boolean
          description: Indicates if the entity is auto created by the network and/or device (true) or must it explicitly be created (false).
          default: false
        autoDeletedByNetwork:
          type: boolean
          description: Indicates if the entity is auto deleted by the network and/or device (true) or must it explicitly be created (false).
          default: false
    LinkAttributes:
      title: LinkAttributes
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
          description: Reference to 3rd Party Network involved in this topology, can be re-used for other purposes in future.
        description:
          type: string
          description: Short description of the topology to be created.
        userLabel:
          type: string
          description: The user label (not necessarily unique) of the topology to be created.
        note:
          $ref: '#/components/schemas/Note'
        serialNumber:
          type: string
          description: Serial number for AOC/DAC plug
    LoopbackPackage:
      title: LoopbackPackage
      type: object
      properties:
        loopbackStatus:
          type: string
          description: Status of the test; taken directly from the value of the TL1 LPBKSTATUS field.
        loopbackWavelength:
          type: string
          description: Wavelength of the loopback test; taken directly from the value of the TL1 LPBKWVL field
    MapperRule:
      title: MapperRule
      type: object
      properties:
        groupedTribSlots:
          type: array
          items:
            type: array
            items:
              type: string
        groupedAvailableTribPorts:
          type: array
          items:
            type: string
          description: ''
        usedStartingTimeSlots:
          type: array
          items:
            type: string
          description: ''
        tribSlots:
          type: array
          items:
            type: string
          description: Mapped tributary slots corresponding to tributary port
        tribPort:
          type: string
          description: Tributary port
    MappingInteractionRule:
      title: MappingInteractionRule
      type: object
      properties:
        segmentBoundaryRule:
          $ref: '#/components/schemas/SegmentBoundaryRule'
    MappingTableEntry:
      title: MappingTableEntry
      type: object
      properties:
        direction:
          $ref: '#/components/schemas/Direction5'
        label:
          type: string
          description: The user label.
        cos:
          type: string
          description: The class of service.
        ip:
          type: string
          description: The ip address.
        ranges:
          type: array
          items:
            $ref: '#/components/schemas/RangesEntry'
          description: ''
    MbbHistoryEntry:
      title: MbbHistoryEntry
      type: object
      properties:
        startTime:
          type: string
          description: Start time of the make-before-break happened
        endTime:
          type: string
          description: End time of the make-before-break happened
        result:
          type: string
          description: Result of the make-before-break
        reason:
          type: string
          description: Reason of the make-before-break
    MepEntry:
      title: MepEntry
      type: object
      properties:
        mepId:
          type: string
          description: The ID of the MEP
        ccmTransmitState:
          $ref: '#/components/schemas/CcmTransmitState'
        mepAdminState:
          $ref: '#/components/schemas/MepAdminState'
        mepType:
          $ref: '#/components/schemas/MepType'
        mepMacAddress:
          type: string
          description: The MAC address of the MEP
        ccmPriority:
          type: string
          description: Priority of the CC messages (0-7)
        vlanId:
          type: string
          description: The VLAN ID of the MEP
        lmm:
          $ref: '#/components/schemas/Y1731Attributes'
        dmm:
          $ref: '#/components/schemas/Y1731Attributes'
        slm:
          $ref: '#/components/schemas/Y1731Attributes'
        slmResponder:
          $ref: '#/components/schemas/SlmResponder'
        remoteMepId:
          type: string
          description: The ID of the remote MEP
        maName:
          type: string
          description: Holds maintenance association name
        ccmInterval:
          type: string
          description: The interval between CCM transmissions to be used by all MEPs in the MA
    MetricPolicy:
      title: MetricPolicy
      type: object
      properties:
        composite-metric-versus-selective:
          type: boolean
          description: composite-metric-versus-selective
          default: false
    MetricPolicyBO:
      title: MetricPolicyBO
      type: object
      properties:
        customerName:
          type: string
        composite_metric_versus_selective:
          type: boolean
          default: false
    MplsFb:
      title: MplsFb
      type: object
      properties:
        frrAutoCreated:
          type: boolean
          description: The flag indicating whether the FB tunnel is auto created by FRR
          default: false
        protectedInterface:
          type: string
          description: Name of the interface being protected by the FB tunnel
        excludeIp:
          type: string
          description: IP address excluded from the FB tunnel path
        protectedTunnels:
          type: array
          items:
            $ref: '#/components/schemas/MplsFbProtectedTunnel'
          description: ''
    MplsFbProtectedTunnel:
      title: MplsFbProtectedTunnel
      type: object
      properties:
        name:
          type: string
          description: Name of the tunnel protected by this FB tunnel
        srcIp:
          type: string
          description: Source IP address of the tunnel protected by this FB tunnel
        destIp:
          type: string
          description: Destination IP address of the tunnel protected by this FB tunnel
        role:
          $ref: '#/components/schemas/Role4'
    MplsFrr:
      title: MplsFrr
      type: object
      properties:
        frrProtected:
          type: boolean
          description: If true, the tunnel is protected by fast re-route (FRR) on the headend TX MPLS CTP
          default: false
        profileName:
          type: string
          description: The FRR profile name on the headend TX MPLS CTP
        localProtection:
          $ref: '#/components/schemas/MplsFrrLocalProtection'
        actualProtectionRoute:
          type: array
          items:
            $ref: '#/components/schemas/MplsFrrProtectionRouteHop'
          description: Actual FRR protection route on the headend TX MPLS CTP
    MplsFrrLocalProtection:
      title: MplsFrrLocalProtection
      type: object
      properties:
        protectionAvailable:
          type: boolean
          description: True when the protection is available on this endpoint
          default: false
        protectionInUse:
          type: boolean
          description: True when the protection is in use on this endpoint
          default: false
        protectionFbName:
          type: string
          description: Protection FB tunnel name
    MplsFrrProtectionRouteHop:
      title: MplsFrrProtectionRouteHop
      type: object
      properties:
        ip:
          type: string
          description: IP interface address or node loopback IP address of the current hop
        protectionType:
          $ref: '#/components/schemas/ProtectionType'
        protectionInUse:
          type: boolean
          description: True when the protection is in use on this endpoint
          default: false
        bwProtected:
          type: boolean
          description: True when the bandwidth is protected on this endpoint
          default: false
    MplsPackage:
      title: MplsPackage
      type: object
      properties:
        lspName:
          type: string
          description: The name of this MPLS tunnel
        lspId:
          type: string
          description: The numeric ID of this MPLS tunnel
        coRouted:
          type: boolean
          description: If true, this MPLS tunnel is co-routed; otherwise it is associated
          default: false
        signaled:
          type: boolean
          description: If true, this MPLS tunnel is dynamic; otherwise it is static
          default: false
        subType:
          $ref: '#/components/schemas/SubType'
        direction:
          $ref: '#/components/schemas/Direction4'
        tunnelType:
          $ref: '#/components/schemas/TunnelType'
        ctrlPlaneId:
          type: string
          description: A generated value to uniquely identify a particular tunnel instance
        srcIp:
          type: string
          description: The IP-data interface address of the near end of this MPLS tunnel
        srcTunnelId:
          type: string
          description: The ID of the near end of this MPLS tunnel
        destIp:
          type: string
          description: The IP-data interface address of the far end of this MPLS tunnel
        destTunnelId:
          type: string
          description: The ID of the far end of this MPLS tunnel
        fwdIn:
          type: string
          description: The inward ID in the forward direction (transit)
        fwdOut:
          type: string
          description: The outward ID in the forward direction (transit)
        revIn:
          type: string
          description: The inward ID in the reverse direction (transit)
        revOut:
          type: string
          description: The outward ID in the reverse direction (transit)
        prevHopIp:
          type: string
          description: The interface address (on 6200, MAC address) of the previous hop of this MPLS tunnel
        nextHopIp:
          type: string
          description: The interface address (on 6200, MAC address) of the next hop of this MPLS tunnel
        prevHopIfNum:
          type: string
          description: The interface number of the previous hop of this MPLS tunnel
        nextHopIfNum:
          type: string
          description: The interface number of the next hop of this MPLS tunnel
        localIfNamePrevHop:
          type: string
          description: The local interface name of the previous hop of this MPLS tunnel (6200 only)
        localIfNameNextHop:
          type: string
          description: The local interface name of the next hop of this MPLS tunnel (6200 only)
        RxTag:
          type: string
          description: The label used for traffic ingressing to this endpoint
        TxTag:
          type: string
          description: The label used for traffic egressing from this endpoint
        tunnelRole:
          $ref: '#/components/schemas/TunnelRole1'
        bw:
          $ref: '#/components/schemas/Bw'
        autoBackup:
          $ref: '#/components/schemas/AutoBackup'
        diversityResource:
          $ref: '#/components/schemas/DiversityResource'
        diversityLevel:
          $ref: '#/components/schemas/DiversityLevel'
        explicitRouteObject:
          type: array
          items:
            type: string
          description: An ordered list of hop-by-hop IP-data interface addresses traversed by this dynamic MPLS tunnel
        bfd:
          $ref: '#/components/schemas/Bfd'
        aisProfileName:
          type: string
          description: The name of the Alarm Indication Signal profile for this MPLS tunnel
        aisSessionAdminState:
          $ref: '#/components/schemas/AisSessionAdminState'
        aisRefreshTimer:
          type: integer
          description: The interval between each AIS refresh for this MPLS tunnel
          format: int32
        aisRefreshTimerUnit:
          type: string
          description: The units for aisRefreshTimer field
        frrSignaling:
          $ref: '#/components/schemas/FrrSignaling'
        frrProfile:
          $ref: '#/components/schemas/FrrProfile'
        explicitTunnel:
          $ref: '#/components/schemas/TunnelPath'
        fixedTtl:
          type: string
          description: The time-to-live for tunnel hops (1-255)
        setupPriority:
          type: string
          description: The priority of the dynamic tunnel setup (0-7)
        holdPriority:
          type: string
          description: The priority of the dynamic tunnel steady-state (0-7)
        optimization:
          $ref: '#/components/schemas/Optimization'
        optimizationInterval:
          type: integer
          description: The interval between tunnel optimization attempts
          format: int32
        optimizationIntervalUnit:
          type: string
          description: The unit for optimizationInterval
        srlg:
          type: array
          items:
            type: string
          description: A list of shared-risk link-group values assigned to this interface
        colorGroup:
          $ref: '#/components/schemas/ColorGroup'
        includeAny:
          $ref: '#/components/schemas/ColorGroup'
        includeAll:
          $ref: '#/components/schemas/ColorGroup'
        excludeAny:
          $ref: '#/components/schemas/ColorGroup'
        includeAnyBackupTunnel:
          $ref: '#/components/schemas/ColorGroup'
        includeAllBackupTunnel:
          $ref: '#/components/schemas/ColorGroup'
        excludeAnyBackupTunnel:
          $ref: '#/components/schemas/ColorGroup'
        facilityBypass:
          type: boolean
          description: If true, this MPLS tunnel is facility-bypass (FB) tunnel
          default: false
        softPreemption:
          $ref: '#/components/schemas/SoftPreemption'
        stickyLsp:
          $ref: '#/components/schemas/StickyLsp'
        mbbHistory:
          type: array
          items:
            $ref: '#/components/schemas/MbbHistoryEntry'
          description: ''
        frr:
          $ref: '#/components/schemas/MplsFrr'
        fb:
          $ref: '#/components/schemas/MplsFb'
        fbProfile:
          $ref: '#/components/schemas/FbProfile'
        shareSrlg:
          type: array
          items:
            type: string
          description: A list of share SRLG values used by dynamic tunnel during provisioning.
    NameToCapacityMappingRules:
      title: NameToCapacityMappingRules
      type: object
      properties:
        namingUnit:
          type: string
          description: Unit of namespace.
        capacityUnit:
          type: string
          description: Unit of the capacity.
        relationType:
          $ref: '#/components/schemas/RelationType'
        mapping:
          $ref: '#/components/schemas/Mapping'
        noOfUnits:
          type: integer
          description: Number 1-80 in switching and broadband case
          format: int32
        mapperRule:
          type: array
          items:
            $ref: '#/components/schemas/MapperRule'
          description: ''
    NamingRules:
      title: NamingRules
      type: object
      properties:
        total:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        used:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
        potentialGrowth:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          description: ''
    NetworkElement:
      title: NetworkElement
      type: object
      properties:
        name:
          type: string
          description: The name/tid of the Network Element (e.g. OTTAWA_001).
        siteName:
          type: string
          description: The site name of the NE. May be a CLLI or some other customer defined format.
        planningId:
          type: string
          description: The opaque id provided by a planning tool interacting with IFD.
    NetworkElementReference:
      title: NetworkElementReference
      type: object
      properties:
        key:
          type: string
          description: The key of the network element unique identifier - name, planningId
        value:
          type: string
          description: The value of the network element unique identifier associated with given key
    NextHopSelf:
      title: NextHopSelf
      type: object
      properties:
        configured:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
        excludeReflectedRoutes:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
    NodeRestrictions:
      title: NodeRestrictions
      type: object
      properties:
        restriction-scopes:
          type: array
          items:
            $ref: '#/components/schemas/RestrictionScope'
          description: ''
        node:
          type: array
          items:
            $ref: '#/components/schemas/GlobalRestrictionNode'
          description: ''
    Note:
      title: Note
      type: object
      properties:
        noteMsg:
          type: string
          description: The message left on the note left by the user
        lastUpdatedBy:
          type: string
          description: The name of the user that last edited the note
        lastUpdatedTime:
          type: string
          description: The time the note was last updated
    OduFlexPackage:
      title: OduFlexPackage
      type: object
      properties:
        baseHO:
          $ref: '#/components/schemas/BaseHO'
        bitRate:
          type: string
          description: Defines the bit rate of the ODUFlex.
        tolerance:
          type: string
          description: Defines the tolerance in ppm of the ODUFlex payload.
        flexFrameType:
          $ref: '#/components/schemas/FlexFrameType'
        resizable:
          type: boolean
          description: Defines if the ODUFlex is resizable.
          default: false
        serviceRate:
          type: string
          description: Display the sub-rate value of the ethernet interface in Gbps.
    Operation:
      title: Operation
      type: object
      properties:
        tag:
          type: integer
          description: Dependent on the xform operation, the tag numbers are  stamp => '1' represents outermost tag, '2' next outermost (next inner)  pop => '1' represents pop outermost, '2' represents pop outermost, (always pop from outer)  push => '1' represents push outermost, '2' represents push outermost (always push to outer)
          format: int32
        functionType:
          $ref: '#/components/schemas/FunctionType'
        vlanId:
          type: string
          description: Represents a IEEE 802.1Q VLAN-ID.
        etherType:
          $ref: '#/components/schemas/EtherType'
    Orf:
      title: Orf
      type: object
      properties:
        type:
          type: string
          description: Outbound Route Filtering type
        direction:
          $ref: '#/components/schemas/Direction2'
    ParentPolicer:
      title: ParentPolicer
      type: object
      properties:
        name:
          type: string
          description: Name of the parent policer
        cir:
          type: integer
          description: Committed Information rate in kbps of this parent policer
          format: int32
        cbs:
          type: integer
          description: Committed burst size of this policer
          format: int32
        evcList:
          type: array
          items:
            type: string
          description: List of services attached to the parent policer
        adminState:
          $ref: '#/components/schemas/AdminState3'
    PeerError:
      title: PeerError
      type: object
      properties:
        errorCode:
          type: string
          description: Error code for last error
        errorCodeDesc:
          type: string
          description: Description of the Error code in last error
        errorSubCode:
          type: string
          description: Sub error code for last error
        errorSubCodeDesc:
          type: string
          description: Description of the Error sub code in last error
    PhotonicSpectrumPackage:
      title: PhotonicSpectrumPackage
      type: object
      properties:
        minFreqDeadBand:
          type: string
          description: Lower dead band in GHz. The dead band will be in format of 'xxxx.xxx'.
        maxFreqDeadBand:
          type: string
          description: Upper dead band in GHz. The dead band will be in format of 'xxxx.xxx'.
        targetMinFreq:
          type: string
          description: Allows the automatic adjustment of the MINFREQ when any associated NMCTP are deleted. Default is MINFREQ (no target lower frequency).
        targetMaxFreq:
          type: string
          description: Allows the automatic adjustment of the MAXFREQ when any associated NMCTP are deleted. Default is MAXFREQ (no target upper frequency).
        minFreqGuardBand:
          type: string
          description: Indicates the minimum required frequency spacing for the previous NMC.
        maxFreqGuardBand:
          type: string
          description: Indicates the minimum required frequency spacing for the next NMC.
        freqResolution:
          type: string
          description: Indicates the recurring frequency step that is allowed to be configured on the transponder.
        signalBandWidth10DB:
          type: string
          description: Captures Tx Signal Bandwidth in GHz measured at 10 dBm less than peak power.
        signalBandWidth3DB:
          type: string
          description: Captures Tx Signal Bandwidth in GHz measured at 3 dBm less than peak power.
        frequency:
          type: string
          description: The central signal frequency.
        minFreq:
          type: string
          description: The minimum signal frequency.
        maxFreq:
          type: string
          description: The maximum signal frequency.
        width:
          type: string
          description: The signal width.
        wavelength:
          type: string
          description: The central signal wavelength.
        wavelengthGrid:
          type: string
          description: A hexadecimal number representing the vector of wavelengths that can be used by this SNC. Each bit set within the number indicates which wavelength is currently configured
    PhyDetails:
      title: PhyDetails
      type: object
      properties:
        phyNumber:
          type: string
          description: Phy Number of each FlexE port, e.g. PHY-1, PHY-2, etc.
        portName:
          type: string
          description: Name for FlexE port
        slotMappings:
          type: object
    PowerPackage:
      title: PowerPackage
      type: object
      properties:
        txActualPower:
          type: string
          description: Current transmitter power (dBm).
        txMaxPower:
          type: string
          description: Maximum transmitter power level (dBm).
        txMinPower:
          type: string
          description: Minimum transmitter power level (dBm).
        txCurrentLaunchPower:
          type: string
          description: Current launch power level (dBm).
        txMinLaunchPower:
          type: string
          description: Minimum launch power level (dBm).
        rxActualPower:
          type: string
          description: Current receiver power (dBm).
        rxMaxPower:
          type: string
          description: Maximum receiver power level (dBm).
        rxMinPower:
          type: string
          description: Minimum receiver power level (dBm).
        rxNominalInput:
          type: string
          description: Typical per channel operational power (dBm).
        rxOverloadThreshold:
          type: string
          description: Maximum per channel operational power (dBm).
        rxSensitivityThreshold:
          type: string
          description: Mininum per channel operational power (dBm).
    PrefixList:
      title: PrefixList
      type: object
      properties:
        name:
          type: string
          description: Prefix list name to filter BGP advertisements.
        direction:
          $ref: '#/components/schemas/Direction7'
    RangesEntry:
      title: RangesEntry
      type: object
      properties:
        label:
          type: string
          description: The cvid range to be used.
        type:
          $ref: '#/components/schemas/Type32'
    RegenIdPackage:
      title: RegenIdPackage
      type: object
      properties:
        regenTid:
          type: string
          description: This field is the Regen ID Tid
        nearTransponder:
          type: string
          description: This field is near Transponder Shelf SLot Port.
        clientTransponder:
          type: string
          description: The Client Transponder Shelf SLot Port
        mateInfo:
          type: string
          description: This field is Mate Info String.
    RegenPortsRequest:
      title: RegenPortsRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RegenPortsRequestData'
    RegenPortsRequestAttributes:
      title: RegenPortsRequestAttributes
      type: object
      properties:
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/RegenPortsRequestEndpoints'
          description: The Regen Line Endpoints
    RegenPortsRequestData:
      title: RegenPortsRequestData
      type: object
      properties:
        type:
          type: string
          description: Request type
        regen:
          type: boolean
          description: Regen Attribute
          default: false
        attributes:
          $ref: '#/components/schemas/RegenPortsRequestAttributes'
    RegenPortsRequestEndpoints:
      title: RegenPortsRequestEndpoints
      type: object
      properties:
        networkElement:
          $ref: '#/components/schemas/RegenPortsRequestNetworkElement'
        shelf:
          type: string
          description: The shelf ot the endpoint
        slot:
          type: string
          description: the slot of the endpoint
        port:
          type: string
          description: The port of the endpoint
        role:
          $ref: '#/components/schemas/Role5'
    RegenPortsRequestNetworkElement:
      title: RegenPortsRequestNetworkElement
      type: object
      properties:
        name:
          type: string
          description: The name of the network element
    RegenPortsResponse:
      title: RegenPortsResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RegenPortsResponseData'
          description: The data associated with this request.
    RegenPortsResponseAttributes:
      title: RegenPortsResponseAttributes
      type: object
      properties:
        request:
          type: array
          items:
            $ref: '#/components/schemas/RegenPortsResponseRequest'
          description: The Regen Line Endpoints
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/RegenPortsResponseEndpoints'
          description: The Regen Line Endpoints
    RegenPortsResponseData:
      title: RegenPortsResponseData
      type: object
      properties:
        type:
          type: string
          description: Response type
        id:
          type: string
          description: Regen id
        attributes:
          $ref: '#/components/schemas/RegenPortsResponseAttributes'
        relationships:
          $ref: '#/components/schemas/RegenPortsResponseRelationships'
    RegenPortsResponseEndpoints:
      title: RegenPortsResponseEndpoints
      type: object
      properties:
        networkElement:
          $ref: '#/components/schemas/RegenPortsRequestNetworkElement'
        shelf:
          type: string
          description: The shelf ot the endpoint
        slot:
          type: string
          description: the slot of the endpoint
        port:
          type: string
          description: The port of the endpoint
        role:
          $ref: '#/components/schemas/Role5'
    RegenPortsResponseRelationshipFRES:
      title: RegenPortsResponseRelationshipFRES
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RegenPortsResponseRelationshipFRESData'
          description: The Regen Port FRE relationship data
    RegenPortsResponseRelationshipFRESData:
      title: RegenPortsResponseRelationshipFRESData
      type: object
      properties:
        id:
          type: string
          description: The id of the related FRE
        attributes:
          type: object
    RegenPortsResponseRelationshipTPES:
      title: RegenPortsResponseRelationshipTPES
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RegenPortsResponseRelationshipTPESData'
          description: The Regen Port TPEs relationship data
    RegenPortsResponseRelationshipTPESData:
      title: RegenPortsResponseRelationshipTPESData
      type: object
      properties:
        id:
          type: string
          description: The id of the related TPE
        attributes:
          type: object
    RegenPortsResponseRelationships:
      title: RegenPortsResponseRelationships
      type: object
      properties:
        fres:
          $ref: '#/components/schemas/RegenPortsResponseRelationshipFRES'
        tpes:
          $ref: '#/components/schemas/RegenPortsResponseRelationshipTPES'
    RegenPortsResponseRequest:
      title: RegenPortsResponseRequest
      type: object
      properties:
        networkElement:
          $ref: '#/components/schemas/RegenPortsRequestNetworkElement'
        location:
          $ref: '#/components/schemas/RegenPortsResponseRequestLocation'
    RegenPortsResponseRequestLocation:
      title: RegenPortsResponseRequestLocation
      type: object
      properties:
        shelf:
          type: string
          description: The shelf ot the endpoint
        slot:
          type: string
          description: the slot of the endpoint
        port:
          type: string
          description: The port of the endpoint
    RegenerationNodeRestrictions:
      title: RegenerationNodeRestrictions
      type: object
      properties:
        restriction-scopes:
          type: array
          items:
            $ref: '#/components/schemas/RestrictionScope'
          description: ''
        forbidden-node:
          type: array
          items:
            $ref: '#/components/schemas/GlobalRestrictionRegenerationNode'
          description: ''
    ResiliencyTopologyPackage:
      title: ResiliencyTopologyPackage
      type: object
      properties:
        switchTpeId:
          type: string
          description: Switch port client TPE
        resilientFreId:
          type: string
          description: Resilient nodal fre id
    RouteConstraints:
      title: RouteConstraints
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type33'
        numberOfRoutes:
          type: string
          description: Number of routes defined by the configuration. For example, a PRIME/MEMBER configuration.  Could be a number, or could be a number evident from the model i.e. inverseMux. Generally, should only be specified if the configuration implies more than 1 route.
        sizeOfEachRoute:
          type: string
          description: For each route, what is the required size of each route. For example, '200G' in the case of 400G WLAi OTR 2xOTSi.
        maxInCpGroup:
          type: string
          description: Maximum number of routes that can be present in a control plane group. Could be a number, or could be a number evident n the model i.e. inverseMux.
        routeCharacteristic:
          $ref: '#/components/schemas/RouteCharacteristic'
        signalPattern:
          $ref: '#/components/schemas/SignalPattern'
    SamData:
      title: SamData
      type: object
      properties:
        otsSubtype:
          $ref: '#/components/schemas/OtsSubtype'
        roadmLineTx:
          type: string
          description: The ROADM line label associated with the tx port of this SAM. Must not be included for DGEs or ILAs.
        roadmLineRx:
          type: string
          description: The ROADM line label associated with the rx port of this SAM. Must not be included for DGEs or ILAs.
    SignalIndex:
      title: SignalIndex
      type: object
      properties:
        wavelength:
          type: string
          description: The signal wavelength (nm).
        wavelengthMin:
          type: string
          description: The minimum signal wavelength.
        wavelengthMax:
          type: string
          description: The maximum signal wavelength.
        index:
          type: string
          description: The signal index. Indicates a time slot.
        odu2_index:
          type: string
          description: The odu2 index. Indicates a time slot or tributary port number.
        odu3_index:
          type: string
          description: The odu3 index. Indicates a time slot or tributary port number.
        odu4_index:
          type: string
          description: The odu4 index. Indicates a time slot or tributary port number.
        oduCn_index:
          type: string
          description: The oduCn index. Indicates a time slot or tributary port number.
        eth_index:
          type: string
          description: The eth index.
        indexes:
          type: object
        channels:
          type: array
          items:
            type: string
          description: Indicates the list of discrete channels utilized e.g. tributary slots on broadband cards. Plans are to utilize this generically for any list of discrete list of signals.
        ots_index:
          type: string
          description: The ots index. Indicates a time slot.
        phy_index:
          type: string
          description: The physical index. Indicates a time slot.
        mappingTable:
          type: array
          items:
            $ref: '#/components/schemas/MappingTableEntry'
          description: ''
        frequency:
          type: string
          description: The central signal frequency.
        minFreq:
          type: string
          description: The minimum signal frequency.
        maxFreq:
          type: string
          description: The maximum signal frequency.
        width:
          type: string
          description: The signal width.
        mgmtMcId:
          type: string
          description: The management identifier of the media channel
        isCatchAll:
          type: string
          description: isCatch all enabled on this port
    SiteRestrictions:
      title: SiteRestrictions
      type: object
      properties:
        restriction-scopes:
          type: array
          items:
            $ref: '#/components/schemas/RestrictionScope'
          description: ''
        site:
          type: array
          items:
            $ref: '#/components/schemas/GlobalRestrictionSite'
          description: ''
    SlmResponder:
      title: SlmResponder
      type: object
      properties:
        testId:
          type: integer
          description: The ID of the test
          format: int32
        remoteMepId:
          type: string
          description: The ID of the remote MEP
    Supporting_service_restriction:
      title: Supporting_service_restriction
      type: object
      properties:
        restriction-scopes:
          type: array
          items:
            $ref: '#/components/schemas/RestrictionScope'
          description: ''
        supporting-services:
          type: array
          items:
            type: string
          description: ''
    TandemConnectionMonitoring:
      title: TandemConnectionMonitoring
      type: object
      properties:
        nativeName:
          type: string
          description: The name of the TCM TPE that is native to the network element.
        userLabel:
          type: string
          description: The label given to the TCM TPE by an user
        owner:
          type: string
          description: Identifies who created the TCM facility
        suppTpeNativeName:
          type: string
          description: The supporting Termination Point
        mode:
          type: string
          description: Identifies the mode of the TCM
        state:
          type: string
          description: Primary State of TCM CTP
        additionalAttributes:
          type: object
    Termination:
      title: Termination
      type: object
      properties:
        connectionRulesInOwnLayer:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRule'
          description: ''
    TpeCfmPackage:
      title: TpeCfmPackage
      type: object
      properties:
        cfmServiceName:
          type: string
          description: The name of the CFM service
        mep:
          type: array
          items:
            $ref: '#/components/schemas/MepEntry'
          description: Each entry holds information about one Maintenance Endpoint configured on this TPE
    TrafficProfile:
      title: TrafficProfile
      type: object
      properties:
        inputParams:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfileParam'
          description: List of input parameters to be matched to derive the correct trafficProfile for the use-case.
        trafficParams:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfileParam'
          description: List of traffic parameters that must be used as input in the use-case.
        routeConstraints:
          $ref: '#/components/schemas/RouteConstraints'
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfileParam'
          description: List of outputs that are expected in the use-case.
    TrafficProfileParam:
      title: TrafficProfileParam
      type: object
      properties:
        name:
          type: string
          description: Name of attribute.
        value:
          type: string
          description: Value of attribute.
        selectFrom:
          type: array
          items:
            type: string
          description: Alternate form of value attribute that permits a comma separated list of the choices available for selection.
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        location:
          $ref: '#/components/schemas/Location1'
    TransformTypes:
      title: TransformTypes
      type: object
      properties:
        ingress:
          $ref: '#/components/schemas/L2Transform'
        egress:
          $ref: '#/components/schemas/L2Transform'
    TtiAttribute:
      title: TtiAttribute
      type: object
      properties:
        sapi:
          type: string
          description: String to hold 'sapi' attribute
        dapi:
          type: string
          description: String to hold 'dapi' attribute
        operator:
          type: string
          description: String to hold 'operator' attribute
    TtiPackage:
      title: TtiPackage
      type: object
      properties:
        ttiTx:
          $ref: '#/components/schemas/TtiAttribute'
        ttiRx:
          $ref: '#/components/schemas/TtiAttribute'
        ttiExpectedRx:
          $ref: '#/components/schemas/TtiAttribute'
        traceFailedMode:
          $ref: '#/components/schemas/TraceFailedMode'
    TunnelPath:
      title: TunnelPath
      type: object
      properties:
        pathName:
          type: string
          description: The name of this explicit tunnel path
        hops:
          type: array
          items:
            $ref: '#/components/schemas/HopEntry'
          description: ''
    TxInfo:
      title: TxInfo
      type: object
      properties:
        dropPort:
          type: string
          description: dropPort Info
        transMode:
          type: string
          description: transMode Info
        frequency:
          type: string
          description: frequency Info
        minDispersion:
          type: string
          description: minDispersion Info
        maxDispersion:
          type: string
          description: maxDispersion Info
        lowFrequencyGuardband:
          type: string
          description: lowFrequencyGuardband Info
        highFrequencyGuardband:
          type: string
          description: highFrequencyGuardband Info
        expectedRestorationTime:
          type: string
          description: expectedRestorationTime Info
        linkOptimizationMode:
          type: string
          description: linkOptimizationMode Info
        egressRegenPort:
          type: string
          description: egressRegenPort Info
    UpdatedAttribute:
      title: UpdatedAttribute
      type: object
      properties:
        name:
          type: string
          description: The name of the attribute
        value:
          type: string
          description: The value of the attribute
    UpdatedExpectation:
      title: UpdatedExpectation
      type: object
      properties:
        id:
          type: string
          description: Entity Id
        expectationId:
          type: string
          description: Expectation Id
        updatedAttributes:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedAttribute'
          description: List of updated attributes.
        type:
          type: string
          description: Entity type - EQUIPMENT, TPE, FRE, EQUIPMENTGROUP, NETWORKCONSTRUCT
    UpdatedExpectationsResponse:
      title: UpdatedExpectationsResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedExpectation'
          description: An array of updated expectations
    Y1731Attributes:
      title: Y1731Attributes
      type: object
      properties:
        enabled:
          type: boolean
          description: True when the particular measurement is enabled
          default: false
        mode:
          $ref: '#/components/schemas/Mode'
        interval:
          type: string
          description: 'The interval between transmitting each message (e.g.: 1)'
        intervalUnit:
          type: string
          description: 'The unit of interval between transmitting each message (e.g.: seconds)'
        priority:
          type: string
          description: The priority of the messages being transmitted (0-7)
        frameSize:
          type: string
          description: The frame size of the messages being transmitted (numeric), if applicable to this measurement
        repeatDelay:
          type: integer
          description: The repeat delay of the message being transmitted
          format: int32
        count:
          type: integer
          description: The count of the message being transmitted
          format: int32
        iterate:
          type: integer
          description: The iteration number of the message being transmitted
          format: int32
        remoteMepId:
          type: string
          description: The ID of the remote MEP
        remoteMepMacAddress:
          type: string
          description: The MAC address of the remote MEP
        thresholdProfile:
          type: string
          description: The name of the thresh-hold profile to be used
        accelerate:
          type: boolean
          description: To create accelerated sessions
          default: false
        storedIntervalCount:
          type: integer
          description: Determines session history size (0-96)
          format: int32
        testId:
          type: integer
          description: The ID of the test
          format: int32
        sessionId:
          type: integer
          description: The ID of the test session
          format: int32
        cosMode:
          type: boolean
          description: To enable cos-mode on session
          default: false
        delayBins:
          type: string
          description: The name of the delay bin profile
        delayRangeBins:
          type: string
          description: The name of the delay range bin profile
        ifdvBins:
          type: string
          description: The name of the jitter bin profile
        alignMeasurementInterval:
          type: boolean
          description: Allows measurement intervals to be aligned with the hour on a time-of-day clock
          default: false
        forwardIfdvBins:
          type: string
          description: The name of the forward jitter bin profile
        backwardIfdvBins:
          type: string
          description: The name of the backward jitter bin profile
        measurementInterval:
          type: integer
          description: Discrete interval of time over which a set of PM statistics are calculated and stored
          format: int32
        alignMeasurementOffset:
          type: integer
          description: Allows measurement intervals to be offset a number of minutes from the hour when Align Measurement Intervals is in effect (0-60)
          format: int32
        availConsecutiveHighFlr:
          type: integer
          description: (1-1000)
          format: int32
        availConsecutiveIntervals:
          type: integer
          description: (1-1000)
          format: int32
        availFlrThreshold:
          type: integer
          description: (0-100000 millipercent)
          format: int32
        availConsecutivePduCount:
          type: integer
          description: (10-1000000)
          format: int32
        availMeasurementInterval:
          type: integer
          description: (0-43200 minutes)
          format: int32
        messagePeriod:
          type: integer
          description: 'The interval between message transmission (e.g.: 1)'
          format: int32
        messagePeriodUnit:
          type: string
          description: 'The unit of interval between transmitting each message (e.g.: seconds)'
        repetitionTime:
          type: integer
          description: The period of time between the start of subsequent measurement intervals.
          format: int32
    eDtlRegenIdPackage:
      title: eDtlRegenIdPackage
      type: object
      properties:
        regenPhotonicAddDropTid:
          type: string
          description: Regen Photonic ID TID
        nearPhotonicTxAddDrop:
          type: string
          description: near Photonic Tx Add Drop Shelf SLot Port
    CctPackageRO:
      title: CctPackageRO
      type: object
      properties:
        cctState:
          $ref: '#/components/schemas/CctState'
        failReason:
          type: string
          description: The reason for the failure cctState
        cctData:
          type: object
    EquipmentStaticSpecAttributesRO:
      title: EquipmentStaticSpecAttributesRO
      type: object
      properties:
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        policies:
          $ref: '#/components/schemas/AttributePoliciesRO'
        cctPackage:
          $ref: '#/components/schemas/CctPackageRO'
        reSnrPackage:
          $ref: '#/components/schemas/ReSnrPackageRO'
        additionalAttributes:
          type: object
    EquipmentStaticSpecDataRO:
      title: EquipmentStaticSpecDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the equipment Static Spec resource
        type:
          $ref: '#/components/schemas/Type34'
        attributes:
          $ref: '#/components/schemas/EquipmentStaticSpecAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentStaticSpecRelationshipsRO'
    EquipmentStaticSpecListRO:
      title: EquipmentStaticSpecListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentStaticSpecDataRO'
          description: A list of equipment
        included:
          type: array
          items:
            type: object
          description: Resources related to equipmentStaticSpec, such as EquipmentStaticSpecExpectationData
    EquipmentStaticSpecRO:
      title: EquipmentStaticSpecRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        data:
          $ref: '#/components/schemas/EquipmentStaticSpecDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to equipment spec, such as EquipmentStaticSpecExpectationData
    EquipmentStaticSpecRelationshipsRO:
      title: EquipmentStaticSpecRelationshipsRO
      type: object
      properties:
        equipmentStaticSpecPlanned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentStaticSpecExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        equipmentStaticSpecDiscovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipment:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    ReSnrPackageRO:
      title: ReSnrPackageRO
      type: object
      properties:
        reSnrData:
          type: object
    site_state:
      title: site_state
      enum:
      - ACTIVE
      - STANDBY
      type: string
      description: 'Allowed: "ACTIVE", or "STANDBY". Case insensitive.'
    site_type:
      title: site_type
      enum:
      - LOCAL
      - REMOTE
      - PREVIOUSLY_PAIRED
      type: string
      description: 'Allowed: "LOCAL", "REMOTE", or "PREVIOUSLY_PAIRED". Case insensitive.'
    task_type:
      title: task_type
      enum:
      - RECOVERY
      - ACTIVATION
      type: string
      description: 'Allowed: "RECOVERY", or "ACTIVATION". Case insensitive.'
    task_status:
      title: task_status
      enum:
      - IN_PROGRESS
      - COMPLETED
      - FAILED
      type: string
      description: 'Allowed: "IN_PROGRESS", "COMPLETED", or "FAILED". Case insensitive.'
    connection_status:
      title: connection_status
      enum:
      - DISCONNECTED
      - CONNECTED
      type: string
      description: 'Allowed: "DISCONNECTED", or "CONNECTED". Case insensitive.'
    remote_site:
      title: remote_site
      required:
      - site_id
      - site_state
      - site_address
      type: object
      properties:
        site_id:
          pattern: '[a-zA-Z0-9_-]{3,}$'
          type: string
          description: Each site should have unique string. Supports length>=3 strings of alphanumeric characters plus '_' and '-'.
        site_state:
          $ref: '#/components/schemas/site_state'
        site_address:
          type: string
          description: Network address at which remote site can be reached.
    resyncRequest:
      title: resyncRequest
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/resyncRequestData'
          description: ''
    resyncRequestData:
      title: resyncRequestData
      required:
      - id
      - type
      - attributes
      type: object
      properties:
        id:
          type: string
          description: Site ID to sync data from
        type:
          enum:
          - resync
          type: string
          description: Type of resync request
        attributes:
          $ref: '#/components/schemas/Attributes5'
    requestError:
      title: requestError
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Errors2'
          description: ''
      description: Errors that occurred
    site:
      title: site
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data92'
      example:
        data:
          id: SiteA
          type: site
          attributes:
            site_type: PREVIOUSLY_PAIRED
            site_id: SiteA
            site_is_bootstrapped: true
            site_index: 1
            site_address: 10.186.0.250
            connection_status: DISCONNECTED
            last_connected_time: 2019-09-16T15:22:31:532Z
    sites:
      title: sites
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/siteData'
          description: ''
    siteData:
      title: siteData
      type: object
      properties:
        id:
          type: string
          description: the unique site ID
        type:
          $ref: '#/components/schemas/Type35'
        attributes:
          $ref: '#/components/schemas/Attributes72'
      description: A site
    siteAttributes:
      title: siteAttributes
      type: object
      properties:
        siteState:
          $ref: '#/components/schemas/site_state'
        siteType:
          $ref: '#/components/schemas/site_type'
        siteId:
          pattern: '[a-zA-Z0-9_-]{3,}$'
          type: string
          description: Each site should have unique string. Supports length>=3 strings of alphanumeric characters plus '_' and '-'.
        siteIndex:
          type: integer
          description: The index of the site
          format: int32
        siteAddress:
          type: string
          description: Network address at which remote site can be reached.
        connectionStatus:
          $ref: '#/components/schemas/connection_status'
        siteRecovery:
          $ref: '#/components/schemas/SiteRecovery'
        siteActivation:
          $ref: '#/components/schemas/SiteActivation2'
        lastConnectedTime:
          type: string
          description: The last time the site was connected, in format 2018-05-10T15:00:00.000Z
          format: date-time
        lastDisconnectedTime:
          type: string
          description: The last time the site was disconnected, in format 2018-05-10T15:00:00.000Z
          format: date-time
        lastResyncTime:
          type: string
          description: The last time the site was resynchronized, in format 2018-05-10T15:00:00.000Z
          format: date-time
        processState:
          type: array
          items:
            $ref: '#/components/schemas/processState'
          description: The processing states of Inventory, Alarm and PM
      description: attributes of a site
    siteTask:
      title: siteTask
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data102'
    siteTaskData:
      title: siteTaskData
      type: object
      properties:
        id:
          type: string
          description: the unique site ID
        type:
          $ref: '#/components/schemas/task_type'
        attributes:
          $ref: '#/components/schemas/Attributes82'
      description: Site task data
    siteActivation:
      title: siteActivation
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data102'
    siteTaskAttributes:
      title: siteTaskAttributes
      type: object
      properties:
        taskType:
          $ref: '#/components/schemas/task_type'
        status:
          $ref: '#/components/schemas/task_status'
        startTime:
          type: string
          description: The time at which the task was started
        duration:
          type: string
          description: The elapsed time of the task
        progress:
          type: string
          description: The progress of the task, e.g. step 3 of 8
        currentStepNum:
          type: string
          description: The number of the current task step
        currentStep:
          type: string
          description: The name of the current step
        previousStep:
          type: string
          description: The name of the previous step
        error:
          type: string
          description: The error in event of failure
      description: attributes of a site operational task (activation, recovery)
    processState:
      title: processState
      type: object
      properties:
        process:
          type: string
          description: process name
        state:
          type: string
          description: process state. BUSY, NORMAL or UNAVAILABLE
      description: The processing state of a process
    Response:
      title: Response
      type: object
      properties:
        metadata:
          type: object
          additionalProperties:
            type: object
        entity:
          type: object
        status:
          type: integer
          format: int32
    GroupAttributesRO:
      title: GroupAttributesRO
      type: object
      properties:
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        userData:
          type: object
        identifiers:
          type: array
          items:
            type: object
          description: ''
        groupType:
          type: string
        freIds:
          type: array
          items:
            type: string
          description: A set of fre Ids for the given Group
        name:
          type: string
          description: Name of the group.
        additionalAttributes:
          type: object
    GroupDataRO:
      title: GroupDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the Group resource
        type:
          $ref: '#/components/schemas/Type36'
        attributes:
          $ref: '#/components/schemas/GroupAttributesRO'
        relationships:
          $ref: '#/components/schemas/GroupRelationshipsRO'
    GroupListRO:
      title: GroupListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/GroupDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Resources related to group, such as GroupPlanned
    GroupPatchOperationRO:
      title: GroupPatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op4'
        attributes:
          $ref: '#/components/schemas/GroupAttributesRO'
        attribute:
          type: string
          description: name of an attribute to be deleted
        path:
          type: string
          description: path of the object/attribute to be patched
        keys:
          type: array
          items:
            type: string
          description: Used to target specific key(s) of the attribute to be deleted
        relationships:
          $ref: '#/components/schemas/GroupPlannedRelationshipsRO'
    GroupPatchRO:
      title: GroupPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/GroupPatchOperationRO'
          description: ''
    GroupPlannedAttributesRO:
      title: GroupPlannedAttributesRO
      type: object
      properties:
        name:
          type: string
          description: Name of the group.
        groupType:
          type: string
          description: Type of the group
        additionalAttributes:
          type: object
    GroupPlannedDataRO:
      title: GroupPlannedDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the Group resource
        type:
          $ref: '#/components/schemas/Type37'
        attributes:
          $ref: '#/components/schemas/GroupPlannedAttributesRO'
        relationships:
          $ref: '#/components/schemas/GroupPlannedRelationshipsRO'
    GroupPlannedRO:
      title: GroupPlannedRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GroupPlannedDataRO'
    GroupPlannedRelationshipsRO:
      title: GroupPlannedRelationshipsRO
      type: object
      properties:
        parentGroup:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    GroupRO:
      title: GroupRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        data:
          $ref: '#/components/schemas/GroupDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to group, such as GroupPlanned
    GroupRelationshipsRO:
      title: GroupRelationshipsRO
      type: object
      properties:
        groupPlanned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstructs:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        fres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        parentGroup:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    DailySummaryRO:
      title: DailySummaryRO
      type: object
      properties:
        totalDaysWithEvents:
          type: integer
          format: int32
          readOnly: true
        dailyCounts:
          type: array
          items:
            $ref: '#/components/schemas/DayCountRO'
          description: ''
          readOnly: true
    DayCountRO:
      title: DayCountRO
      type: object
      properties:
        day:
          type: string
          readOnly: true
        eventCount:
          type: integer
          format: int64
          readOnly: true
    FilterRO:
      title: FilterRO
      type: object
      properties:
        filterName:
          type: string
          readOnly: true
        filterKey:
          type: string
          readOnly: true
        filterValues:
          type: array
          items:
            type: string
          description: ''
          readOnly: true
    FiltersRO:
      title: FiltersRO
      type: object
      properties:
        availableFilters:
          type: array
          items:
            $ref: '#/components/schemas/FilterRO'
          description: ''
          readOnly: true
        filteredEvents:
          type: integer
          format: int32
          readOnly: true
    QueryPagingRO:
      title: QueryPagingRO
      type: object
      properties:
        page:
          type: integer
          format: int32
        resultsPerPage:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
          readOnly: true
        totalResults:
          type: integer
          format: int32
          readOnly: true
    ServiceEventListEntryAttributesRO:
      title: ServiceEventListEntryAttributesRO
      type: object
      properties:
        weekCode:
          type: integer
          format: int32
          readOnly: true
        timestamp:
          type: string
          readOnly: true
        category:
          type: string
          readOnly: true
        eventName:
          type: string
        userName:
          type: string
        serviceId:
          type: string
          readOnly: true
    ServiceEventsListEntryRO:
      title: ServiceEventsListEntryRO
      type: object
      properties:
        type:
          type: string
        id:
          type: string
          readOnly: true
        attributes:
          $ref: '#/components/schemas/ServiceEventListEntryAttributesRO'
    ServiceEventsListMetadataRO:
      title: ServiceEventsListMetadataRO
      type: object
      properties:
        timeTakenMillis:
          type: integer
          format: int64
        cachingInformation:
          allOf:
          - $ref: '#/components/schemas/CachingInformation'
          - {}
          readOnly: true
        queryTimeMs:
          type: integer
          format: int64
        maxResultCountExceeded:
          type: boolean
          default: false
        serviceId:
          type: string
          readOnly: true
        totalEventCount:
          type: integer
          format: int64
          readOnly: true
        filters:
          $ref: '#/components/schemas/FiltersRO'
        paging:
          $ref: '#/components/schemas/QueryPagingRO'
        dailySummary:
          $ref: '#/components/schemas/DailySummaryRO'
    ServiceEventsQueryResponseRO:
      title: ServiceEventsQueryResponseRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ServiceEventsListEntryRO'
          description: ''
          readOnly: true
        meta:
          $ref: '#/components/schemas/ServiceEventsListMetadataRO'
    AccessPointRO:
      title: AccessPointRO
      type: object
      properties:
        adaptsToLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        adaptsToLayerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        cardinality:
          type: string
          description: Number of possible potential TPEs. Can be a numeric (eg '1', '96', '1000', ...) or can be categorical (eg 'indirect').
        clientTpeRulesInOwnLayer:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRuleRO'
          description: Directions of how to instantiate client TPE(s) for this access point, including indirect (client over client) client TPE instantiation.
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        regenIdPackage:
          $ref: '#/components/schemas/RegenIdPackageRO'
        eDtlRegenIdPackage:
          $ref: '#/components/schemas/eDtlRegenIdPackageRO'
        cascadedDtlTpePackage:
          $ref: '#/components/schemas/CascadedDtlTpePackageRO'
        mirroringBandwidthRules:
          type: string
          description: The mirroringBandwithRules for capacity calculation
        mirroringNamingRules:
          type: string
          description: The mirroringNamingRules for capacity calculation
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        potentialGrowthCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        namingRules:
          type: array
          items:
            $ref: '#/components/schemas/NamingRulesRO'
          description: ''
        stitchingConstraint:
          $ref: '#/components/schemas/StitchingConstraint'
    AdaptationPoolRO:
      title: AdaptationPoolRO
      type: object
      properties:
        name:
          type: string
          description: Name of the AdaptationPool. Unique in the scope of this TPE.
        logicalRule:
          $ref: '#/components/schemas/LogicalRule'
        poolAdapters:
          type: array
          items:
            $ref: '#/components/schemas/AdapterRO'
          description: ''
        memberAdaptationPools:
          type: array
          items:
            type: string
          description: Reference(s) to 0 or more member AdaptationPool-s. Allows for nesting of AdaptationPools.
        namingRules:
          type: object
    AdapterRO:
      title: AdapterRO
      type: object
      properties:
        name:
          type: string
          description: Name of the Adapter. Unique in the scope of this TPE.
        adaptsToLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        adaptsToLayerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        poolAdapterType:
          type: string
          description: The type for the adapter.
        connectionRulesInAdaptationLayer:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRuleRO'
          description: Directions of how to instantiate client TPE(s) for this adapter, including indirect (client over client) client TPE instantiation.
        cardinality:
          type: string
          description: Number of possible potential TPEs. Can be a numeric (eg '1', '96', '1000', ...) or can be categorical (eg 'indirect').
        continuousAdapterRulesPackage:
          $ref: '#/components/schemas/ContinuousAdapterRulesPackageRO'
        mappingInteractionRules:
          type: array
          items:
            $ref: '#/components/schemas/MappingInteractionRuleRO'
          description: The specification of the interaction between the support for different client layer protocols signals.
        potentialAdapterCapacities:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: Total potential capacity of this Adapter.
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        photonicSpectrumPackage:
          $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
        nameToCapacityMappingRules:
          type: array
          items:
            $ref: '#/components/schemas/NameToCapacityMappingRulesRO'
          description: ''
        eFreTerminationState:
          $ref: '#/components/schemas/EFreTerminationState'
        additionalAttributes:
          type: object
        mirroringBandwidthRules:
          type: string
          description: The mirroringBandwithRules for capacity calculation
        mirroringNamingRules:
          type: string
          description: The mirroringNamingRules for capacity calculation
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        potentialGrowthCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        namingRules:
          type: array
          items:
            $ref: '#/components/schemas/NamingRulesRO'
          description: ''
        stitchingConstraint:
          $ref: '#/components/schemas/StitchingConstraint'
    AdjacencyPackageRO:
      title: AdjacencyPackageRO
      type: object
      properties:
        adjacencyType:
          type: string
          description: 'This field delimits the adjacency type between two network elements (Ex: LIM, LINE, etc...).'
        localTag:
          type: string
          description: The actual tag of the originating network element.
        localTagFormat:
          type: string
          description: The format of the local adjacency tag.
        provisionedRemoteTag:
          type: string
          description: The provisioned remote tag is the expected destination defined by the user that adheres to the remoteTagFormat.
        provisionedRemoteTagFormat:
          type: string
          description: The format of the remote provisioning adjacency tag.
        remoteTag:
          type: string
          description: The actual remote tag as discovered by the network element.
        remoteTagFormat:
          type: string
          description: The format of the remote adjacency tag.
        topologySourceTag:
          type: string
          description: The tag representing the topological state. This could be 'DISCOVERED', for example.
        adjacencyMechanism:
          type: string
          description: The attribute defining the adjacency mechanism used.
        linkAttributes:
          $ref: '#/components/schemas/LinkAttributesRO'
    AffinityRO:
      title: AffinityRO
      type: object
      properties:
        value:
          type: string
          description: Affinity
        mask:
          type: string
          description: Affinity Mask
    AfiSafiNextHopSelfRO:
      title: AfiSafiNextHopSelfRO
      type: object
      properties:
        configured:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
        excludeReflectedRoutes:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
    AfiSafiOrfRO:
      title: AfiSafiOrfRO
      type: object
      properties:
        type:
          type: string
          description: Outbound Route Filtering type
        direction:
          $ref: '#/components/schemas/Direction2'
    AfiSafiPrefixListRO:
      title: AfiSafiPrefixListRO
      type: object
      properties:
        name:
          type: string
          description: Name to filter BGP advertisements.
        direction:
          $ref: '#/components/schemas/Direction1'
    ArpRemoteRO:
      title: ArpRemoteRO
      type: object
      properties:
        type:
          type: string
          description: The ID resource type
        id:
          type: string
          description: The unique identifier for the referenced resource
    AssociationObjectAttributesRO:
      title: AssociationObjectAttributesRO
      type: object
      properties:
        associations:
          type: array
          items:
            $ref: '#/components/schemas/AssociationRO'
          description: List of associations
    AssociationRO:
      title: AssociationRO
      type: object
      properties:
        orderIndex:
          type: integer
          description: The order index value of this entry (to allow defining an entry order)
          format: int32
        relationshipType:
          $ref: '#/components/schemas/RelationshipType'
        relationship:
          $ref: '#/components/schemas/Relationship1'
        freType:
          type: string
          description: The type of the fre that's associated with.
        identifier:
          type: object
        id:
          type: string
          description: The id of the resource being referenced by this association
        nodalId:
          type: string
          description: The id of the resource being referenced by this association
    BandwidthThresholdRO:
      title: BandwidthThresholdRO
      type: object
      properties:
        ODU0:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU0) advertised for a link.
        ODU1:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU1) advertised for a link.
        ODU2:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU2) advertised for a link.
        ODU2E:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU2E) advertised for a link.
        ODU3:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU3) advertised for a link.
        ODU4:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (here unit of ODU4) advertised for a link.
        ODUFLEXRSZ:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (in Bps) for Resizable ODU Flex advertised for a link.
        ODUFLEXNRSZ:
          type: string
          description: The Bandwidth Threshold shows the maximum number of bandwidth units (in Bps) for Non-Resizable ODU Flex advertised for a link.
    BandwidthTriggersRO:
      title: BandwidthTriggersRO
      type: object
      properties:
        dependentLinks:
          type: array
          items:
            type: string
          description: List of dependent LLDP/LAG for the stitched FRE.
        dependentTunnels:
          type: array
          items:
            type: string
          description: List of dependent Tunnels for the stitched FRE.
        maxBW:
          type: string
          description: Maximum BW for the FRE.
        assignedBW:
          type: string
          description: Used BW by the FRE.
    BfdRO:
      title: BfdRO
      type: object
      properties:
        configured:
          type: boolean
          description: True when BFD is enabled on this endpoint
          default: false
        profileName:
          type: string
          description: The profile name associated with this set of BFD attributes
        adminState:
          $ref: '#/components/schemas/AdminState'
        operationalState:
          $ref: '#/components/schemas/OperationalState'
        role:
          $ref: '#/components/schemas/Role1'
        transmitInterval:
          type: string
          description: The interval between transmitting BFD messages
        receiveInterval:
          type: string
          description: The interval between receiving BFD messages
    BgpAddPathRO:
      title: BgpAddPathRO
      type: object
      properties:
        capability:
          $ref: '#/components/schemas/Capability1'
        advertise:
          $ref: '#/components/schemas/Advertise1'
        diversePath:
          type: boolean
          description: BGP PIC Diverse Path.
          default: false
    BgpAfiSafiRO:
      title: BgpAfiSafiRO
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        activated:
          type: boolean
          description: true if activated otherwise false
          default: false
        grCapability:
          $ref: '#/components/schemas/GrCapability'
        prefixList:
          $ref: '#/components/schemas/AfiSafiPrefixListRO'
        orf:
          $ref: '#/components/schemas/AfiSafiOrfRO'
        addPath:
          $ref: '#/components/schemas/BgpAddPathRO'
        routeMap:
          type: array
          items:
            $ref: '#/components/schemas/BgpRouteMapRO'
          description: ''
        rrEnabled:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
        nextHopSelf:
          $ref: '#/components/schemas/AfiSafiNextHopSelfRO'
    BgpBfdRO:
      title: BgpBfdRO
      type: object
      properties:
        configured:
          type: boolean
          description: True when BFD is enabled on this endpoint
          default: false
        profileName:
          type: string
          description: The profile name associated with this set of BFD attributes
        adminState:
          $ref: '#/components/schemas/AdminState'
        operationalState:
          $ref: '#/components/schemas/OperationalState'
        role:
          $ref: '#/components/schemas/Role1'
        transmitInterval:
          type: string
          description: The interval between transmitting BFD messages
        receiveInterval:
          type: string
          description: The interval between receiving BFD messages
        mhop:
          type: boolean
          description: True when BFD is enabled on this endpoint
          default: false
    BgpFrrRO:
      title: BgpFrrRO
      type: object
      properties:
        ipv4Unicast:
          $ref: '#/components/schemas/Ipv4Unicast'
        ipv4LabeledUnicast:
          $ref: '#/components/schemas/Ipv4LabeledUnicast'
    BgpMsgsRO:
      title: BgpMsgsRO
      type: object
      properties:
        peerInUpdates:
          type: string
          description: Number of peer in updates
        peerOutUpdates:
          type: string
          description: Number of peer out updates
        peerInTotalMessages:
          type: string
          description: Total Number of peer messages
        peerOutTotalMessages:
          type: string
          description: Total number of peer out messages
        peerInUpdateElapsedTime:
          type: string
          description: Peer updated elapsed time in seconds
        lastError:
          $ref: '#/components/schemas/MsgsLastErrorRO'
    BgpPackageRO:
      title: BgpPackageRO
      type: object
      properties:
        peerType:
          $ref: '#/components/schemas/PeerType'
        peerAs:
          type: integer
          description: Autonomous System number configured for the peer.
          format: int64
        peerBgpIdentifier:
          type: string
          description: BGP identifier of the peer. Learned only in OPEN CONFIRM and ESTABLISHED states.
        peerState:
          $ref: '#/components/schemas/PeerState'
        peerNegotiatedBGPVersion:
          type: string
          description: Learned only in OPENCONFIRM and ESTABLISHED states.
        peerFsmEstablishedTransitions:
          type: string
          description: Peer Fsm established transitions.
        security:
          $ref: '#/components/schemas/BgpSecurityRO'
        peerFsmEstablishedTime:
          type: string
          description: Peer Fsm established time in seconds.
        bfd:
          $ref: '#/components/schemas/BgpBfdRO'
        transport:
          $ref: '#/components/schemas/BgpTransportRO'
        timers:
          $ref: '#/components/schemas/BgpTimersRO'
        rr:
          $ref: '#/components/schemas/BgpRrRO'
        msgs:
          $ref: '#/components/schemas/BgpMsgsRO'
        afiSafi:
          type: array
          items:
            $ref: '#/components/schemas/BgpAfiSafiRO'
          description: ''
    BgpRouteMapRO:
      title: BgpRouteMapRO
      type: object
      properties:
        name:
          type: string
          description: The route-map name.
        direction:
          $ref: '#/components/schemas/Direction3'
    BgpRrRO:
      title: BgpRrRO
      type: object
      properties:
        peerClusterId:
          type: string
          description: The cluster-id to which peer belongs if it is configured as RR client.
        peerRole:
          $ref: '#/components/schemas/PeerRole'
        role:
          $ref: '#/components/schemas/Role3'
    BgpSecurityRO:
      title: BgpSecurityRO
      type: object
      properties:
        md5Authentication:
          $ref: '#/components/schemas/Md5Authentication'
    BgpTimersRO:
      title: BgpTimersRO
      type: object
      properties:
        peerConnectRetryInterval:
          type: string
          description: Peer connection retry intervel in seconds.
        peerNegotiatedHoldTime:
          type: string
          description: Peer negotiation hold time in seconds
        peerConfiguredHoldTime:
          type: string
          description: Peer configured hold time in seconds
        peerNegotiatedKeepAliveTime:
          type: string
          description: Peer negotiation keep alive time in seconds
        peerConfiguredKeepAliveTime:
          type: string
          description: Peer configured keep alive time in seconds
        peerMinASOriginationInterval:
          type: string
          description: Peer minimum AS origination intervel in seconds
        peerMinRouteAdvertisementInterval:
          type: string
          description: Peer minimum advertised intervel in seconds
    BgpTransportRO:
      title: BgpTransportRO
      type: object
      properties:
        updateSource:
          type: string
          description: The name of IP interface used with update-source.
        localIp:
          type: string
          description: If update-source is configured then IP address of the interface. Rely on learned localIp if it is reported. Reported in OPENCONFIRM and ESTABLISHED states.
        localPort:
          type: string
          description: Local port reported in OPENCONFIRM and ESTABLISHED states.
        peerIp:
          type: string
          description: Peer Ip configured as part of BGP peer configuration.
        peerPort:
          type: string
          description: Peer port reported in OPENCONFIRM and ESTABLISHED states.
    BookingDataRO:
      title: BookingDataRO
      type: object
      properties:
        assignedBandwidth:
          type: string
          description: The bandwidth assigned to the link.
        assignedBandwidthUnit:
          type: string
          description: The unit of the bandwidth assigned to the link.
        bandwidthLockout:
          type: boolean
          description: Flag that enables/disables a link from having additional tunnel BW being consumed.
          default: false
        bookingFactor:
          type: string
          description: The factor that dictates how much overbooking is allowed.
    BwRO:
      title: BwRO
      type: object
      properties:
        unit:
          type: string
          description: 'The bandwidth unit that applies to all bandwidth attributes in this package. Available values: bps, kbps, mbps, gbps'
        used:
          type: string
          description: The current used bandwidth by all supported clients
        minimum:
          type: string
          description: The minimum bandwidth configured for supported clients
        maximum:
          type: string
          description: The maximum bandwidth configured for supported clients
        increment:
          type: string
          description: The configured bandwidth increment for auto-sizing of an MPLS tunnel
        requested:
          type: string
          description: The requested bandwidth from the supporting layer, e.g. a dynamic tunnel requesting bandwidth from IP interface
        operational:
          type: string
          description: The current bandwidth being allocated from the supporting layer
        total:
          type: string
          description: The total bandwidth allocated or allowed, e.g. the capacity of an IP interface
        bookingFactor:
          type: string
          description: The booking factor of how much the bandwidth can be oversubscribed, e.g. on an IP interface
        maxReservable:
          type: string
          description: The maximum reservable bandwidth allowed to be allocated to supported clients and it's calculated as bwBookingFactor x bwTotal
        available:
          type: string
          description: The available bandwidth left to be
        autoSize:
          $ref: '#/components/schemas/AutoSize'
        autoSizingMode:
          $ref: '#/components/schemas/AutoSizingMode'
        autoSizeFailureAction:
          $ref: '#/components/schemas/AutoSizeFailureAction'
        autoSizeIntervalMinutes:
          type: string
          description: The configured interval between auto-sizing attempts
        autoSizeLastResizeState:
          $ref: '#/components/schemas/AutoSizeLastResizeState'
        autoSizeLastResizeStartTime:
          type: string
          description: Start time of the last auto resize happened
        autoSizeLastResizeEndTime:
          type: string
          description: End time of the last auto resize happened
        autoSizeLastResizeReason:
          type: string
          description: Reason of the last auto resize happened
        profileName:
          type: string
          description: The name of the bandwidth profile associated with the dynamic tunnel endpoint
    CalendarChannelDetailsRO:
      title: CalendarChannelDetailsRO
      type: object
      properties:
        calendars:
          type: array
          items:
            $ref: '#/components/schemas/CalendarDetailsRO'
          description: List of calendar details for the FlexE group
        channels:
          type: object
    CalendarDetailsRO:
      title: CalendarDetailsRO
      type: object
      properties:
        calendarName:
          type: string
          description: Name for FlexE calendar
        calendarMappings:
          type: array
          items:
            $ref: '#/components/schemas/PhyDetailsRO'
          description: List of calendar-slot mappings of the FlexE calendar for the FlexE group
    CapacityPatternRO:
      title: CapacityPatternRO
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type30'
        format:
          type: string
          description: An optional regex expression or format string describing how to parse the size string in case of multiple values, e.g. CIR:EIR
    CapacityRO:
      title: CapacityRO
      type: object
      properties:
        layer:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        capacityClass:
          $ref: '#/components/schemas/CapacityClass'
        capacity:
          type: integer
          description: Number of potential client instances or usage instances
          format: int32
        capacityType:
          $ref: '#/components/schemas/CapacityType'
        capacitySize:
          $ref: '#/components/schemas/CapacitySizeRO'
        capacityCalculationRule:
          type: string
          description: Core logic that will be used on capacity calculation
        source:
          type: string
          description: Source of the capacity
        maxLimit:
          type: integer
          description: Maximum potential client instances
          format: int32
    CapacityReservationRO:
      title: CapacityReservationRO
      type: object
      properties:
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        usedCapacity:
          $ref: '#/components/schemas/CapacityRO'
    CapacitySizeRO:
      title: CapacitySizeRO
      type: object
      properties:
        size:
          type: array
          items:
            type: string
          description: Capacity size to be interpreted with CapacityPattern
        pattern:
          $ref: '#/components/schemas/CapacityPatternRO'
        unit:
          type: string
          description: unit for size string value
    CascadedDtlTpePackageRO:
      title: CascadedDtlTpePackageRO
      type: object
      properties:
        cascadedDtlIdTuple:
          type: string
          description: This field Cascaded DTL ID Tuple info..
    ClassOfServicesRO:
      title: ClassOfServicesRO
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name1'
        bandwidthProfileName:
          type: string
          description: Name of the Bandwidth Profile
        bandwidthProfileIndex:
          type: string
          description: Index number of the Bandwidth Profile
    ClientToClientRO:
      title: ClientToClientRO
      type: object
      properties:
        intraCluster:
          $ref: '#/components/schemas/IntraCluster'
    ClusterRO:
      title: ClusterRO
      type: object
      properties:
        clusterId:
          type: string
          description: Id of this Cluster.
        clientToClient:
          $ref: '#/components/schemas/ClientToClientRO'
    ColorEntryRO:
      title: ColorEntryRO
      type: object
      properties:
        name:
          type: string
          description: The name of the color
        bitmask:
          type: string
          description: The 32-bit hexadecimal bitmask of the color
    ColorGroupRO:
      title: ColorGroupRO
      type: object
      properties:
        name:
          type: string
          description: The name of the color group
        bitmask:
          type: string
          description: The 32-bit hexadecimal bitmask of the color group
        colors:
          type: array
          items:
            $ref: '#/components/schemas/ColorEntryRO'
          description: ''
    ConnectionPointRO:
      title: ConnectionPointRO
      type: object
      properties:
        owningPoolAdapterType:
          type: string
          description: Type of the owner Adapter.
        dynamicOwningPoolAdapterFgiRules:
          type: array
          items:
            type: string
          description: dynamicOwningPoolAdapterFgiRules
        mirroringBandwidthRules:
          type: string
          description: The mirroringBandwithRules for capacity calculation
        mirroringNamingRules:
          type: string
          description: The mirroringNamingRules for capacity calculation
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        potentialGrowthCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        namingRules:
          type: array
          items:
            $ref: '#/components/schemas/NamingRulesRO'
          description: ''
        stitchingConstraint:
          $ref: '#/components/schemas/StitchingConstraint'
    ConnectionRuleRO:
      title: ConnectionRuleRO
      type: object
      properties:
        targetLayer:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        rule:
          $ref: '#/components/schemas/Rule'
        immediateClientPotential:
          type: string
          description: 'If describing connectionRulesInAdaptationLayer: names of TPESpec of immediate client TPE. If describing connectionRulesInOwnLayer: null (not relevant). If describing mustConnectInternally: null (not relevant).'
        immediateDualPortPeerPotential:
          type: string
          description: 'If describing connectionRulesInAdaptationLayer: names of TPESpec of dual port peer TPE. If describing connectionRulesInOwnLayer: null (not relevant). If describing mustConnectInternally: null (not relevant).'
    ContinuousAdapterRulesPackageRO:
      title: ContinuousAdapterRulesPackageRO
      type: object
      properties:
        segmentationRule:
          $ref: '#/components/schemas/SegmentationRule'
        widthRule:
          $ref: '#/components/schemas/WidthRule'
        lowerBoundaryRule:
          $ref: '#/components/schemas/LowerBoundaryRule'
        upperBoundaryRule:
          $ref: '#/components/schemas/LowerBoundaryRule'
        centerFrequencyRule:
          $ref: '#/components/schemas/CenterFrequencyRule'
    ControlPlanePackageRO:
      title: ControlPlanePackageRO
      type: object
      properties:
        sncType:
          $ref: '#/components/schemas/SncType'
        meshRestorable:
          type: boolean
          default: false
        grouped:
          type: boolean
          default: false
        exclusiveRouting:
          type: boolean
          default: false
        sncRole:
          $ref: '#/components/schemas/SncRole'
        sncpPackage:
          $ref: '#/components/schemas/SncpPackageRO'
        backOffPeriod:
          type: integer
          description: Back-off period for retrying SNC setup
          format: int32
        regroomAllowed:
          type: boolean
          description: Indicates if re-groom operation can be performed on this SNC.
          default: false
        ovpnIds:
          type: array
          items:
            type: string
          description: The primary optical virtual private network ID list
        secOvpnIds:
          type: array
          items:
            type: string
          description: The secondary optical virtual private network ID list
        configuredLatencyType:
          $ref: '#/components/schemas/ConfiguredLatencyType'
        rhpEnabled:
          type: boolean
          description: Retain Home Path capability for the SNC.
          default: false
        integrityCheckEnabled:
          $ref: '#/components/schemas/IntegrityCheckEnabled'
        meshAttemptLimitEnabled:
          type: boolean
          description: Mesh Attempt Limit capability for the SNC.
          default: false
        meshAttemptLimit:
          type: integer
          description: Indicate configured number of Mesh Limit of SNC
          format: int32
        meshAttemptCounter:
          type: integer
          description: Indicate remaining number of Mesh Limit of SNC
          format: int32
        nativePST:
          type: string
          description: The parameter indicated SNC's state. The value is derived from PST value of SNC
        homePathPreemption:
          $ref: '#/components/schemas/SncPreemptionPackageRO'
        restorationPathPreemption:
          $ref: '#/components/schemas/SncPreemptionPackageRO'
    DfElectionRO:
      title: DfElectionRO
      type: object
      properties:
        role:
          $ref: '#/components/schemas/Role10'
        configuredDfElectionMethod:
          $ref: '#/components/schemas/ConfiguredDfElectionMethod'
        operationalDfElectionMethod:
          $ref: '#/components/schemas/OperationalDfElectionMethod'
        selectHighPreference:
          type: boolean
          description: Preference with higher value will be selected first
          default: false
        configuredPerference:
          type: integer
          description: The configured DF preference
          format: int32
        operationalPerference:
          type: integer
          description: The operational DF preference
          format: int32
        configuredRevertive:
          type: boolean
          description: The 'preempt' or 'revertive' behavior
          default: false
        operationalRevertive:
          type: boolean
          description: The 'preempt' or 'revertive' behavior
          default: false
        electionWaitTime:
          type: integer
          description: Wait time for DF election
          format: int32
        reversionHoldTime:
          type: integer
          description: Duration before reversion
          format: int32
    DhcpRelayAgentRO:
      title: DhcpRelayAgentRO
      type: object
      properties:
        enable:
          type: boolean
          description: Disable the DHCP relay agent
          default: false
        serverIp:
          type: string
          description: The IP address the relay agent should forward to
    DhcpRelayAgentRO_1:
      title: DhcpRelayAgentRO_1
      type: object
      properties:
        enable:
          type: boolean
          description: Disable the DHCP relay agent
          default: false
        serverIp:
          type: string
          description: The IP address the relay agent should forward to
    EsiTypeRO:
      title: EsiTypeRO
      type: object
      properties:
        value:
          $ref: '#/components/schemas/Value'
        systemMacAddress:
          type: string
          description: ESI System MAC (6 octets)
    EthernetSegmentRO:
      title: EthernetSegmentRO
      type: object
      properties:
        name:
          type: string
          description: Name of the ethernet segment
        esiId:
          type: string
          description: Ethernet Segment Identifier (ESI)
        label:
          type: integer
          description: Segment label of EVPN
          format: int32
        logicalPort:
          type: string
          description: Logical port of the ethernet segment
        evlag:
          type: boolean
          description: Enable/disable EvLag on the AGG port
          default: false
        esiType:
          $ref: '#/components/schemas/EsiTypeRO'
        multiHoming:
          type: boolean
          description: is multiHoming in segment
          default: false
        multiHomingMode:
          $ref: '#/components/schemas/MultiHomingMode'
        interfaceStatus:
          $ref: '#/components/schemas/InterfaceStatus'
        designatedForwarder:
          $ref: '#/components/schemas/DfElectionRO'
        evpnId:
          type: string
          description: Evpn Id associated with ethernet Segment
        eviId:
          type: string
          description: EVPN Instance ID (EVI)
    EvpnRO:
      title: EvpnRO
      type: object
      properties:
        evi:
          $ref: '#/components/schemas/FreVrfPackageRO'
        service:
          $ref: '#/components/schemas/EvpnServiceRO'
    EvpnServiceRO:
      title: EvpnServiceRO
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type40'
        localServiceId:
          type: integer
          description: service ID of locally connected CE
          format: int32
        remoteServiceId:
          type: integer
          description: service ID of remote connected CE
          format: int32
        l2mtu:
          type: integer
          description: This attribute sets the MTU for an Instance. By default, the value is set to 1500.
          format: int32
        controlWord:
          type: boolean
          description: The attribute enables or disables the control-word for an Instance.By default, the value is true.
          default: false
        operationalState:
          $ref: '#/components/schemas/OperationalState5'
    ExplicitRouteGroupRO:
      title: ExplicitRouteGroupRO
      type: object
      properties:
        groupType:
          $ref: '#/components/schemas/GroupType'
    ExternalRoutePackageRO:
      title: ExternalRoutePackageRO
      type: object
      properties:
        staticRoute:
          $ref: '#/components/schemas/StaticRouteRO'
    FbProfileRO:
      title: FbProfileRO
      type: object
      properties:
        profileName:
          type: string
          description: The profile name associated with this set of Fb attributes
        index:
          type: integer
          description: Index count of profile
          format: int32
        associatedInterfaces:
          type: array
          items:
            type: string
          description: List of IP interfaces this FB profile is associated with
        nodesShareSrlg:
          type: array
          items:
            type: string
          description: List of srlg that represents sharable srlg for source node of IP interfaces this fb profile is protecting
        linksShareSrlg:
          type: array
          items:
            type: string
          description: List of srlg that represents sharable srlg for source and remote nodes of IP interfaces this fb profile is protecting
        srlgMode:
          $ref: '#/components/schemas/SrlgMode'
    FeaturesRO:
      title: FeaturesRO
      type: object
      properties:
        feature:
          type: string
          description: Feature name
        enabled:
          type: boolean
          description: True when the feature is enabled. otherwise false
          default: false
    FiberDetailsRO:
      title: FiberDetailsRO
      type: object
      properties:
        fiberType:
          type: string
          description: Fiber type
        launchCoefficient:
          type: string
          description: Launch coefficient
        dispersion:
          type: string
          description: Dispersion value
        effectiveArea:
          type: string
          description: Effective area
        profileType:
          type: string
          description: Fiber profile type
        pFibData:
          type: array
          items:
            $ref: '#/components/schemas/PFibDataRO'
          description: Pfib details for the fiber.
    FlexePackageRO:
      title: FlexePackageRO
      type: object
      properties:
        groupId:
          type: integer
          description: FlexE group number associated to the FlexE group
          format: int32
        groupName:
          type: string
          description: Name for FlexE group
        calendarSlotGranularity:
          type: string
          description: The granularity of calendar slot is 5G or 25G
        phyType:
          type: string
          description: Type of PHY used in the FlexE group, such as 50/100/200/400GBASE-R. All PHYs in a FlexE group should be of same type
        activeCalendar:
          type: string
          description: Calendar configuration used by the FlexE group in FlexE Mux/Demux
        calendarProtocol:
          $ref: '#/components/schemas/CalendarProtocol'
        overheadStatus:
          type: array
          items:
            type: string
          description: List of overhead status conditions in the FlexE group
        misconfigurations:
          type: array
          items:
            type: string
          description: List of misconfigurations in the FlexE group
        calendarChannelDetails:
          $ref: '#/components/schemas/CalendarChannelDetailsRO'
        totalSlots:
          type: integer
          description: Total number of slots in FlexE group
          format: int32
        allocatedSlots:
          type: integer
          description: Number of slots in use by FlexE channels associated to FlexE group
          format: int32
        availableSlots:
          type: integer
          description: Number of slots available in active calendar of FlexE group
          format: int32
        bandwidth:
          $ref: '#/components/schemas/BwRO'
    FreAttributesRO:
      title: FreAttributesRO
      type: object
      properties:
        operationState:
          $ref: '#/components/schemas/OperationState'
        deploymentState:
          $ref: '#/components/schemas/DeploymentState'
        intentLifeCycle:
          $ref: '#/components/schemas/IntentLifeCycle'
        deploymentStatusSummary:
          type: string
          description: Owned by SMO. Set through REST to to indicate status summary of the service in the service move workflow
        deploymentStatusDetails:
          type: string
          description: Owned by SMO. Set through REST to to indicate status details of the service in the service move workflow
        isNonControllerBasedServiceOnHome:
          type: boolean
          description: An indicator if the FRE is onHome.  Currently used by SMO.
          default: false
        discrepancyState:
          $ref: '#/components/schemas/DiscrepancyState'
        deploymentStateDependents:
          $ref: '#/components/schemas/DeploymentStateDependents'
        userData:
          type: object
        identifiers:
          type: array
          items:
            type: object
          description: ''
        derivedAttributes:
          $ref: '#/components/schemas/FreDerivedAttributesRO'
        serviceRate:
          type: string
          description: The service rate of the ODUFLEX FRE
        oduFlexPackage:
          $ref: '#/components/schemas/OduFlexPackageRO'
        displayData:
          $ref: '#/components/schemas/FreDisplayDataRO'
        utilizationData:
          $ref: '#/components/schemas/UtilizationDataRO'
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        note:
          $ref: '#/components/schemas/NoteRO'
        bookingData:
          $ref: '#/components/schemas/BookingDataRO'
        policies:
          $ref: '#/components/schemas/AttributePoliciesRO'
        customerName:
          type: string
          description: The name of the customer for the fre.
        serviceClass:
          $ref: '#/components/schemas/ServiceClass'
        lqsData:
          $ref: '#/components/schemas/LqsDataRO'
        restorationHealth:
          $ref: '#/components/schemas/RestorationHealthRO'
        stitchingTriggers:
          $ref: '#/components/schemas/StitchingTriggersRO'
        bandwidthTriggers:
          $ref: '#/components/schemas/BandwidthTriggersRO'
        tags:
          type: array
          items:
            type: string
          description: A set of tags for a given fre.
        linkLabel:
          type: string
          description: A Label for OTU links
        serviceLabel:
          type: string
          description: A Label for Transport Clients of format SRC_NE:PORT1,DEST_NE:PORT2
        relatedType:
          type: string
          description: The Type of Relation
        referencedByAssociations:
          type: array
          items:
            $ref: '#/components/schemas/AssociationRO'
          description: A list of associations of fres that would refer to this fre
        lastUpdatedAdminStateTimeStamp:
          type: string
          description: TimeStamp when the adminState was last changed
        lastUpdatedOperationalStateTimeStamp:
          type: string
          description: TimeStamp when the operation state was last changed
        serviceRefresh:
          $ref: '#/components/schemas/ServiceRefreshRO'
        lastSyncTimeStamp:
          type: string
          description: TimeStamp when the service was last synched
        userLabel:
          type: string
          description: The label given to the FRE by an user
        mgmtName:
          type: string
          description: The name given to the FRE on the NE where applicable (e.g. VS name for SAOS based devices)
        nativeName:
          type: string
          description: The name of the FRE that is native to the network element
        awarenessTime:
          type: string
          description: The awareness time provided by Stitcher
        originEventTime:
          type: string
          description: The origin event time provided by RA for nodal FREs
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        layerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        supportedByLayerRatePackageList:
          type: array
          items:
            $ref: '#/components/schemas/SupportedByLayerRatePackageRO'
          description: Optional package. Indicates LayerRate and LayerRateQualifier
        serviceClassQualifier:
          $ref: '#/components/schemas/ServiceClassQualifier'
        multiHighestStackLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        internalStructure:
          $ref: '#/components/schemas/InternalStructure'
        networkRole:
          $ref: '#/components/schemas/NetworkRole'
        directionality:
          $ref: '#/components/schemas/Directionality'
        topologySources:
          type: array
          items:
            $ref: '#/components/schemas/TopologySource'
          description: Source of topology
        state:
          $ref: '#/components/schemas/State6'
        adminState:
          $ref: '#/components/schemas/AdminState6'
        controlActivityState:
          $ref: '#/components/schemas/ControlActivityState'
        signalContentType:
          type: string
          description: Represents whether the FRE is of VLAN/VCE type for L2 devices
        modelType:
          $ref: '#/components/schemas/ModelType'
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        photonicSpectrumPackage:
          $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
        photonicSpectrumPackageList:
          type: array
          items:
            $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
          description: ''
        cfmPackages:
          type: array
          items:
            $ref: '#/components/schemas/FreCfmPackageRO'
          description: Holds data related to CFM services configured on an Ethernet service
        segmentId:
          type: string
          description: The segment ID associated with this FRE.
        mplsPackage:
          $ref: '#/components/schemas/MplsPackageRO'
        freType:
          $ref: '#/components/schemas/FreType'
        routingConstraints:
          $ref: '#/components/schemas/RoutingConstraintsRO'
        maxReservableBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/PlannedBandwidthRO'
          description: ''
        nonPlannedUsedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/PlannedBandwidthRO'
          description: ''
        explicitRouteGroup:
          $ref: '#/components/schemas/ExplicitRouteGroupRO'
        active:
          type: boolean
          description: An indicator to flag when a FRE is active, or simply a potential.
          default: false
        controlPlanePackage:
          $ref: '#/components/schemas/ControlPlanePackageRO'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition this fre belongs to.
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/SyncScopeRO'
          description: The sync scope for the FRE
        provisioningAttributes:
          type: object
        stitchingFloorActive:
          type: boolean
          description: An indicator to flag when a FRE should not have stitched client FREs.
          default: false
        reliability:
          $ref: '#/components/schemas/Reliability'
        isInConflict:
          type: boolean
          description: An indicator to flag when a FRE is in conflict with other FREs.
          default: false
        isStandaloneFre:
          type: boolean
          description: An indicator that no fre is stitched over PHY layer.
          default: false
        description:
          type: string
          description: String to store description field on service
        resiliencyHandlingPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyHandlingPackageRO'
          description: triggers stitcher building resiliency view and NSI updating layerRate in resiliency view
        resiliencyPackage:
          $ref: '#/components/schemas/FreResiliencyPackageRO'
        adminWt:
          type: number
          description: Administrative weight which specifies the level of importance given to the OSRP link
        bundleIds:
          type: array
          items:
            type: string
          description: List of up to 20 protection bundles to which the OSRP link belongs
        latency:
          type: number
          description: Indicates the delay in microseconds.
        domainTypes:
          type: array
          items:
            type: string
          description: List of domains/protection scheme this FRE is included in.
        resilienceLevel:
          $ref: '#/components/schemas/ResilienceLevel'
        retainedMaxReservableBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared SRLGs of this FRE.
        resiliencyTopologyPackage:
          $ref: '#/components/schemas/ResiliencyTopologyPackageRO'
        bgpPackage:
          $ref: '#/components/schemas/FreBgpPackageRO'
        gneSubnetName:
          type: string
          description: The GNE Subnet Name of the FRE
        groupPackage:
          $ref: '#/components/schemas/GroupPackageRO'
        txInfo:
          type: array
          items:
            $ref: '#/components/schemas/TxInfoRO'
          description: TxInfo for FRE
        vrfPackage:
          $ref: '#/components/schemas/FreVrfPackageRO'
        remoteOSRPNodeName:
          type: string
          description: Destination OSRP node name
        otdrPackage:
          $ref: '#/components/schemas/OtdrPackageRO'
        externalRoutePackage:
          $ref: '#/components/schemas/ExternalRoutePackageRO'
        evpn:
          $ref: '#/components/schemas/EvpnRO'
        srTePolicyPackage:
          $ref: '#/components/schemas/FreSrTePolicyPackageRO'
        vpnPackage:
          $ref: '#/components/schemas/VpnPackageRO'
        isSubmarineLink:
          type: boolean
          description: An indicator if the FRE is from submarine
          default: false
    FreBgpPackageRO:
      title: FreBgpPackageRO
      type: object
      properties:
        sessionType:
          $ref: '#/components/schemas/SessionType'
        sessionState:
          $ref: '#/components/schemas/SessionState'
        protocolVersion:
          type: string
          description: Lower of negotiatedBgpVersion reported on both BGP CTP's.
    FreCfmPackageRO:
      title: FreCfmPackageRO
      type: object
      properties:
        cfmServiceName:
          type: string
          description: The name of the CFM service
        ccmPriority:
          type: string
          description: Priority of the CC messages (0-7)
        ccmTransmitState:
          $ref: '#/components/schemas/CcmTransmitState1'
        ccmInterval:
          type: string
          description: 'The interval between transmitting each message (e.g.: 1)'
        ccmIntervalUnit:
          type: string
          description: 'The unit of interval between transmitting each message (e.g.: seconds)'
        cfmAdminState:
          $ref: '#/components/schemas/CfmAdminState'
        cfmOperState:
          $ref: '#/components/schemas/CfmOperState'
        maName:
          type: string
          description: The name of the maintenance association
        maFormat:
          type: string
          description: The format of the maintenance association name
        mdName:
          type: string
          description: The name of the maintenance domain
        mdFormat:
          type: string
          description: The format of the maintenance domain name
        mdLevel:
          type: string
          description: The level of the maintenance domain (0-7)
        megId:
          type: string
          description: The ID of the maintenance entity group
        alarmPriority:
          type: string
          description: The priority of the cfm alarm (1-5)
        alarmTime:
          type: string
          description: The cfm alarm time
        alarmTimeUnit:
          type: string
          description: The unit of cfm alarm time, default is milliseconds
        remoteMepAging:
          $ref: '#/components/schemas/RemoteMepAging'
        remoteMepAgingTime:
          type: string
          description: Cfm remote mep aging time
        remoteMepAgingTimeUnit:
          type: string
          description: The unit of cfm remote mep aging time, default is milliseconds
        dmmState:
          $ref: '#/components/schemas/DmmState'
        slmState:
          $ref: '#/components/schemas/SlmState'
    FreDataRO:
      title: FreDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the FRE resource
        type:
          $ref: '#/components/schemas/Type42'
        attributes:
          $ref: '#/components/schemas/FreAttributesRO'
        relationships:
          $ref: '#/components/schemas/FreRelationshipsRO'
    FreDerivedAttributesRO:
      title: FreDerivedAttributesRO
      type: object
      properties:
        intentLifeCyclePhase:
          $ref: '#/components/schemas/IntentLifeCyclePhase'
        intentDeploymentState:
          $ref: '#/components/schemas/IntentDeploymentState'
    FreDisplayDataRO:
      title: FreDisplayDataRO
      type: object
      properties:
        intentLifeCyclePhaseString:
          $ref: '#/components/schemas/IntentLifeCyclePhaseString'
        intentDeploymentStateString:
          $ref: '#/components/schemas/IntentDeploymentStateString'
        frequency:
          type: string
          description: The frequency value for one of the underlying Endpoints
        wavelength:
          type: string
          description: The corresponding wavelength value for the frequency attribute
        channel:
          type: string
          description: The corresponding channel number for the frequency attribute
        sncgUserlabel:
          type: string
          description: For ControlPlane SNCs only, the userlabel of the parent SNC group
        operationState:
          type: string
          description: Represents the total traffic carrying capability of the FRE. Relates to flow of traffic across the FRE between endpoints.
        adminState:
          type: string
          description: Indicates the administrative state of the FRE, including whether traffic has been enabled and whether the FRE should be used by clients. It is derived from the state(s) of terminating TPE(s). Disabled means that FRE is prevented from carrying traffic. Enabled means that FRE is allowed to carry traffic.
        displayTopologySource:
          type: string
          description: The source of the FRE
        displayPhotonicSpectrumData:
          type: array
          items:
            $ref: '#/components/schemas/FreDisplayPhotonicSpectrumDataRO'
          description: ''
        displayResiliencyControllerData:
          $ref: '#/components/schemas/FreDisplayResiliencyControllerDataRO'
        displayDeploymentState:
          $ref: '#/components/schemas/DisplayDeploymentState'
        remoteOSRPNodeName:
          type: string
          description: Destination OSRP node name
        headOSRPNodeName:
          type: string
          description: Head OSRP node name
        isDTLSetUsedAsRoutingConstraint:
          type: boolean
          description: Flags whether DTLSet FREs are reserved on the basis of whether they are referenced by an snc/sncg or not
          default: false
        displayName:
          type: string
          description: Display name of the FRE
        displayServerRefreshState:
          $ref: '#/components/schemas/DisplayServerRefreshState'
    FreDisplayPhotonicSpectrumDataRO:
      title: FreDisplayPhotonicSpectrumDataRO
      type: object
      properties:
        frequency:
          type: string
          description: The frequency value for one of the underlying Endpoints
        wavelength:
          type: string
          description: The corresponding wavelength value for the frequency attribute
        channel:
          type: string
          description: The corresponding channel number for the frequency attribute
    FreDisplayResiliencyControllerDataRO:
      title: FreDisplayResiliencyControllerDataRO
      type: object
      properties:
        recoverCharacteristics_onHome:
          $ref: '#/components/schemas/RecoverCharacteristicsOnHome'
    FreListRO:
      title: FreListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/FreDataRO'
          description: An array of FREs
        included:
          type: array
          items:
            type: object
          description: Resources related to a FRE, such as EndPointData, TpeData, FreExpectationData
    FreRO:
      title: FreRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          $ref: '#/components/schemas/FreDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to a FRE, such as FreData, EndPointData, TpeData, EquipmentData, EquipmentHolderData, FrePlannedData, FreExpectationData, FreDiscoveredData, ResiliencyControllerData, EncapsulatedResiliencyData
    FreRelationshipsRO:
      title: FreRelationshipsRO
      type: object
      properties:
        frePlanned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        freExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        freDiscovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        abstracts:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        fre:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        relatedToFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        supportedByServices:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        abstractServices:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        endPoints:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partitionFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        decomposedFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        freSwitch:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partitionFreAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        resiliencyController:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        encapsulatedResiliency:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        freSwitchList:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstructAssociation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        groups:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        configurationAndSwitchControl:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        partitioningFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        composingFre:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        decomposedFreAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concreteAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        utilization:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    FreResiliencyPackageRO:
      title: FreResiliencyPackageRO
      type: object
      properties:
        role:
          $ref: '#/components/schemas/Role12'
    FreSearchParamsRO:
      title: FreSearchParamsRO
      type: object
      properties:
        id:
          type: string
          description: Comma separated list of FRE identifiers to retrieve
        searchText:
          type: string
          description: The searchable text, (default search Fields are name, layerRate, tpeLocations if searchFields is not specified.)
        searchFields:
          type: string
          description: List of comma separated fields to search with, combined with searchText. Fields require full path (i.e. data.attributes.field)
        resourceState:
          type: string
          description: >-
            List of fre planning states. By default, if no value for this parameter is specified, root and unknown states are filtered out. The allowed values are: root, planned, discovered, plannedAndDiscovered, unknown


            Default value: planned,discovered,plannedAndDiscovered2
        layerRate:
          type: string
          description: 'FRE layer rates in comma separated list. The allowed values are: ETHERNET, OTU1, OTU2, OTU2e, OTU3, OTU4, OTUCn, OTSi, OMS, OS, PHY, OTS, FICON, FC, ODU, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU4, ODUCn, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, ENCAPSULATION, MPLS, MPLS_PROTECTION, MEDIA, LAG, RS, E1, E3, E1_2M, EC1, DSR_2M, LINE_OC3_STS3_AND_MS_STM1, SECTION_OC3_STS3_AND_RS_STM1, DSR_OC3_STM1, DSR_OC12_STM4, DSR_OC48_STM16, DSR_OC192_STM64, CES_IWF, T1, DSR_1_5M, STS1, STS3C, STS12C, STS24C, STS48C, STS192C, DS0, DS1, DS3, VT15, VT2, NOT_APPLICABLE, ODUFLEX, OTUg, ODUg, BGP, FLEXE_GROUP, IP'
        networkConstruct.id:
          type: string
          description: Comma separated Network Construct identifier
        networkConstruct.id.operator:
          type: string
          description: The logical operator to use when searching Network Construct identifiers
        tpe.id:
          type: string
          description: Comma separated TPE identifier for endpoints
        tpe.id.operator:
          type: string
          description: The logical operator to use when searching tpeIds
        identifierKey:
          type: array
          items:
            type: string
          description: List of comma separated keys for an identifer object
        identifierValue:
          type: array
          items:
            type: string
          description: List of comma separated values for an identifier object
        concrete:
          type: string
          description: List of concrete FRE identifiers
        modelType:
          type: string
          description: Parameter used to filter results
        bookingData.lockout:
          type: string
          description: Flag that enables/disables a link from having additional tunnel BW being consumed
        group:
          type: string
          description: >-
            FRE group :


            dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn

            infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS’

            packet for all L2 nodal and top level FREs in ETHERNET including infrastructure
        freType:
          type: string
          description: 'FRE types in comma separated list The allowed values are: explicitRoute, explicitRouteGroup, snc, sncGroup'
        userLabel:
          type: string
          description: User label
        managementName:
          type: string
          description: Management Name
        freExpectations.serviceIntent.id:
          type: string
          description: The service intent Id
        freExpectations.equipmentIntent.id:
          type: string
          description: The equipment intent Id
        freExpectations.intent.id:
          type: string
          description: The intent id
        freExpectations.intent.type:
          type: string
          description: The intent type
        signalContentType:
          type: string
          description: The identifier indicating type of parent to be returned. If specified, parent matching the criteria will be returned
        srlg:
          type: string
          description: Find roadmlines by srlg values separated by comma. A roadmline is a FRE between two SAM cards.
        roadmLineId:
          type: string
          description: Find services configured over a roadmline based on the roadmline FRE identifier
        endpoint.tpe.concrete:
          type: string
          description: Concrete TPE identifier for endpoints
        deploymentState:
          type: string
          description: Parameter used to filter results
        active:
          type: string
          description: The active state of the resource
        directionality:
          type: string
          description: Indicates if unidirectional or bidirectional FREs should be returned
        networkRole:
          type: string
          description: Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
        type:
          type: string
          description: 'FRE types in comma separated list. The allowed values are: service, link, roadmline-ap, roadmline'
        serviceClass:
          type: string
          description: 'Allow filtering on the FRE service class. This parameter accepts a list of comma separated values. The allowed values are: EVC, ETransit, EAccess, VLAN, TDM, Transport Client, Photonic, Tunnel, IP, LLDP, LAG, OTU, ROADM Line, Fiber, SNC , OSRP Link, OSRP Line, SNCP, ICL, Ring, FlexeLink, FlexeGroup, L3VPN'
        layerRateQualifier:
          type: string
          description: Indicates additional qualification information for a LayerRate. For example, for beyond 100G rates (e.g. OTUCn, ODUCn), defines the n multiplier, or the n-M subrate value.
        serviceRate:
          type: string
          description: The service rate of the ODUFLEX FRE
        supportedByFreId:
          type: string
          description: Retrieves all supported parent FREs (default is one serviceClass/layer level up) that have a serviceClass designation for the specified FRE Id
        supportedByQualifier:
          type: string
          description: Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
        supportingFreId:
          type: string
          description: Retrieves all supporting child FREs (one serviceClass/layer level down) that have a serviceClass designation for the specified FRE Id
        customerName:
          type: string
          description: Search for an exact match on customerName
        sncgUserlabel:
          type: string
          description: 'For Control Plane SNCs only: Retrieves all SNCs provided the parent SNCG userLabel'
        tunnelType:
          type: string
          description: 'Allow filtering on FRE Tunnel class service. This parameter accepts a list of comma separated values: dynamic, static'
        ringType:
          type: string
          description: 'Allow filtering on type of G8032 ring. This parameter accepts a list of comma separated values: majorRing, subRing'
        ringStatus:
          type: string
          description: 'Allow filtering on Status of G8032 ring. This parameter accepts a list of comma separated values: OK, Local signal failure, Local force switch, Remote signal failure, Remote force switch, Provisioning mismatch, Not receiving PDUs, No RPL owner detected, Unknown'
        ringState:
          type: string
          description: 'Allow filtering on State of G8032 ring. This parameter accepts a list of comma separated values: Initializing, OK, Admin disabled, Operational disabled, Protecting, Recovering, Manual switch, Force switch, Unknown'
        ringCompleteness:
          type: string
          description: 'Allow filtering on type of G8032 ring completeness. This parameter accepts a list of comma separated values: partial, complete'
        adminState:
          type: string
          description: 'Allow filtering on FRE adminState. This parameter accepts a list of comma separated values: enabled, disabled, not applicable, In Service, Out of Service'
        operationState:
          type: string
          description: 'Allow filtering on FRE operationState. This parameter accepts a list of comma separated values: fully operating, not operating, degraded operation, Not Applicable, Undetermined, In Service, Degraded, Out of Service External, Out of Service'
        lqsData.status:
          type: string
          description: Allow filtering on the LQS status. This parameter accepts a list of comma separated values
        lqsData.margin.valid:
          type: string
          description: The LQS margin validity state
        lqsData.fiber.reconciled:
          type: string
          description: The LQS fiber reconciled state
        lqsData.fiber.method:
          type: string
          description: Allow filtering on the LQS fiber method. This parameter accepts a list of comma separated values
        lqsData.fiber.deltaAvgToPlannedLoss:
          type: string
          description: The LQS fiber delta average to planned loss
        lqsData.fiber.avgLoss:
          type: string
          description: The LQS fiber average loss
        lqsData.fiber.lastCalculationTime:
          type: string
          description: The LQS fiber last loss calculation time
        lqsData.fiber.avgLossStatus:
          type: string
          description: The LQS fiber average loss status
        lqsData.fiber.plannedLoss:
          type: string
          description: The LQS fiber planned loss
        lqsData.fiber.plannedLossMargin:
          type: string
          description: The LQS fiber planned loss margin
        lqsData.fiber.currentLoss:
          type: string
          description: The LQS fiber current loss
        lqsData.fiber.currentLossTime:
          type: string
          description: The LQS fiber current loss time
        lqsData.fiber.currentLossMethod:
          type: string
          description: The LQS fiber current loss method
        lqsData.margin.viableAtEol:
          type: string
          description: A list of LQS margin viable at EOL states
        lqsData.ppg.snrStatus:
          type: string
          description: A list of LQS PPG snr states
        lqsData.ppg.categorySnrReference:
          type: string
          description: A list of LQS PPG category snr reference values
        lqsData.ppg.deltaSnrReference:
          type: string
          description: A list of LQS PPG delta snr reference values
        lqsData.ppg.startDeltaSnrReference:
          type: string
          description: Allow filtering on FRE lqsData ppg startDeltaSnrReference
        lqsData.ppg.endDeltaSnrReference:
          type: string
          description: Allow filtering on FRE lqsData ppg endDeltaSnrReference
        restorationHealth.totalExplicitRoutes:
          type: string
          description: Allow filtering on FRE restorationHealth totalExplicitRoutes
        restorationHealth.availableExplicitRoutes:
          type: string
          description: Allow filtering on FRE restorationHealth availableExplicitRoutes
        restorationHealth.unavailableExplicitRoutes:
          type: string
          description: Allow filtering on FRE restorationHealth unavailableExplicitRoutes
        restorationHealth.availablePercentage:
          type: string
          description: Allow filtering on FRE restorationHealth availablePercentage
        restorationHealth.unavailablePercentage:
          type: string
          description: Allow filtering on FRE restorationHealth unavailablePercentage
        restorationHealth.homeAvailable:
          type: boolean
          description: Allow filtering on FRE restorationHealth homeAvailable
          default: false
        restorationHealth.startAvailablePercentage:
          type: string
          description: Allow filtering on FRE restorationHealth startAvailablePercentage
        restorationHealth.endAvailablePercentage:
          type: string
          description: Allow filtering on FRE restorationHealth endAvailablePercentage
        utilizationData.totalCapacity:
          type: string
          description: Allow filtering on FRE utilizationData totalCapacity
        utilizationData.usedCapacity:
          type: string
          description: Allow filtering on FRE utilizationData usedCapacity
        utilizationData.utilizationPercent:
          type: string
          description: Allow filtering on FRE utilizationData utilizationPercent
        utilizationData.startUtilizationPercent:
          type: string
          description: Allow filtering on FRE utilizationData startUtilizationPercent
        utilizationData.endUtilizationPercent:
          type: string
          description: Allow filtering on FRE utilizationData endUtilizationPercent
        utilizationData.capacityUnits:
          type: string
          description: Allow filtering on FRE utilizationData capacityUnits
        coroutedFreId:
          type: string
          description: Retrieves all correlated FREs that are co-routed and co-terminated with the specified FRE Id
        tags:
          type: string
          description: Allow filtering on FRE tags. This parameter accepts a list of comma separated strings
        displayAdminState:
          type: string
          description: Allow filtering on FRE adminState display string
        displayOperationState:
          type: string
          description: Allow filtering on FRE operationState display string
        displayTopologySource:
          type: string
          description: Allow filtering on FRE topologySource display string
        displayRecoveryCharacteristicsOnHome:
          type: string
          description: Allow filtering on FRE resiliency controller recovery characteristics onHome display string
        startDateMin:
          type: string
          description: 'Minimum value of startDate, format is: yyyy-MM-dd’T’HH:mm:ss.SSSZ'
        startDateMax:
          type: string
          description: 'Maximum value of startDate, format is: yyyy-MM-dd’T’HH:mm:ss.SSSZ'
        endDateMin:
          type: string
          description: 'Minimum value of endDate, format is: yyyy-MM-dd’T’HH:mm:ss.SSSZ'
        endDateMax:
          type: string
          description: 'Maximum value of endDate, format is: yyyy-MM-dd’T’HH:mm:ss.SSSZ'
        namedQuery:
          type: string
          description: >-
            Comma-separated named query id list; The allowed values are: resiliency, tdmServices, topologicalLinks, roadmLineSpan, reusableSNCG, tunnelReplacement, layer1OtuLinks, photonicSncpWorkLegs, relatedFresFull, relatedFresLight, ringsWithoutConstraints


            tunnelReplacement cannot be used in combination with other named queries


            photonicSncpWorkLegs can not be used alone, networkConstruct.Id must be provided with this named query


            relatedFresFull can not be used alone, namedQueryParam1 must be provided with this named query.


            relatedFresLight can not be used alone, namedQueryParam1 must be provided with this named query.
        domainTypes:
          type: string
          description: Allow filtering on FRE domainTypes. This parameter accepts a list of comma separated values
        resilienceLevel:
          type: string
          description: 'Allow filtering on FRE domainTypes. This parameter accepts a list of comma separated values: unprotected, partial, protected'
        partitionFreIds:
          type: string
          description: Retrieves all parent FREs that have the specified FRE as a partition relation
        decomposedFreIds:
          type: string
          description: Retrieves all parent FREs that have the specified FRE as a decomposed relation
        facilityBypass:
          type: string
          description: Allow filtering of FRE’s with facilityBypass tunnels
        childFreId:
          type: string
          description: The child FRE identifier to return its parents
        gneSubnetName:
          type: string
          description: GNE Subnet name of the FRE
        routingConstraints.inclusionConstraints.id:
          type: string
          description: Retrieves all FREs that have an inclusion constraint relationship to the specified identifier
        displayDeploymentState:
          type: string
          description: Allow filtering on FRE deploymentState display string
        ncTags:
          type: string
          description: List of comma-separated network construct tags that is an endpoint for an FRE
        namedQueryParam1:
          type: string
          description: Mandatory when namedQuery relatedFresFull/relatedFresLight is used. This parameter accepts a list of comma separated freIds
        remoteOSRPNodeName:
          type: string
        headOSRPNodeName:
          type: string
        isUsedByService:
          type: boolean
          default: false
        isDTLSetUsedAsRoutingConstraint:
          type: boolean
          default: false
        isOtdrCapable:
          type: boolean
          default: false
        sourceTraceType:
          type: string
        sourceTraceTimestamp:
          type: string
        destinationTraceType:
          type: string
        destinationTraceTimestamp:
          type: string
        sourceOtdrcfgaId:
          type: string
        sourceNcId:
          type: string
        destinationOtdrcfgaId:
          type: string
        destinationNcId:
          type: string
        isSubmarineLink:
          type: boolean
          default: false
        displayName:
          type: string
          description: The FRE displayName
        partitioningFreIds:
          type: string
          description: Retrieves all child FREs that have the specified FRE as a partitioning relation
        internalStructure:
          type: string
          description: Allow filtering on the FRE Internal Structure class. This parameter accepts a list of comma separated values.
        exportRouteTargets:
          type: array
          items:
            type: string
          description: Set of export Route Target(s) associated with VRF(s)
        importRouteTargets:
          type: array
          items:
            type: string
          description: Set of import Route Target(s) associated with VRF(s)
        filterType:
          type: string
          description: FilterType for distinguish search based on Export Route Target or Import Route Target. If filterType = both, then search on basis of export Route Target or import Route Target. If not filled, search work as same as before.
        nativeName:
          type: string
          description: The name of the FRE that is native to the network element
        signalingType:
          type: string
          description: Value of the Fre signaling type associated with FRE(s)
        sourceEndPoint:
          type: string
          description: Value of the Fre source end point associated with FRE(s)
        destEndPoint:
          type: string
          description: Value of the Fre destination end point associated with FRE(s)
        bindingAllocatedSid:
          type: string
          description: Value of the Fre sr Te Binding Sid associated with FRE(s)
        transportPolicy:
          type: string
          description: Value of the Fre transportPolicy type associated with FRE(s)
        catalog:
          type: string
          description: Value of the Fre catalog associated with FRE(s)
        srColor:
          type: string
          description: Value of the Fre Sr color associated with FRE(s)
        fallback:
          type: string
          description: Value of the Fre fallback associated with FRE(s)
        cfmAdminState:
          type: string
          description: Value of the CfmAdminState
        fields:
          type: string
          description: List of comma separated fields to be included in the response. Fields require full path (i.e. data.attributes.field)
        sortBy:
          type: string
          description: List of comma separated fields by which to sort the result. Fields require full path (i.e. data.attributes.field). A dash or negative sign before a field indicates descending order; by default ascending order is used
        offset:
          type: string
          description: Offset for the second page
        limit:
          type: string
          description: The size of a returned page
        metaDataFields:
          type: string
          description: 'MetaData to be included. The allowed values are: layerRate, layerRateQualifier, signalContentType, intentLifeCyclePhaseString, intentDeploymentStateString, serviceClass, sncgUserlabel, adminState, operationState, lqsData.status, lqsData.margin.valid, lqsData.fiber.reconciled, lqsData.fiber.method, lqsData.margin.viableAtEol, displayAdminState, displayOperationState, displayTopologySource, customerName, domainTypes, resilienceLevel, directionality, displayDeploymentState, ringType, ringCompleteness, displayRecoveryCharacteristicsOnHome, relatedServices'
        metaDataQualifiers:
          type: string
          description: 'List of meta data options. The allowed values are: absoluteTotals'
        include:
          type: string
          description: 'List of comma separated resources to be side-loaded. The allowed values are: tpes, expectations, networkConstructs, planned, freDiscovered, frePlanned, supportedByFreResiliencyClientTpes'
        ovpnIds:
          type: string
          description: List of comma separated values for ovpn Id
        serviceClassMismatch:
          type: string
          description: 'Allow filtering on the FRE  where the discovered service class and derived service class matches or not : true or false'
        peerSNCIdentifier:
          type: string
          description: The identier of the Peer SNC that is peer of a FRE
        relatedServices:
          type: string
          description: 'Optional when namedQuery relatedFresFull. The allowed values are: Sncp, Link diverse, Bundle diverse, Absolute diverse'
        dailyThroughput.averageUtilization:
          type: string
          description: Allow filtering on daily FRE throughput average utilization
        dailyThroughput.startAverageUtilization:
          type: string
          description: Allow filtering on daily FRE throughput start average utilization
        dailyThroughput.endAverageUtilization:
          type: string
          description: Allow filtering on daily FRE throughput end average utilization
        dailyThroughput.maxUtilization:
          type: string
          description: Allow filtering on daily FRE throughput max utilization
        dailyThroughput.startMaxUtilization:
          type: string
          description: Allow filtering on daily FRE throughput start max utilization
        dailyThroughput.endMaxUtilization:
          type: string
          description: Allow filtering on daily FRE throughput end max utilization
        dailyThroughput.ninetyFifthUtilization:
          type: string
          description: Allow filtering on daily FRE throughput 95th percentile utilization
        dailyThroughput.startNinetyFifthUtilization:
          type: string
          description: Allow filtering on daily FRE throughput start 95th percentile utilization
        dailyThroughput.endNinetyFifthUtilization:
          type: string
          description: Allow filtering on daily FRE throughput end 95th percentile utilization
        weeklyThroughput.averageUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput average utilization
        weeklyThroughput.startAverageUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput start average utilization
        weeklyThroughput.endAverageUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput end average utilization
        weeklyThroughput.maxUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput max utilization
        weeklyThroughput.startMaxUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput start max utilization
        weeklyThroughput.endMaxUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput end max utilization
        weeklyThroughput.ninetyFifthUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput 95th percentile utilization
        weeklyThroughput.startNinetyFifthUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput start 95th percentile utilization
        weeklyThroughput.endNinetyFifthUtilization:
          type: string
          description: Allow filtering on weekly FRE throughput end 95th percentile utilization
        completeness:
          type: string
          description: 'Allow filtering on type of G8032 ring and FlexE completeness. This parameter accepts a list of comma separated values: partial, complete'
        misconfigured:
          type: string
          description: 'Allow filtering on type of FlexE Misconfigurations. This parameter accepts a list of comma separated values: true, false'
        destinationPrefix:
          type: string
          description: Allow filtering on destinationPrefix
        selectedRoute:
          type: string
          description: Allow filtering on selectedRoute
        vrfName:
          type: string
          description: Allow filtering on Vrf Name
        nextHopIp:
          type: string
          description: Allow filtering on NextHop Ip.
        vrfId:
          type: string
          description: Allow filtering on vrfId.
        statsCollectionOperational:
          type: string
          description: 'Allow filtering on value of IPDATA statsCollectionOperational. This parameter accepts a list of comma separated values: on, off, partial'
        dmmState:
          type: string
          description: 'Allow filtering on value of IPDATA dmmState. This parameter accepts a list of comma separated values: enabled, disabled, partial'
        slmState:
          type: string
          description: 'Allow filtering on value of IPDATA slmState. This parameter accepts a list of comma separated values: enabled, disabled, partial'
        color:
          type: string
          description: Allow filtering on Color
        displayServerRefreshState:
          type: string
          description: Allow filtering on the display server refresh state
        serviceRefresh.state:
          type: string
          description: Allow filtering on the server refresh state
        serviceRefresh.status:
          type: string
          description: Allow filtering on the display server refresh status
    FreSrTePolicyPackageRO:
      title: FreSrTePolicyPackageRO
      type: object
      properties:
        name:
          type: string
          description: SR policy name
        sourceEndPoint:
          type: string
          description: Source IP address for the tunnel
        destEndPoint:
          type: string
          description: Policy end point IP address
        color:
          type: integer
          description: Color associated with the policy
          format: int32
        reversionHoldTimer:
          type: integer
          description: Reversion hold timer for SR policy
          format: int32
        outLabels:
          type: string
          description: Policy out labels
        outInterfaceName:
          type: string
          description: Outgoing Interface name
        operationState:
          $ref: '#/components/schemas/OperationState1'
        bindingSidAllocationMode:
          $ref: '#/components/schemas/BindingSidAllocationMode'
        adminState:
          $ref: '#/components/schemas/AdminState7'
        signalingType:
          $ref: '#/components/schemas/SignalingType'
        reversionState:
          $ref: '#/components/schemas/ReversionState'
        createTime:
          type: string
          description: Creation time of the policy
        upTime:
          type: string
          description: Policy up time
        bindingSid:
          $ref: '#/components/schemas/SrTeBindingSidRO'
        candidatePaths:
          type: array
          items:
            $ref: '#/components/schemas/SrTeCandidatePathsDataRO'
          description: SR policy candidate path(s)
        description:
          type: string
          description: Description of the policy
        userConstraints:
          $ref: '#/components/schemas/UserConstraintsRO'
    FreVrfPackageRO:
      title: FreVrfPackageRO
      type: object
      properties:
        id:
          type: integer
          description: ID of EVPN instance
          format: int32
        routeDistinguisher:
          type: string
          description: RouteDistinguisher associated with a VRF
        exportRouteTargets:
          type: array
          items:
            type: string
          description: Set of export Route Target(s) associated with VRF(s)
        importRouteTargets:
          type: array
          items:
            type: string
          description: Set of import Route Target(s) associated with VRF(s)
        description:
          type: string
          description: String to store description field on a VRF
        staticRouteIDs:
          type: array
          items:
            type: string
          description: list of static route IDs associated with VRF(s)
        transportPolicy:
          $ref: '#/components/schemas/TransportPolicyRO'
    FrrPropertiesRO:
      title: FrrPropertiesRO
      type: object
      properties:
        levelType:
          type: string
          description: Level of an IS-IS node - can be level-1, level-2 or level-1-2
        tiLfaEnabled:
          type: boolean
          description: TI-LFA enabled or not.
          default: false
    FrrRO:
      title: FrrRO
      type: object
      properties:
        holdTimer:
          type: integer
          description: Contains hold timer.
          format: int32
        frrProperties:
          type: array
          items:
            $ref: '#/components/schemas/FrrPropertiesRO'
          description: contains data based on ISIS instance levels
    G8032PackageRO:
      title: G8032PackageRO
      type: object
      properties:
        ringId:
          type: string
          description: The logical ring ID
        logicalRingName:
          type: string
          description: The logical ring name
        virtualRingName:
          type: string
          description: the virtual ring name
        rapsVid:
          type: string
          description: the R-APS VID of the ring
        rplOwner:
          type: boolean
          description: True if the port is configured as RPL-owner.
          default: false
        operationalChannelBlock:
          type: boolean
          description: True if the port is blocked, i.e portState == Blocked
          default: false
        ringType:
          $ref: '#/components/schemas/RingType'
        sharedPort:
          type: string
          description: sharedPort information for the sub-ring (ONLY for sub-ring endNode)
        sharedPortRef:
          type: string
          description: the ID of the PTP on the shared port
        vlanGroupId:
          type: integer
          description: the ID used for L2Motr devices in parallel to sharedPort in SAOS devices
          format: int32
        forceSwitch:
          type: boolean
          description: a flag indicating whether the switching is forced or not.
          default: false
        subRingTermination:
          type: boolean
          description: flag indicating whether the subring is terminating or not
          default: false
        portDirection:
          $ref: '#/components/schemas/PortDirection'
        revertive:
          type: boolean
          description: revertive
          default: false
        holdOffTime:
          type: integer
          description: hold off time in milliseconds
          format: int32
        holdOffTimeUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        waitToRestore:
          type: integer
          description: wait to restore time in minute.
          format: int32
        waitToRestoreUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        waitToBlock:
          type: integer
          description: wait to block time in milliseconds.
          format: int32
        waitToBlockUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        guardTime:
          type: integer
          description: guard time in millisecond.
          format: int32
        guardTimeUnit:
          $ref: '#/components/schemas/GuardTimeUnit'
        ringMembers:
          type: string
          description: a comma separated list of virtual ring members.
        ringState:
          $ref: '#/components/schemas/RingState'
        ringStatus:
          $ref: '#/components/schemas/RingStatus'
        portState:
          $ref: '#/components/schemas/PortState'
        portStatus:
          $ref: '#/components/schemas/PortStatus'
    GatewayRO:
      title: GatewayRO
      type: object
      properties:
        overRide:
          type: boolean
          description: Override the default definition of the gateway
          default: false
        access:
          type: string
          description: 'Defines the type of Gateway ie. 6500 V4 values are: ARP, NAT, OSPF, STATIC, PRIVATEIP'
        config:
          type: string
          description: Configuration of Gateway as standalone or redundant.
    GatewayRO_1:
      title: GatewayRO_1
      type: object
      properties:
        overRide:
          type: boolean
          description: Override the default definition of the gateway
          default: false
        access:
          type: string
          description: Defines the type of Gateway ie. 6500 V6 values are:NDPROXY, OSPFV3, STATIC
        config:
          type: string
          description: Configuration of Gateway as standalone or redundant.
    GeneralRO:
      title: GeneralRO
      type: object
      properties:
        useAnycastSIDsForABRResiliency:
          type: boolean
          description: Use Anycast-SIDs for ABR Resiliency
          default: false
        useBindingSIDForCoreAreaTunnelsOrPolicies:
          type: boolean
          description: Use Binding SID for Core Area Tunnels/Policies
          default: false
        bsidTunnelColor:
          type: integer
          description: Binding Tunnel/Policy Color
          format: int32
    GeoLocationRO:
      title: GeoLocationRO
      type: object
      properties:
        zone:
          type: string
        longitude:
          type: string
        latitude:
          type: string
    GroupPackageRO:
      title: GroupPackageRO
      type: object
      properties:
        groupId:
          type: string
          description: UUID of the group it will be set once Group is created by NSI
        aid:
          type: string
          description: AID of the participating sncs something like aidSnc1:aidSnc2
        groupToBeCreated:
          type: boolean
          description: flag to indicate that Group needs to be created
          default: false
    HopEntryRO:
      title: HopEntryRO
      type: object
      properties:
        hopAddress:
          type: string
          description: The IP-data interface address for this hop
        hopType:
          $ref: '#/components/schemas/HopType'
    IPCommunicationDetailsRO:
      title: IPCommunicationDetailsRO
      type: object
      properties:
        ipv4Infrastructure:
          $ref: '#/components/schemas/Ipv4InfrastructureRO'
        ipv6Infrastructure:
          $ref: '#/components/schemas/Ipv6InfrastructureRO'
        iisisInfrastructure:
          $ref: '#/components/schemas/IisisInfrastructureRO'
        sldd:
          $ref: '#/components/schemas/SlddRO'
        interfaceDetails:
          type: array
          items:
            $ref: '#/components/schemas/InterfaceIPAttributesRO'
          description: List of comms interfaces and their attributes.
    ISISDataRO:
      title: ISISDataRO
      type: object
      properties:
        instanceName:
          type: string
          description: ISIS instance name.
        routerId:
          type: string
          description: ISIS instance router Id.
        loopbackInterfaceName:
          type: string
          description: ISIS instance loopback interface name.
        netAddress:
          $ref: '#/components/schemas/NetAddressRO'
        isis_sr:
          $ref: '#/components/schemas/IsIsSegmentRoutingRO'
    IisisInfrastructureRO:
      title: IisisInfrastructureRO
      type: object
      properties:
        l1priority:
          type: integer
          description: 1-127, 64 is default
          format: int32
        l2priority:
          type: integer
          description: 1-127, 64 is default
          format: int32
        routerLevel:
          type: string
          description: Level 1 or Level 2 router, default is Level 1
        routerlevelsummarisition:
          type: string
          description: Whether routes or route summaries are redistributed
    IisisRO:
      title: IisisRO
      type: object
      properties:
        circuit:
          type: boolean
          description: IISIS circuit exists on the interface
          default: false
        attributes:
          $ref: '#/components/schemas/AttributesRO'
    InterfaceIPAttributesRO:
      title: InterfaceIPAttributesRO
      type: object
      properties:
        name:
          type: string
          description: The name of the interface the IP communications details are associated with
        topology:
          $ref: '#/components/schemas/TopologyRO'
        ipv4:
          $ref: '#/components/schemas/Ipv4RO'
        ipv6:
          type: array
          items:
            $ref: '#/components/schemas/Ipv6RO'
          description: List IPV6 Addresses for an interface.
        iisis:
          $ref: '#/components/schemas/IisisRO'
    IpInterfacePackageRO:
      title: IpInterfacePackageRO
      type: object
      properties:
        bfd:
          $ref: '#/components/schemas/BfdRO'
        isis:
          $ref: '#/components/schemas/IsIsRO'
    Ipv4InfrastructureRO:
      title: Ipv4InfrastructureRO
      type: object
      properties:
        dhcpRelayAgent:
          $ref: '#/components/schemas/DhcpRelayAgentRO'
        dhcpclient:
          type: boolean
          description: Indicates if the DHCP client is enabled
          default: false
        stackEnabled:
          type: boolean
          description: Indicates if IPV4 is enabled
          default: false
        gateway:
          $ref: '#/components/schemas/GatewayRO'
        arpRemotes:
          type: array
          items:
            $ref: '#/components/schemas/ArpRemoteRO'
          description: Defines the list of shelves/network elements this shelf should ARP for.
        ospfRouter:
          $ref: '#/components/schemas/OspfRouterRO'
    Ipv4RO:
      title: Ipv4RO
      type: object
      properties:
        ip:
          type: string
          description: Value of IP address, can be either a V4
        defaultGateway:
          type: string
          description: The next hope router IP, can be a V4 address
        prefix:
          type: string
          description: The prefix which is applied on the interface, an IPV4 prefix
        subnetMask:
          type: string
          description: The mask which is applied on the interface, an IPV4 mask
        proxyArp:
          type: string
          description: Turns proxy ARP on or off for port. Default is OFF
        dhcpRelayAgent:
          type: boolean
          description: Defines if the interface is a V4 DHCP relay agent, must be off for unnumbered interfaces
          default: false
        ospfcircuit:
          type: array
          items:
            $ref: '#/components/schemas/OspfcircuitRO'
          description: ''
    Ipv6InfrastructureRO:
      title: Ipv6InfrastructureRO
      type: object
      properties:
        dhcpRelayAgent:
          $ref: '#/components/schemas/DhcpRelayAgentRO_1'
        dhcpclient:
          type: boolean
          description: Indicates if the DHCP client is enabled
          default: false
        stackEnabled:
          type: boolean
          description: Indicates if IPV4 is enabled
          default: false
        gateway:
          $ref: '#/components/schemas/GatewayRO_1'
        ospfRouter:
          $ref: '#/components/schemas/OspfRouterRO_1'
    Ipv6RO:
      title: Ipv6RO
      type: object
      properties:
        ip:
          type: string
          description: Value of IP address, can be either a V6 address, should support all formats of V6 address
        defaultGateway:
          type: string
          description: The next hope router IP, can be a V6 address, should support all formats of V6 address
        prefix:
          type: string
          description: The prefix which is applied on the interface, an IPV6 prefix
        ospfcircuit:
          type: array
          items:
            $ref: '#/components/schemas/OspfcircuitRO_1'
          description: ''
    IsIsLevelDataRO:
      title: IsIsLevelDataRO
      type: object
      properties:
        levelType:
          type: string
          description: Level of an IS-IS node - can be level-1, level-2 or level-1-2
        helloInterval:
          type: integer
          description: Interval between hello messages, unit:seconds
          format: int32
        helloMultiplier:
          type: integer
          description: Number of missed hello messages prior to adjacency down grouping, unit:seconds
          format: int32
        csnpInterval:
          type: integer
          description: Interval between CSNP messages, unit:seconds
          format: int32
        priority:
          type: integer
          description: priority for DIS election
          format: int32
        metric:
          type: integer
          description: Metric associated with the links having range 1-63, i.e. default-10, delay, expense etc.
          format: int32
        wideMetric:
          type: integer
          description: wide-metric configuration
          format: int32
        lfaCandidateEnable:
          type: boolean
          description: Enable/disable the interface from being used as LFA for level-1, level-2 or level-1-2 primary route
          default: false
        tiLfaEnable:
          type: boolean
          description: Enable/DIsable TI-LFA on the interface Same for LFA
          default: false
    IsIsRO:
      title: IsIsRO
      type: object
      properties:
        instanceTag:
          type: string
          description: Protocol instance Tag
        levelType:
          $ref: '#/components/schemas/LevelType'
        levels:
          type: array
          items:
            $ref: '#/components/schemas/IsIsLevelDataRO'
          description: Contains IsIs Level attribute details
        interfaceType:
          type: string
          description: point-to-point or point-to-multipoint network
        lspInterval:
          type: integer
          description: Interval between LSP transmissions, unit:milliseconds
          format: int64
        lspRetransmitInterval:
          type: integer
          description: Interval between LSP retransmissions, unit:seconds
          format: int32
        helloPadding:
          type: boolean
          description: ISIS hello padding activation
          default: false
        ipv4UnicastDefaultDisable:
          type: boolean
          description: disable default config for IPv4 AF on interface
          default: false
        ldpIgpSyncLevelType:
          $ref: '#/components/schemas/LdpIgpSyncLevelType'
        ldpIgpSyncHoldDown:
          type: string
          description: 'hold down timer for the ISIS LDP/IGP synchronization configuration, unit : seconds'
        isisEnabled:
          type: boolean
          description: enable MPLS isis routing
          default: false
        srEnabled:
          type: boolean
          description: enable MPLS segment routing
          default: false
        bfdEnabled:
          type: boolean
          description: Bidirectional forwarding detection for ISIS
          default: false
        metricStyle:
          $ref: '#/components/schemas/MetricStyle'
    IsIsSegmentRoutingRO:
      title: IsIsSegmentRoutingRO
      type: object
      properties:
        srEnabled:
          type: boolean
          description: True when segment routing is enabled for isis instance.
          default: false
        srgbRange:
          $ref: '#/components/schemas/LabelRangeRO'
        prefixSidMap:
          type: array
          items:
            $ref: '#/components/schemas/PrefixSidMapRO'
          description: Holds ISIS prefix mapping configuration data.
        frr:
          $ref: '#/components/schemas/FrrRO'
    ItsPackageRO:
      title: ItsPackageRO
      type: object
      properties:
        itsMode:
          type: string
          description: Specify supported ITS mode
    L0DataRO:
      title: L0DataRO
      type: object
      properties:
        isFlexCapable:
          type: boolean
          description: isFlexCapable value
          default: false
        isEDTLCapable:
          type: boolean
          description: isEDTLCapable value
          default: false
        isEgressRegenPortCapable:
          type: boolean
          description: isEgressRegenPortCapable value
          default: false
        fiberTypes:
          type: array
          items:
            $ref: '#/components/schemas/FiberDetailsRO'
          description: Fiber types supported on this NetworkConstructs.
        features:
          type: array
          items:
            $ref: '#/components/schemas/FeaturesRO'
          description: Features settings on this NetworkConstructs.
    L2DataRO:
      title: L2DataRO
      type: object
      properties:
        shelf:
          type: string
        slot:
          type: string
        eqptGrp:
          type: string
          description: The group ID obtained from RTRV-EQPTGRP for the SAOS card on which the entity resides
        switchFabricType:
          $ref: '#/components/schemas/SwitchFabricType'
        loopbackAddresses:
          type: array
          items:
            type: string
          description: The loopback addresses in the NE.
        staticTunnelLabelRange:
          $ref: '#/components/schemas/RangeRO'
        dynamicLabelRange:
          $ref: '#/components/schemas/RangeRO'
        staticVcLabelRange:
          $ref: '#/components/schemas/RangeRO'
        mgmtVlans:
          type: array
          items:
            type: string
          description: mgmtVlans in the NE.
        benchmarkMacs:
          type: array
          items:
            type: string
          description: Benchmark MAC addresses in the NE.
        cosProfileNames:
          type: array
          items:
            type: string
          description: CoS profiles in the NE.
        cftProfileNames:
          type: array
          items:
            type: string
          description: CFT profiles in the NE.
        bgpPackage:
          $ref: '#/components/schemas/BgpPackageRO'
        l2NodeRole:
          $ref: '#/components/schemas/L2NodeRole'
        l2NodeRoutingCapabilities:
          $ref: '#/components/schemas/L2NodeRoutingCapabilitiesRO'
        fgiSpecsRefList:
          type: array
          items:
            type: string
          description: A list of Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.
        externalFgiSpecsRefList:
          type: array
          items:
            type: string
          description: A list of External Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.
        tunnelFgiSpecsRefList:
          type: array
          items:
            type: string
          description: A list of Tunnel Forwarding Group assignments.
        trafficProfileMode:
          $ref: '#/components/schemas/TrafficProfileMode'
    L2MotrBandwidthProfilesDataRO:
      title: L2MotrBandwidthProfilesDataRO
      type: object
      properties:
        bwprfIndex:
          type: string
          description: The bandwidth profile index; indicates the index of bandwidth profile
        bwprfName:
          type: string
          description: The bandwidth profile name; indicates the name of bandwidth profile
        bwprfPolicer:
          type: string
          description: The bandwidth profile policer; indicates the policer of bandwidth profile
    L2NodeRoutingCapabilitiesRO:
      title: L2NodeRoutingCapabilitiesRO
      type: object
      properties:
        isBGPEnabled:
          type: boolean
          description: true, if BGP protocol is enabled on this L2 node.
          default: false
        isMPLSEnabled:
          type: boolean
          description: true, if MPLS protocol is enabled on this L2 node.
          default: false
        isQiQEnabled:
          type: boolean
          description: true , if QiQ protocol is enabled on this L2 node.
          default: false
        isRSVPTEEnabled:
          type: boolean
          description: true , if RSVP-TE protocol is enabled on this L2 node.
          default: false
    L2TransformRO:
      title: L2TransformRO
      type: object
      properties:
        name:
          type: string
          description: Need a key for this list. It cannot be a choice of several objects but objects that will always be specified.
        operation:
          type: array
          items:
            $ref: '#/components/schemas/OperationRO'
          description: List of operations
    LabelRangeRO:
      title: LabelRangeRO
      type: object
      properties:
        range:
          $ref: '#/components/schemas/RangeRO'
        scope:
          $ref: '#/components/schemas/Scope'
    LayerProtocolRO:
      title: LayerProtocolRO
      type: object
      properties:
        termination:
          $ref: '#/components/schemas/TerminationRO'
        adaptationPools:
          type: array
          items:
            $ref: '#/components/schemas/AdaptationPoolRO'
          description: ''
        layeredAttributes:
          type: array
          items:
            $ref: '#/components/schemas/LayeredAttributeRO'
          description: ''
        accessPoint:
          $ref: '#/components/schemas/AccessPointRO'
        connectionPoint:
          $ref: '#/components/schemas/ConnectionPointRO'
        tandemConnectionMonitoring:
          type: array
          items:
            $ref: '#/components/schemas/TandemConnectionMonitoringRO'
          description: ''
    LayerTerminationRO:
      title: LayerTerminationRO
      type: object
      properties:
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        nativeLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        dynamicLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        layerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        structureType:
          $ref: '#/components/schemas/StructureType'
        terminationState:
          $ref: '#/components/schemas/TerminationState'
        adminState:
          $ref: '#/components/schemas/AdminState2'
        operationalState:
          $ref: '#/components/schemas/OperationalState2'
        active:
          type: boolean
          description: Whether or not an inactive layer appears to be absent from the layer stack.
          default: false
        adjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackageRO'
        retainedAdjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackageRO'
        manualAdjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackageRO'
        powerPackage:
          $ref: '#/components/schemas/PowerPackageRO'
        photonicSpectrumPackage:
          $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
        cfmPackages:
          type: array
          items:
            $ref: '#/components/schemas/TpeCfmPackageRO'
          description: Holds data related to CFM services configured on an Ethernet service
        mplsPackage:
          $ref: '#/components/schemas/MplsPackageRO'
        g8032Package:
          $ref: '#/components/schemas/G8032PackageRO'
        flexePackage:
          $ref: '#/components/schemas/FlexePackageRO'
        signalIndex:
          $ref: '#/components/schemas/SignalIndexRO'
        segmentId:
          type: string
          description: The Segment Id of this layer termination
        classOfServices:
          type: array
          items:
            $ref: '#/components/schemas/ClassOfServicesRO'
          description: The list of class of services in this layer termination
        nativeName:
          type: string
          description: The name of the TPE that is native to the network element.
        oduFlexPackage:
          $ref: '#/components/schemas/OduFlexPackageRO'
        layerProtocol:
          $ref: '#/components/schemas/LayerProtocolRO'
        trafficProfiles:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfileRO'
          description: Traffic profile characteristics used to data-drive provisioning workflows.
        serviceLabel:
          type: string
          description: The service-identifiying label
        boundaries:
          type: array
          items:
            type: string
          description: Array of strings to track boundaries of Layer Termination
        ttiPackage:
          $ref: '#/components/schemas/TtiPackageRO'
        controlPlanePackage:
          $ref: '#/components/schemas/ControlPlanePackageRO'
        resiliencyTopologyPackage:
          $ref: '#/components/schemas/ResiliencyTopologyPackageRO'
        adminWt:
          type: number
          description: Administrative weight which specifies the level of importance given to the OSRP link
        bundleIds:
          type: array
          items:
            type: string
          description: List of up to 20 protection bundles to which the OSRP link belongs
        latency:
          type: number
          description: Indicates the delay in mic'roseconds.
        bgpPackage:
          $ref: '#/components/schemas/BgpPackageRO'
        parentPolicers:
          type: array
          items:
            $ref: '#/components/schemas/ParentPolicerRO'
          description: ''
        additionalAttributes:
          type: object
        txInfo:
          $ref: '#/components/schemas/TxInfoRO'
        ipInterfacePackage:
          $ref: '#/components/schemas/IpInterfacePackageRO'
        lastUpdatedAdminStateTimeStamp:
          type: string
          description: TimeStamp when the adminState was last changed
        lastUpdatedOperationalStateTimeStamp:
          type: string
          description: TimeStamp when the operational state was last changed
        L2Transform:
          $ref: '#/components/schemas/TransformTypesRO'
    LayeredAttributeRO:
      title: LayeredAttributeRO
      type: object
      properties:
        layer:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        additionalAttributes:
          type: object
        loopbackPackage:
          $ref: '#/components/schemas/LoopbackPackageRO'
        itsPackage:
          type: array
          items:
            $ref: '#/components/schemas/ItsPackageRO'
          description: ''
    LifeCycleRuleRO:
      title: LifeCycleRuleRO
      type: object
      properties:
        autoCreatedByNetwork:
          type: boolean
          description: Indicates if the entity is auto created by the network and/or device (true) or must it explicitly be created (false).
          default: false
        autoDeletedByNetwork:
          type: boolean
          description: Indicates if the entity is auto deleted by the network and/or device (true) or must it explicitly be created (false).
          default: false
    LinkAttributesRO:
      title: LinkAttributesRO
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
          description: Reference to 3rd Party Network involved in this topology, can be re-used for other purposes in future.
        description:
          type: string
          description: Short description of the topology to be created.
        userLabel:
          type: string
          description: The user label (not necessarily unique) of the topology to be created.
        note:
          $ref: '#/components/schemas/NoteRO'
        serialNumber:
          type: string
          description: Serial number for AOC/DAC plug
    LoopbackPackageRO:
      title: LoopbackPackageRO
      type: object
      properties:
        loopbackStatus:
          type: string
          description: Status of the test; taken directly from the value of the TL1 LPBKSTATUS field.
        loopbackWavelength:
          type: string
          description: Wavelength of the loopback test; taken directly from the value of the TL1 LPBKWVL field
    LqsDataRO:
      title: LqsDataRO
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status1'
        margin:
          $ref: '#/components/schemas/LqsMarginDataRO'
        fiber:
          $ref: '#/components/schemas/LqsFiberDataRO'
        ppg:
          $ref: '#/components/schemas/LqsPPGDataRO'
    LqsFiberDataRO:
      title: LqsFiberDataRO
      type: object
      properties:
        measuredLoss:
          type: number
        modeledLoss:
          type: number
        deltaLoss:
          type: number
        modeledMargin:
          type: number
        method:
          $ref: '#/components/schemas/Method'
        reconciled:
          type: boolean
          default: false
        deltaAvgToPlannedLoss:
          type: number
        avgLoss:
          type: number
        lastCalculationTime:
          type: string
        avgLossStatus:
          $ref: '#/components/schemas/AvgLossStatus'
        plannedLoss:
          type: number
        plannedLossMargin:
          type: number
        currentLoss:
          type: number
        currentLossTime:
          type: string
        currentLossMethod:
          $ref: '#/components/schemas/CurrentLossMethod'
    LqsMarginDataRO:
      title: LqsMarginDataRO
      type: object
      properties:
        minMargin:
          type: number
        upgrMargin:
          type: number
        sdMargin:
          type: number
        valid:
          type: boolean
          default: false
        viableAtEol:
          type: string
    LqsPPGDataRO:
      title: LqsPPGDataRO
      type: object
      properties:
        snrStatus:
          $ref: '#/components/schemas/SnrStatus'
        currentTimeSnr:
          type: number
        averageSnr:
          type: number
        minSnr:
          type: number
        plannedSnr:
          type: number
        latency:
          type: number
        chromaticDispersion:
          type: number
        distance:
          type: number
        deltaSnrPlanned:
          type: number
        deltaSnrReference:
          type: number
        heatMap:
          type: number
        equivRefSpans:
          type: number
        categorySnrReference:
          type: string
    MapperRuleRO:
      title: MapperRuleRO
      type: object
      properties:
        groupedTribSlots:
          type: array
          items:
            type: array
            items:
              type: string
        groupedAvailableTribPorts:
          type: array
          items:
            type: string
          description: ''
        usedStartingTimeSlots:
          type: array
          items:
            type: string
          description: ''
        tribSlots:
          type: array
          items:
            type: string
          description: Mapped tributary slots corresponding to tributary port
        tribPort:
          type: string
          description: Tributary port
    MappingInteractionRuleRO:
      title: MappingInteractionRuleRO
      type: object
      properties:
        segmentBoundaryRule:
          $ref: '#/components/schemas/SegmentBoundaryRule'
    MappingTableEntryRO:
      title: MappingTableEntryRO
      type: object
      properties:
        direction:
          $ref: '#/components/schemas/Direction5'
        label:
          type: string
          description: The user label.
        cos:
          type: string
          description: The class of service.
        ip:
          type: string
          description: The ip address.
        ranges:
          type: array
          items:
            $ref: '#/components/schemas/RangesEntryRO'
          description: ''
    MbbHistoryEntryRO:
      title: MbbHistoryEntryRO
      type: object
      properties:
        startTime:
          type: string
          description: Start time of the make-before-break happened
        endTime:
          type: string
          description: End time of the make-before-break happened
        result:
          type: string
          description: Result of the make-before-break
        reason:
          type: string
          description: Reason of the make-before-break
    MepEntryRO:
      title: MepEntryRO
      type: object
      properties:
        mepId:
          type: string
          description: The ID of the MEP
        ccmTransmitState:
          $ref: '#/components/schemas/CcmTransmitState'
        mepAdminState:
          $ref: '#/components/schemas/MepAdminState'
        mepType:
          $ref: '#/components/schemas/MepType'
        mepMacAddress:
          type: string
          description: The MAC address of the MEP
        ccmPriority:
          type: string
          description: Priority of the CC messages (0-7)
        vlanId:
          type: string
          description: The VLAN ID of the MEP
        lmm:
          $ref: '#/components/schemas/Y1731AttributesRO'
        dmm:
          $ref: '#/components/schemas/Y1731AttributesRO'
        slm:
          $ref: '#/components/schemas/Y1731AttributesRO'
        slmResponder:
          $ref: '#/components/schemas/SlmResponderRO'
        remoteMepId:
          type: string
          description: The ID of the remote MEP
        maName:
          type: string
          description: Holds maintenance association name
        ccmInterval:
          type: string
          description: The interval between CCM transmissions to be used by all MEPs in the MA
    MplsFbProtectedTunnelRO:
      title: MplsFbProtectedTunnelRO
      type: object
      properties:
        name:
          type: string
          description: Name of the tunnel protected by this FB tunnel
        srcIp:
          type: string
          description: Source IP address of the tunnel protected by this FB tunnel
        destIp:
          type: string
          description: Destination IP address of the tunnel protected by this FB tunnel
        role:
          $ref: '#/components/schemas/Role4'
    MplsFbRO:
      title: MplsFbRO
      type: object
      properties:
        frrAutoCreated:
          type: boolean
          description: The flag indicating whether the FB tunnel is auto created by FRR
          default: false
        protectedInterface:
          type: string
          description: Name of the interface being protected by the FB tunnel
        excludeIp:
          type: string
          description: IP address excluded from the FB tunnel path
        protectedTunnels:
          type: array
          items:
            $ref: '#/components/schemas/MplsFbProtectedTunnelRO'
          description: ''
    MplsFrrLocalProtectionRO:
      title: MplsFrrLocalProtectionRO
      type: object
      properties:
        protectionAvailable:
          type: boolean
          description: True when the protection is available on this endpoint
          default: false
        protectionInUse:
          type: boolean
          description: True when the protection is in use on this endpoint
          default: false
        protectionFbName:
          type: string
          description: Protection FB tunnel name
    MplsFrrProtectionRouteHopRO:
      title: MplsFrrProtectionRouteHopRO
      type: object
      properties:
        ip:
          type: string
          description: IP interface address or node loopback IP address of the current hop
        protectionType:
          $ref: '#/components/schemas/ProtectionType'
        protectionInUse:
          type: boolean
          description: True when the protection is in use on this endpoint
          default: false
        bwProtected:
          type: boolean
          description: True when the bandwidth is protected on this endpoint
          default: false
    MplsFrrRO:
      title: MplsFrrRO
      type: object
      properties:
        frrProtected:
          type: boolean
          description: If true, the tunnel is protected by fast re-route (FRR) on the headend TX MPLS CTP
          default: false
        profileName:
          type: string
          description: The FRR profile name on the headend TX MPLS CTP
        localProtection:
          $ref: '#/components/schemas/MplsFrrLocalProtectionRO'
        actualProtectionRoute:
          type: array
          items:
            $ref: '#/components/schemas/MplsFrrProtectionRouteHopRO'
          description: Actual FRR protection route on the headend TX MPLS CTP
    MplsPackageRO:
      title: MplsPackageRO
      type: object
      properties:
        lspName:
          type: string
          description: The name of this MPLS tunnel
        lspId:
          type: string
          description: The numeric ID of this MPLS tunnel
        coRouted:
          type: boolean
          description: If true, this MPLS tunnel is co-routed; otherwise it is associated
          default: false
        signaled:
          type: boolean
          description: If true, this MPLS tunnel is dynamic; otherwise it is static
          default: false
        subType:
          $ref: '#/components/schemas/SubType'
        direction:
          $ref: '#/components/schemas/Direction4'
        tunnelType:
          $ref: '#/components/schemas/TunnelType'
        ctrlPlaneId:
          type: string
          description: A generated value to uniquely identify a particular tunnel instance
        srcIp:
          type: string
          description: The IP-data interface address of the near end of this MPLS tunnel
        srcTunnelId:
          type: string
          description: The ID of the near end of this MPLS tunnel
        destIp:
          type: string
          description: The IP-data interface address of the far end of this MPLS tunnel
        destTunnelId:
          type: string
          description: The ID of the far end of this MPLS tunnel
        fwdIn:
          type: string
          description: The inward ID in the forward direction (transit)
        fwdOut:
          type: string
          description: The outward ID in the forward direction (transit)
        revIn:
          type: string
          description: The inward ID in the reverse direction (transit)
        revOut:
          type: string
          description: The outward ID in the reverse direction (transit)
        prevHopIp:
          type: string
          description: The interface address (on 6200, MAC address) of the previous hop of this MPLS tunnel
        nextHopIp:
          type: string
          description: The interface address (on 6200, MAC address) of the next hop of this MPLS tunnel
        prevHopIfNum:
          type: string
          description: The interface number of the previous hop of this MPLS tunnel
        nextHopIfNum:
          type: string
          description: The interface number of the next hop of this MPLS tunnel
        localIfNamePrevHop:
          type: string
          description: The local interface name of the previous hop of this MPLS tunnel (6200 only)
        localIfNameNextHop:
          type: string
          description: The local interface name of the next hop of this MPLS tunnel (6200 only)
        RxTag:
          type: string
          description: The label used for traffic ingressing to this endpoint
        TxTag:
          type: string
          description: The label used for traffic egressing from this endpoint
        tunnelRole:
          $ref: '#/components/schemas/TunnelRole1'
        bw:
          $ref: '#/components/schemas/BwRO'
        autoBackup:
          $ref: '#/components/schemas/AutoBackup'
        diversityResource:
          $ref: '#/components/schemas/DiversityResource'
        diversityLevel:
          $ref: '#/components/schemas/DiversityLevel'
        explicitRouteObject:
          type: array
          items:
            type: string
          description: An ordered list of hop-by-hop IP-data interface addresses traversed by this dynamic MPLS tunnel
        bfd:
          $ref: '#/components/schemas/BfdRO'
        aisProfileName:
          type: string
          description: The name of the Alarm Indication Signal profile for this MPLS tunnel
        aisSessionAdminState:
          $ref: '#/components/schemas/AisSessionAdminState'
        aisRefreshTimer:
          type: integer
          description: The interval between each AIS refresh for this MPLS tunnel
          format: int32
        aisRefreshTimerUnit:
          type: string
          description: The units for aisRefreshTimer field
        frrSignaling:
          $ref: '#/components/schemas/FrrSignaling'
        frrProfile:
          $ref: '#/components/schemas/FrrProfile'
        explicitTunnel:
          $ref: '#/components/schemas/TunnelPathRO'
        fixedTtl:
          type: string
          description: The time-to-live for tunnel hops (1-255)
        setupPriority:
          type: string
          description: The priority of the dynamic tunnel setup (0-7)
        holdPriority:
          type: string
          description: The priority of the dynamic tunnel steady-state (0-7)
        optimization:
          $ref: '#/components/schemas/Optimization'
        optimizationInterval:
          type: integer
          description: The interval between tunnel optimization attempts
          format: int32
        optimizationIntervalUnit:
          type: string
          description: The unit for optimizationInterval
        srlg:
          type: array
          items:
            type: string
          description: A list of shared-risk link-group values assigned to this interface
        colorGroup:
          $ref: '#/components/schemas/ColorGroupRO'
        includeAny:
          $ref: '#/components/schemas/ColorGroupRO'
        includeAll:
          $ref: '#/components/schemas/ColorGroupRO'
        excludeAny:
          $ref: '#/components/schemas/ColorGroupRO'
        includeAnyBackupTunnel:
          $ref: '#/components/schemas/ColorGroupRO'
        includeAllBackupTunnel:
          $ref: '#/components/schemas/ColorGroupRO'
        excludeAnyBackupTunnel:
          $ref: '#/components/schemas/ColorGroupRO'
        facilityBypass:
          type: boolean
          description: If true, this MPLS tunnel is facility-bypass (FB) tunnel
          default: false
        softPreemption:
          $ref: '#/components/schemas/SoftPreemption'
        stickyLsp:
          $ref: '#/components/schemas/StickyLsp'
        mbbHistory:
          type: array
          items:
            $ref: '#/components/schemas/MbbHistoryEntryRO'
          description: ''
        frr:
          $ref: '#/components/schemas/MplsFrrRO'
        fb:
          $ref: '#/components/schemas/MplsFbRO'
        fbProfile:
          $ref: '#/components/schemas/FbProfileRO'
        shareSrlg:
          type: array
          items:
            type: string
          description: A list of share SRLG values used by dynamic tunnel during provisioning.
    MsgsLastErrorRO:
      title: MsgsLastErrorRO
      type: object
      properties:
        errorCode:
          type: string
          description: Error code for last error
        errorSubCode:
          type: string
          description: Sub error code for last error
    NameToCapacityMappingRulesRO:
      title: NameToCapacityMappingRulesRO
      type: object
      properties:
        namingUnit:
          type: string
          description: Unit of namespace.
        capacityUnit:
          type: string
          description: Unit of the capacity.
        relationType:
          $ref: '#/components/schemas/RelationType'
        mapping:
          $ref: '#/components/schemas/Mapping'
        noOfUnits:
          type: integer
          description: Number 1-80 in switching and broadband case
          format: int32
        mapperRule:
          type: array
          items:
            $ref: '#/components/schemas/MapperRuleRO'
          description: ''
    NamingRulesRO:
      title: NamingRulesRO
      type: object
      properties:
        total:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        used:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        potentialGrowth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
    NetAddressRO:
      title: NetAddressRO
      type: object
      properties:
        areaId:
          type: string
          description: Area id of the device
        systemId:
          type: string
          description: System id of the device
        networkSelector:
          type: string
          description: network selector.
    NetworkConstructAttributesRO:
      title: NetworkConstructAttributesRO
      type: object
      properties:
        displayData:
          $ref: '#/components/schemas/NetworkConstructDisplayDataRO'
        identifiers:
          type: array
          items:
            type: object
          description: ''
        userData:
          type: object
        syncState:
          $ref: '#/components/schemas/SyncStateRO'
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        policies:
          $ref: '#/components/schemas/AttributePoliciesRO'
        tags:
          type: array
          items:
            type: string
          description: A list of tags for a given NC.
        note:
          $ref: '#/components/schemas/NoteRO'
        ipAddress:
          type: string
          description: IP address of the network construct.
        typeGroup:
          type: string
          description: Resource adapter type group.
        resourceType:
          type: string
          description: Resource Type.
        deviceType:
          type: string
          description: Device Type.
        softwareVersion:
          type: string
          description: Software version running in the device.
        nativeSoftwareVersion:
          type: string
          description: Native Software version running in the device.
        accessIdentifier:
          type: string
          description: 'AID of the device, i.e. for 6500 shelf : SHELF-n.'
        macAddress:
          type: string
          description: MAC address of the device.
        name:
          type: string
          description: Name (e.g. TID) of the Network Construct
        longName:
          type: string
          description: Extended name of the Network Construct
        geoLocation:
          $ref: '#/components/schemas/GeoLocationRO'
        serialNumber:
          type: string
          description: Serial number (e.g. NNTMHQDP0001)
        deviceVersion:
          type: string
          description: Device version (e.g. 6500 32-SLOT OPTICAL)
        softwareType:
          type: string
          description: Software type (e.g. OCP)
        softwareImage:
          type: string
          description: Software image
        subnetName:
          type: string
          description: Subnet name (e.g. ROADM1---ROADM2---SUBNET)
        numberOfShelves:
          type: integer
          description: Number of shelves (primary + member shelves in case of TIDc)
          format: int32
        memberShelvesData:
          type: array
          items:
            $ref: '#/components/schemas/ShelfDataRO'
          description: It represents the shelf data on the NE.
        memberFunction:
          $ref: '#/components/schemas/MemberFunction'
        shelfType:
          $ref: '#/components/schemas/ShelfType'
        capabilitySpecRef:
          type: string
          description: Name of the file which contains the constraint rules of the network device.
        modelType:
          $ref: '#/components/schemas/ModelType'
        networkConstructType:
          $ref: '#/components/schemas/NetworkConstructType'
        l2Data:
          type: array
          items:
            $ref: '#/components/schemas/L2DataRO'
          description: It represents the L2 Configuration Data on the NE.
        l0Data:
          $ref: '#/components/schemas/L0DataRO'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the NE belongs to.
        associationState:
          $ref: '#/components/schemas/AssociationState'
        associationStateQualifier:
          $ref: '#/components/schemas/AssociationStateQualifier'
        associationStateQualifierReason:
          type: string
          description: Reason for going into maintenance mode.
        associationStateLastUpdatedTime:
          type: string
          description: Date at which we last changed association state.
        ipCommunicationDetails:
          $ref: '#/components/schemas/IPCommunicationDetailsRO'
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
        managementAddresses:
          type: array
          items:
            type: string
          description: IP address of the shelf(ves). This is a passive attribute that isn't used to create connections to the NE (conn-addrs are).
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared Srlgs on this NC.
        siteId:
          type: string
          description: Site ID for the networkConstruct
        siteName:
          type: string
          description: Site name for the networkConstruct
        packetData:
          type: array
          items:
            $ref: '#/components/schemas/PacketDataRO'
          description: Holds packet infra data.
    NetworkConstructDataRO:
      title: NetworkConstructDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the NetworkConstruct resource
        type:
          $ref: '#/components/schemas/Type45'
        attributes:
          $ref: '#/components/schemas/NetworkConstructAttributesRO'
        relationships:
          $ref: '#/components/schemas/NetworkConstructRelationshipsRO'
    NetworkConstructDisplayDataRO:
      title: NetworkConstructDisplayDataRO
      type: object
      properties:
        displayName:
          type: string
          description: Name (e.g. TID) of the Network Construct
        displayIpAddress:
          type: string
          description: IP address used for expectations.
        displayMACAddress:
          type: string
          description: MAC address used for expectations.
        displaySyncState:
          $ref: '#/components/schemas/DisplaySyncState'
        displayResourceState:
          type: string
          description: Resource state of the network construct
        displayInventorySyncFailureReason:
          type: string
          description: Used to display inventory sync failure reason.
        displayAssociationState:
          type: string
          description: Used to display the association state of the network construct
        displayPhysicalLocationName:
          type: string
          description: Used to display the name of the discovered physical location it's related to.
        displayMapSiteName:
          type: string
          description: Used to display the name of the physical location it's related to based on the location data the map is using.
    NetworkConstructListRO:
      title: NetworkConstructListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/NetworkConstructDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Array of associated planned, expectations, discovered, physical locations, or parent Network Constructs
    NetworkConstructRelationshipsRO:
      title: NetworkConstructRelationshipsRO
      type: object
      properties:
        networkConstructPlanned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstructExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstructDiscovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        managementSession:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        utilization:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstructTiming:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        physicalLocation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        parentNetworkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        childrenNetworkConstruct:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concreteAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        groups:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    NodeWithTypeRO:
      title: NodeWithTypeRO
      type: object
      properties:
        name:
          type: string
          description: Node name
        type:
          $ref: '#/components/schemas/Type41'
    NoteRO:
      title: NoteRO
      type: object
      properties:
        noteMsg:
          type: string
          description: The message left on the note left by the user
        lastUpdatedBy:
          type: string
          description: The name of the user that last edited the note
        lastUpdatedTime:
          type: string
          description: The time the note was last updated
    OduFlexPackageRO:
      title: OduFlexPackageRO
      type: object
      properties:
        bitRate:
          type: string
          description: Defines the bit rate of the ODUFlex.
        tolerance:
          type: string
          description: Defines the tolerance in ppm of the ODUFlex payload.
        resizable:
          type: boolean
          description: Defines if the ODUFlex is resizable.
          default: false
    OperationRO:
      title: OperationRO
      type: object
      properties:
        tag:
          type: integer
          description: Dependent on the xform operation, the tag numbers are  stamp => '1' represents outermost tag, '2' next outermost (next inner)  pop => '1' represents pop outermost, '2' represents pop outermost, (always pop from outer)  push => '1' represents push outermost, '2' represents push outermost (always push to outer)
          format: int32
        functionType:
          $ref: '#/components/schemas/FunctionType'
        vlanId:
          type: string
          description: Represents a IEEE 802.1Q VLAN-ID.
        etherType:
          $ref: '#/components/schemas/EtherType'
    OspfRouterRO:
      title: OspfRouterRO
      type: object
      properties:
        routerId:
          type: string
          description: ID of the router primarily applicable for OSPF, takes the from of an IPV4 address
        areaBorderRouter:
          $ref: '#/components/schemas/AreaBorderRouter'
        areaSystemBorderRouter:
          $ref: '#/components/schemas/AreaSystemBorderRouter'
        area:
          type: string
          description: OSPFV2 area of the network construct. Takes the form of an IPV4 address
    OspfRouterRO_1:
      title: OspfRouterRO_1
      type: object
      properties:
        routerId:
          type: string
          description: ID of the router primarily applicable for OSPFV3, takes the from of an IPV4 address
        areaBorderRouter:
          $ref: '#/components/schemas/AreaBorderRouter'
        area:
          type: string
          description: OSPFV3 area of the network construct. Takes the form of an IPV4 address
    OspfcircuitRO:
      title: OspfcircuitRO
      type: object
      properties:
        networkArea:
          type: string
          description: Network area in the form of an IPV4 address
        cost:
          type: integer
          description: Cost associated with the network interface
          format: int32
        carrier:
          type: string
          description: Identifies the carrier, ie. Section, Line, GCC0, GCC1. When an interface supports multiple layers, carrier may be required to uniquely identify the entry
        identifier:
          type: string
          description: Unique identifier for the OSPFv3 circuit
        passive:
          type: string
          description: ON/OFF enables/disables passive circuit
        opaque:
          type: string
          description: ON/OFF, enables/disables opaque circuit
    OspfcircuitRO_1:
      title: OspfcircuitRO_1
      type: object
      properties:
        networkArea:
          type: string
          description: Network area in the form of an IPV4 address
        cost:
          type: integer
          description: Cost associated with the network interface
          format: int32
        carrier:
          type: string
          description: Identifies the carrier, ie. Section, Line, GCC0, GCC1. When an interface supports multiple layers, carrier may be required to uniquely identify the entry
        identifier:
          type: string
          description: Unique identifier for the OSPFv3 circuit
    OtdrPackageRO:
      title: OtdrPackageRO
      type: object
      properties:
        sourceOtdrcfgaId:
          type: string
          description: Source otdr capable tpe Id
        destinationOtdrcfgaId:
          type: string
          description: Destination otdr capable tpe Id
        isOtdrCapable:
          type: string
          description: flag to indicate that otdr is capable
        sourceNcId:
          type: string
          description: source NC Id
        destinationNcId:
          type: string
          description: destination NC id
        sourceTraceTimestamp:
          type: string
          description: The time of the OTDR trace
        destinationTraceTimestamp:
          type: string
          description: The time of the OTDR trace
        sourceTraceType:
          type: string
          description: The type of measured trace
        destinationTraceType:
          type: string
          description: The type of measured trace
    PFibDataRO:
      title: PFibDataRO
      type: object
      properties:
        band:
          type: string
          description: band name
        raman:
          type: string
          description: with or without raman value
        pFibA:
          type: string
          description: PFib-a value
        pFibB:
          type: string
          description: Pfib-b value
    PacketDataRO:
      title: PacketDataRO
      type: object
      properties:
        shelf:
          type: string
        eqptGrp:
          type: string
          description: The group ID obtained from RTRV-EQPTGRP for the SAOS card on which the entity resides
        segmentRouting:
          type: array
          items:
            $ref: '#/components/schemas/SegmentRoutingRO'
          description: Holds segment routing configuration data.
        isis:
          type: array
          items:
            $ref: '#/components/schemas/ISISDataRO'
          description: Holds ISIS configuration data.
    ParentPolicerRO:
      title: ParentPolicerRO
      type: object
      properties:
        name:
          type: string
          description: Name of the parent policer
        cir:
          type: integer
          description: Committed Information rate in kbps of this parent policer
          format: int32
        cbs:
          type: integer
          description: Committed burst size of this policer
          format: int32
        evcList:
          type: array
          items:
            type: string
          description: List of services attached to the parent policer
        adminState:
          $ref: '#/components/schemas/AdminState3'
    PhotonicSpectrumPackageRO:
      title: PhotonicSpectrumPackageRO
      type: object
      properties:
        minFreqDeadBand:
          type: string
          description: Lower dead band in GHz. The dead band will be in format of 'xxxx.xxx'.
        maxFreqDeadBand:
          type: string
          description: Upper dead band in GHz. The dead band will be in format of 'xxxx.xxx'.
        targetMinFreq:
          type: string
          description: Allows the automatic adjustment of the MINFREQ when any associated NMCTP are deleted. Default is MINFREQ (no target lower frequency).
        targetMaxFreq:
          type: string
          description: Allows the automatic adjustment of the MAXFREQ when any associated NMCTP are deleted. Default is MAXFREQ (no target upper frequency).
        minFreqGuardBand:
          type: string
          description: Indicates the minimum required frequency spacing for the previous NMC.
        maxFreqGuardBand:
          type: string
          description: Indicates the minimum required frequency spacing for the next NMC.
        freqResolution:
          type: string
          description: Indicates the recurring frequency step that is allowed to be configured on the transponder.
        signalBandWidth10DB:
          type: string
          description: Captures Tx Signal Bandwidth in GHz measured at 10 dBm less than peak power.
        signalBandWidth3DB:
          type: string
          description: Captures Tx Signal Bandwidth in GHz measured at 3 dBm less than peak power.
        frequency:
          type: string
          description: The central signal frequency.
        minFreq:
          type: string
          description: The minimum signal frequency.
        maxFreq:
          type: string
          description: The maximum signal frequency.
        width:
          type: string
          description: The signal width.
        wavelength:
          type: string
          description: The central signal wavelength.
        wavelengthGrid:
          type: string
          description: A hexadecimal number representing the vector of wavelengths that can be used by this SNC. Each bit set within the number indicates which wavelength is currently configured
    PhyDetailsRO:
      title: PhyDetailsRO
      type: object
      properties:
        phyNumber:
          type: string
          description: Phy Number of each FlexE port, e.g. PHY-1, PHY-2, etc.
        portName:
          type: string
          description: Name for FlexE port
        slotMappings:
          type: object
    PlannedBandwidthRO:
      title: PlannedBandwidthRO
      type: object
      properties:
        startTime:
          type: string
          description: Start time of metric in UTC
        endTime:
          type: string
          description: Start time of metric in UTC
        expectationId:
          type: string
          description: Expectation id of planned capacity
        recurrenceRule:
          $ref: '#/components/schemas/RecurrenceRuleRO'
        capacities:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
    PowerPackageRO:
      title: PowerPackageRO
      type: object
      properties:
        txActualPower:
          type: string
          description: Current transmitter power (dBm).
        txMaxPower:
          type: string
          description: Maximum transmitter power level (dBm).
        txMinPower:
          type: string
          description: Minimum transmitter power level (dBm).
        txCurrentLaunchPower:
          type: string
          description: Current launch power level (dBm).
        txMinLaunchPower:
          type: string
          description: Minimum launch power level (dBm).
        rxActualPower:
          type: string
          description: Current receiver power (dBm).
        rxMaxPower:
          type: string
          description: Maximum receiver power level (dBm).
        rxMinPower:
          type: string
          description: Minimum receiver power level (dBm).
        rxNominalInput:
          type: string
          description: Typical per channel operational power (dBm).
        rxOverloadThreshold:
          type: string
          description: Maximum per channel operational power (dBm).
        rxSensitivityThreshold:
          type: string
          description: Mininum per channel operational power (dBm).
    PreemptionBandwidthDataRO:
      title: PreemptionBandwidthDataRO
      type: object
      properties:
        ODU0:
          $ref: '#/components/schemas/BwRO'
        ODU1:
          $ref: '#/components/schemas/BwRO'
        ODU2:
          $ref: '#/components/schemas/BwRO'
        ODU2E:
          $ref: '#/components/schemas/BwRO'
        ODU3:
          $ref: '#/components/schemas/BwRO'
        ODU4:
          $ref: '#/components/schemas/BwRO'
        ODUFLEXRSZ:
          $ref: '#/components/schemas/BwRO'
        ODUFLEXNRSZ:
          $ref: '#/components/schemas/BwRO'
    PreemptionBandwidthRO:
      title: PreemptionBandwidthRO
      type: object
      properties:
        extraTraffic:
          $ref: '#/components/schemas/PreemptionBandwidthDataRO'
        preemptable:
          $ref: '#/components/schemas/PreemptionBandwidthDataRO'
        nonPreemptable:
          $ref: '#/components/schemas/PreemptionBandwidthDataRO'
    PrefixSidMapRO:
      title: PrefixSidMapRO
      type: object
      properties:
        prefix:
          type: string
          description: isis loopback prefix.
        prefixSid:
          type: integer
          description: Prefix SID/Node SID allocated.
          format: int32
        sidRange:
          type: integer
          description: Describes range of SIDs could be allocated.
          format: int32
        valueType:
          $ref: '#/components/schemas/PrefixType'
        interface:
          type: string
          description: isis loopback interface name.
    RRConfigRO:
      title: RRConfigRO
      type: object
      properties:
        configured:
          type: boolean
          description: A flag to check if RR configured or not.
          default: false
        clusters:
          type: array
          items:
            $ref: '#/components/schemas/ClusterRO'
          description: Holds data related to Clusters configured on RR
    RangeRO:
      title: RangeRO
      type: object
      properties:
        minValue:
          type: integer
          description: This defines the min value for the range.
          format: int32
        maxValue:
          type: integer
          description: This defines the max value for the range.
          format: int32
    RangesEntryRO:
      title: RangesEntryRO
      type: object
      properties:
        label:
          type: string
          description: The cvid range to be used.
        type:
          $ref: '#/components/schemas/Type32'
    RecurrenceRuleRO:
      title: RecurrenceRuleRO
      type: object
      properties:
        frequency:
          $ref: '#/components/schemas/Frequency1'
        interval:
          type: integer
          description: interval of frequency
          format: int32
        until:
          type: string
          description: end time of recurrence in UTC
        count:
          type: integer
          description: total count of recurring event
          format: int32
    RegenIdPackageRO:
      title: RegenIdPackageRO
      type: object
      properties:
        regenTid:
          type: string
          description: This field is the Regen ID Tid
        nearTransponder:
          type: string
          description: This field is near Transponder Shelf SLot Port.
        clientTransponder:
          type: string
          description: The Client Transponder Shelf SLot Port
        mateInfo:
          type: string
          description: This field is Mate Info String.
    ResiliencyHandlingEdgeRO:
      title: ResiliencyHandlingEdgeRO
      type: object
      properties:
        switchTpeId:
          type: string
          description: The ID of the CTPs in the physical view
        clientTpeId:
          type: string
          description: The ID of the client PTP connected to the switch
    ResiliencyHandlingPackageRO:
      title: ResiliencyHandlingPackageRO
      type: object
      properties:
        layerRateStack:
          type: array
          items:
            $ref: '#/components/schemas/LayerRateStack'
          description: ordered list of layerRates
        edges:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyHandlingEdgeRO'
          description: hold the pairs of ID of the CTPs from the physical view and its client PTP ID, for the eFRE endpoints.
        commonEdgeTpeId:
          type: string
          description: the ID of the common CTP in the physical view
        direction:
          $ref: '#/components/schemas/Direction12'
    ResiliencyTopologyPackageRO:
      title: ResiliencyTopologyPackageRO
      type: object
      properties:
        switchTpeId:
          type: string
          description: Switch port client TPE
        resilientFreId:
          type: string
          description: Resilient nodal fre id
    RestorationHealthRO:
      title: RestorationHealthRO
      type: object
      properties:
        totalExplicitRoutes:
          type: integer
          format: int32
        availableExplicitRoutes:
          type: integer
          format: int32
        unavailableExplicitRoutes:
          type: integer
          format: int32
        availablePercentage:
          type: integer
          format: int32
        unavailablePercentage:
          type: integer
          format: int32
        homeAvailable:
          type: boolean
          default: false
    RouteConstraintsRO:
      title: RouteConstraintsRO
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type33'
        numberOfRoutes:
          type: string
          description: Number of routes defined by the configuration. For example, a PRIME/MEMBER configuration.  Could be a number, or could be a number evident from the model i.e. inverseMux. Generally, should only be specified if the configuration implies more than 1 route.
        sizeOfEachRoute:
          type: string
          description: For each route, what is the required size of each route. For example, '200G' in the case of 400G WLAi OTR 2xOTSi.
        maxInCpGroup:
          type: string
          description: Maximum number of routes that can be present in a control plane group. Could be a number, or could be a number evident n the model i.e. inverseMux.
        routeCharacteristic:
          $ref: '#/components/schemas/RouteCharacteristic'
        signalPattern:
          $ref: '#/components/schemas/SignalPattern'
    RoutingConstraintsRO:
      title: RoutingConstraintsRO
      type: object
      properties:
        isRouteExclusive:
          type: boolean
          description: Route exclusive true/false
          default: false
        maxCost:
          type: integer
          description: Max cost
          format: int32
        identifier:
          type: string
          description: The identifier to the decomposed fre
        routeExclusivity:
          $ref: '#/components/schemas/RouteExclusivity'
        maxProtectCost:
          type: integer
          description: The maximum allowable weight/cost of the ProtectRoute
          format: int32
        costCriteria:
          $ref: '#/components/schemas/CostCriteria'
        protectionClass:
          $ref: '#/components/schemas/ProtectionClass'
        homeCostPreference:
          $ref: '#/components/schemas/HomeCostPreference'
        protectCostPreference:
          $ref: '#/components/schemas/HomeCostPreference'
        isGroupingForCoroutingRequired:
          type: boolean
          description: Specifies if the FRE should be part of a group
          default: false
        inclusionConstraints:
          $ref: '#/components/schemas/AssociationObjectAttributesRO'
        exclusionConstraints:
          $ref: '#/components/schemas/AssociationObjectAttributesRO'
    SRServiceCatalogAdditionalConstraintsRO:
      title: SRServiceCatalogAdditionalConstraintsRO
      type: object
      properties:
        diverseSource:
          type: string
          description: Diverse Source (when PE Diverse)
        diverseEndpoint:
          type: string
          description: Diverse EndPoint (when PE Diverse)
        general:
          $ref: '#/components/schemas/GeneralRO'
        protection:
          $ref: '#/components/schemas/SrProtectionPathAttributesRO'
        inclusionConstraints:
          $ref: '#/components/schemas/SRServiceCatalogNodeAttributesRO'
        exclusionConstraints:
          $ref: '#/components/schemas/SRServiceCatalogNodeAttributesRO'
    SRServiceCatalogNodeAttributesRO:
      title: SRServiceCatalogNodeAttributesRO
      type: object
      properties:
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/NodeWithTypeRO'
          description: ''
        interfaces:
          type: array
          items:
            type: string
          description: List of interfaces
        srlg:
          type: array
          items:
            type: string
          description: List of SrLg
        affinity:
          $ref: '#/components/schemas/AffinityRO'
    SegmentDataRO:
      title: SegmentDataRO
      type: object
      properties:
        index:
          type: integer
          description: Segment index
          format: int32
        segmentType:
          $ref: '#/components/schemas/SegmentType'
        value:
          type: object
          description: MPLS Label value/Segment declared by IPv4 prefix
        localIpv4Address:
          type: object
          description: Segment local IPv4 adjacency address
        remoteIpv4Address:
          type: object
          description: Segment remote IPv4 adjacency address
        sidValue:
          type: string
          description: Segment list label value
        ipAddress:
          type: string
          description: Segment list loopback IP address
    SegmentListDataRO:
      title: SegmentListDataRO
      type: object
      properties:
        name:
          type: object
          description: Reference to Segment-list name
        weight:
          type: integer
          description: Segment-list weighted loadshare
          format: int32
        valid:
          type: boolean
          description: Segment-list valid or not
          default: false
        invalidationReason:
          type: string
          description: Specifies reason for paths which are invalid
        segments:
          type: array
          items:
            $ref: '#/components/schemas/SegmentDataRO'
          description: Segments for given segment list
    SegmentRoutingRO:
      title: SegmentRoutingRO
      type: object
      properties:
        supportingProtocol:
          type: array
          items:
            type: object
          description: Protocol supporting segment routing.
        srgbRange:
          $ref: '#/components/schemas/LabelRangeRO'
        bindingSidRange:
          $ref: '#/components/schemas/LabelRangeRO'
        prefixType:
          $ref: '#/components/schemas/PrefixType'
        startSid:
          type: integer
          description: SID value associated with prefix.
          format: int32
        sidRange:
          type: integer
          description: Describes range of SIDs could be allocated.
          format: int32
        algorithm:
          type: string
          description: Prefix-sid algorithm.
        lastHopBehavior:
          $ref: '#/components/schemas/LastHopBehavior'
    ServicePriorityRO:
      title: ServicePriorityRO
      type: object
      properties:
        name:
          type: string
          description: Service Priority Name
        description:
          type: string
          description: Service Priority Description
        cos:
          type: integer
          description: Service Priority Cos
          format: int32
        quota:
          type: string
          description: Service Priority Quota
    ServiceRefreshRO:
      title: ServiceRefreshRO
      type: object
      properties:
        state:
          $ref: '#/components/schemas/State5'
        status:
          type: string
          description: Details with further information about the status (e.g. failure reasons)
    ShelfDataRO:
      title: ShelfDataRO
      type: object
      properties:
        shelfNumber:
          type: string
          description: This represents the shelf number of the shelf
        shelfIP:
          type: string
          description: This represents the IP address of the shelf
        estimatedPower:
          type: string
          description: This represents the Estimated Power of the shelf
        colanIP:
          type: string
          description: This represents the COLAN IP of the shelf
        GNE:
          type: string
          description: This represents the GNE status of the shelf
        l2motrBandwidthProfiles:
          type: array
          items:
            $ref: '#/components/schemas/L2MotrBandwidthProfilesDataRO'
          description: A list of L2motr bandwidth profiles
    SignalIndexRO:
      title: SignalIndexRO
      type: object
      properties:
        wavelength:
          type: string
          description: The signal wavelength (nm).
        wavelengthMin:
          type: string
          description: The minimum signal wavelength.
        wavelengthMax:
          type: string
          description: The maximum signal wavelength.
        index:
          type: string
          description: The signal index. Indicates a time slot.
        odu2_index:
          type: string
          description: The odu2 index. Indicates a time slot or tributary port number.
        odu3_index:
          type: string
          description: The odu3 index. Indicates a time slot or tributary port number.
        odu4_index:
          type: string
          description: The odu4 index. Indicates a time slot or tributary port number.
        oduCn_index:
          type: string
          description: The oduCn index. Indicates a time slot or tributary port number.
        eth_index:
          type: string
          description: The eth index.
        indexes:
          type: object
        channels:
          type: array
          items:
            type: string
          description: Indicates the list of discrete channels utilized e.g. tributary slots on broadband cards. Plans are to utilize this generically for any list of discrete list of signals.
        ots_index:
          type: string
          description: The ots index. Indicates a time slot.
        phy_index:
          type: string
          description: The physical index. Indicates a time slot.
        mappingTable:
          type: array
          items:
            $ref: '#/components/schemas/MappingTableEntryRO'
          description: ''
        frequency:
          type: string
          description: The central signal frequency.
        minFreq:
          type: string
          description: The minimum signal frequency.
        maxFreq:
          type: string
          description: The maximum signal frequency.
        width:
          type: string
          description: The signal width.
        mgmtMcId:
          type: string
          description: The management identifier of the media channel
        isCatchAll:
          type: string
          description: isCatch all enabled on this port
    SlddRO:
      title: SlddRO
      type: object
      properties:
        adminState:
          type: string
          description: ON/OFF enables/disables SLDD
        config:
          type: string
          description: AUTO/MANUAL When set to auto the scope id will be automatically re-provisioned when the Site Id changed
        scopeid:
          type: integer
          description: AR/TR records are distributed to all shelves with the same scope id. 0-65535
          format: int32
    SlmResponderRO:
      title: SlmResponderRO
      type: object
      properties:
        testId:
          type: integer
          description: The ID of the test
          format: int32
        remoteMepId:
          type: string
          description: The ID of the remote MEP
    SncPreemptionPackageRO:
      title: SncPreemptionPackageRO
      type: object
      properties:
        setupPriority:
          type: integer
          description: Setup Priority of SNC
          format: int32
        holdingPriority:
          type: integer
          description: Holding Priority of SNC
          format: int32
        preemptionLevel:
          type: string
          description: Combined level of setup and holding priority
    SncpPackageRO:
      title: SncpPackageRO
      type: object
      properties:
        peerOsrpNodeName:
          type: string
        peerRole:
          $ref: '#/components/schemas/PeerRole2'
        peerIdentifier:
          type: string
        srcEpShared:
          type: boolean
          default: false
        destEpShared:
          type: boolean
          default: false
    SrPolicyRO:
      title: SrPolicyRO
      type: object
      properties:
        headEnd:
          type: string
          description: Where the SR Policy is instantiated (implemented)
        endPoint:
          type: string
          description: The destination of the SR Policy
        color:
          type: integer
          description: A numerical value to differentiate multiple SR-TE Policies between the same pair of nodes
          format: int32
        catalog:
          type: string
          description: A transport policy type
        fallback:
          type: boolean
          description: Fallback to default network routing in case SR-TE policy unavailable
          default: false
    SrProtectionPathAttributesRO:
      title: SrProtectionPathAttributesRO
      type: object
      properties:
        nodeDiverse:
          type: boolean
          description: Node Diverse
          default: false
        linkDiverse:
          type: boolean
          description: linkDiverse
          default: false
        srlgDiverse:
          type: boolean
          description: SRLG Diverse
          default: false
        peDiverse:
          type: boolean
          description: PE Diverse
          default: false
        transportSRLGDiverse:
          type: boolean
          description: transportSRLGDiverse
          default: false
    SrTeBindingSidRO:
      title: SrTeBindingSidRO
      type: object
      properties:
        bindingAllocMode:
          $ref: '#/components/schemas/BindingAllocMode'
        dataplaneType:
          $ref: '#/components/schemas/DataplaneType'
        bindingAllocatedSid:
          type: string
          description: Allocated SID value for the binding SID
    SrTeCandidatePathsDataRO:
      title: SrTeCandidatePathsDataRO
      type: object
      properties:
        protocolOrigin:
          $ref: '#/components/schemas/ProtocolOrigin'
        originator:
          type: string
          description: Identifier (concatenation of ASN and node-address) of the node that signalled/instantiated the candidate path on headend
        discriminator:
          type: integer
          description: Candidate path distinguisher
          format: int32
        preference:
          type: integer
          description: Candidate path preference
          format: int32
        name:
          type: string
          description: Candidate path name
        description:
          type: string
          description: Candidate path description
        isBestCandiatePath:
          type: boolean
          description: Best Candidate Path
          default: false
        candidatePathType:
          type: string
          description: Type of candidate paths
        segmentLists:
          type: array
          items:
            $ref: '#/components/schemas/SegmentListDataRO'
          description: Segment List Properties
    StateHistoryRO:
      title: StateHistoryRO
      type: object
      properties:
        time:
          type: string
        state:
          $ref: '#/components/schemas/State7'
    StaticRouteRO:
      title: StaticRouteRO
      type: object
      properties:
        vrfName:
          type: string
          description: The name of the vrf instance
        vrfId:
          type: string
          description: The id of the vrf instance
        l3VpnId:
          type: string
          description: The id of the l3vpn service
        destinationPrefix:
          type: string
          description: destination address
        dropTraffic:
          type: boolean
          description: silently discard the packet
          default: false
        nextHopIp:
          type: string
          description: next hop address
        outgoingInterfaceName:
          type: string
          description: name of the outgoing interface
        routePreference:
          type: integer
          description: administrative distance
          format: int32
        tag:
          type: integer
          description: route tag
          format: int32
        description:
          type: string
          description: description of the route
        routeSelected:
          type: boolean
          description: preferred route among all routes that have the same destination prefix
          default: false
    StitchingTriggersRO:
      title: StitchingTriggersRO
      type: object
      properties:
        partitioningFreConcreteIds:
          type: array
          items:
            type: string
          description: List of physical FRE IDs for which stitcher should add a concrete relationship to on the stitched FRE
        protectingFreConcreteIds:
          type: array
          items:
            type: string
          description: List of physical FRE IDs for which stitcher should add a concrete relationship to on the stitched resiliency FRE, where there is an EncapsulatedResiliency with a protectionScheme defined.
        backpropagateTpeId:
          type: string
          description: Stitcher uses backpropagte TPE id while creating FRE in physical view
    SupportedByLayerRatePackageRO:
      title: SupportedByLayerRatePackageRO
      type: object
      properties:
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        layerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
    SyncStateRO:
      title: SyncStateRO
      type: object
      properties:
        state:
          $ref: '#/components/schemas/State7'
        additionalText:
          type: string
        lastStateUpdated:
          type: string
        lastSynchronized:
          type: string
        stateHistory:
          type: array
          items:
            $ref: '#/components/schemas/StateHistoryRO'
          description: list of state and time history.
    TandemConnectionMonitoringRO:
      title: TandemConnectionMonitoringRO
      type: object
      properties:
        nativeName:
          type: string
          description: The name of the TCM TPE that is native to the network element.
        userLabel:
          type: string
          description: The label given to the TCM TPE by an user
        owner:
          type: string
          description: Identifies who created the TCM facility
        suppTpeNativeName:
          type: string
          description: The supporting Termination Point
        mode:
          type: string
          description: Identifies the mode of the TCM
        state:
          type: string
          description: Primary State of TCM CTP
        additionalAttributes:
          type: object
    TerminationRO:
      title: TerminationRO
      type: object
      properties:
        connectionRulesInOwnLayer:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRuleRO'
          description: ''
    TopologyRO:
      title: TopologyRO
      type: object
      properties:
        type:
          type: string
          description: The ID resource type
        id:
          type: string
          description: The unique identifier for the referenced resource
        name:
          type: string
          description: The port name in the referenced resource or its expectation
    TpeAttributesRO:
      title: TpeAttributesRO
      type: object
      properties:
        state:
          $ref: '#/components/schemas/State9'
        suppressPort:
          type: boolean
          description: Value for alarm suppression
          default: false
        userData:
          type: object
        identifiers:
          type: array
          items:
            type: object
          description: ''
        displayData:
          $ref: '#/components/schemas/TpeDisplayDataRO'
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        bookingData:
          $ref: '#/components/schemas/BookingDataRO'
        policies:
          $ref: '#/components/schemas/AttributePoliciesRO'
        structureType:
          $ref: '#/components/schemas/StructureType2'
        structureSubType:
          $ref: '#/components/schemas/StructureSubType'
        tpeSpec:
          type: string
          description: 'Name of TPESpec describing this TPE instance. FUTURE: enumerated value, part of TPESpec catalog.'
        tpeGroupSpecs:
          type: array
          items:
            type: string
          description: 'Names of TPEGSpec-s this TPE belongs to. FUTURE: enumerated value, part of TPEGSpec catalog.'
        nativeName:
          type: string
          description: The name of the TPE that is native to the network element
        userLabel:
          type: string
          description: The label given to the TPE by an user
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
        layerTerminations:
          type: array
          items:
            $ref: '#/components/schemas/LayerTerminationRO'
          description: ''
        stackDirection:
          $ref: '#/components/schemas/StackDirection'
        displayAlias:
          type: string
          description: The displayAlias of the TPE
        dynamicFgiSpecificationRefList:
          type: array
          items:
            type: string
          description: A list of dynamic Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.  E.g 'May_Comment:1.0.0:1234'
        fgiSpecificationRefList:
          type: array
          items:
            type: string
          description: A list of Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.  E.g 'May_Comment:1.0.0:1234'
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        availableCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        capacityReservations:
          type: array
          items:
            $ref: '#/components/schemas/CapacityReservationRO'
          description: ''
        cardType:
          type: string
        category:
          $ref: '#/components/schemas/Category4'
        roadmLine:
          type: string
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/SyncScopeRO'
          description: The sync scope for the TPE
        modelType:
          $ref: '#/components/schemas/ModelType'
        active:
          type: boolean
          description: An indicator to flag when a TPE is active, or simply a potential.
          default: false
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        lifeCycleOwner:
          type: string
          description: Specifies who owns the lifecycle of a TPE
        provisioningAttributes:
          type: object
        capabilitySpecification:
          $ref: '#/components/schemas/CapabilitySpecRO'
        cardMode:
          $ref: '#/components/schemas/CardMode'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
        customerCode:
          type: string
          description: Customer code
        owningServerTpeListType:
          $ref: '#/components/schemas/OwningServerTpeListType'
        resiliencyHandlingPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyHandlingPackageRO'
          description: triggers stitcher building resiliency view and NSI updating layerRate in resiliency view
        resiliencyPackage:
          $ref: '#/components/schemas/TpeResiliencyPackageRO'
        parentEBBWConstraint:
          $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
        parentEBFREBWConstraint:
          $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
        parentEBBWConstraintList:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
          description: A list of Virtual TPEs as BW constraint.
        parentEBFREBWConstraintList:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
          description: A list of Virtual TPEs as FRE constraint.
        stitchingTriggers:
          $ref: '#/components/schemas/StitchingTriggersRO'
        plannedEndpointRole:
          $ref: '#/components/schemas/PlannedEndpointRole'
        gneSubnetName:
          type: string
          description: The GNE Subnet Name of the TPE
        displayRate:
          type: string
          description: DisplayRate of TPE, for instance BITRATE of ODUTTP in case of ODUFLEX/ETHFLEX rate TPE
        referencedByAssociations:
          type: array
          items:
            $ref: '#/components/schemas/AssociationRO'
          description: A list of associations of fres that would refer to this tpe
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group .
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared SRLG of this TPE .
        externalFgiSpecsRefList:
          type: array
          items:
            type: string
          description: List of External Forwarding Group assignments.
        ethernetSegment:
          $ref: '#/components/schemas/EthernetSegmentRO'
        evpn:
          $ref: '#/components/schemas/EvpnRO'
    TpeCfmPackageRO:
      title: TpeCfmPackageRO
      type: object
      properties:
        cfmServiceName:
          type: string
          description: The name of the CFM service
        mep:
          type: array
          items:
            $ref: '#/components/schemas/MepEntryRO'
          description: Each entry holds information about one Maintenance Endpoint configured on this TPE
    TpeDataRO:
      title: TpeDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the TPE resource
        type:
          $ref: '#/components/schemas/Type46'
        attributes:
          $ref: '#/components/schemas/TpeAttributesRO'
        relationships:
          $ref: '#/components/schemas/TpeRelationshipsRO'
    TpeDisplayDataRO:
      title: TpeDisplayDataRO
      type: object
      properties:
        displayNativeName:
          type: string
          description: The name of the TPE that we want UI to display if it is different than nativeName
    TpeListRO:
      title: TpeListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/TpeDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Referenced sub-resources
    TpeRelationshipsRO:
      title: TpeRelationshipsRO
      type: object
      properties:
        tpePlanned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        tpeExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        tpeDiscovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstructAssociation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipment:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        owningServerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        clientTpes:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        owningServerTpeList:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        owningPeerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        ownedPeerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partnerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        owningClientTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        controller:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        configurationAndSwitchControl:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    TpeResiliencyPackageRO:
      title: TpeResiliencyPackageRO
      type: object
      properties:
        role:
          $ref: '#/components/schemas/Role13'
        resiliencyType:
          $ref: '#/components/schemas/ResiliencyType'
    TrafficProfileParamRO:
      title: TrafficProfileParamRO
      type: object
      properties:
        name:
          type: string
          description: Name of attribute.
        value:
          type: string
          description: Value of attribute.
        selectFrom:
          type: array
          items:
            type: string
          description: Alternate form of value attribute that permits a comma separated list of the choices available for selection.
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        location:
          $ref: '#/components/schemas/Location1'
    TrafficProfileRO:
      title: TrafficProfileRO
      type: object
      properties:
        inputParams:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfileParamRO'
          description: List of input parameters to be matched to derive the correct trafficProfile for the use-case.
        trafficParams:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfileParamRO'
          description: List of traffic parameters that must be used as input in the use-case.
        routeConstraints:
          $ref: '#/components/schemas/RouteConstraintsRO'
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/TrafficProfileParamRO'
          description: List of outputs that are expected in the use-case.
    TransformTypesRO:
      title: TransformTypesRO
      type: object
      properties:
        ingress:
          $ref: '#/components/schemas/L2TransformRO'
        egress:
          $ref: '#/components/schemas/L2TransformRO'
    TransportPolicyRO:
      title: TransportPolicyRO
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type39'
        srPolicies:
          type: array
          items:
            $ref: '#/components/schemas/SrPolicyRO'
          description: Segment Routing policy details
    TtiAttributeRO:
      title: TtiAttributeRO
      type: object
      properties:
        sapi:
          type: string
          description: String to hold 'sapi' attribute
        dapi:
          type: string
          description: String to hold 'dapi' attribute
        operator:
          type: string
          description: String to hold 'operator' attribute
    TtiPackageRO:
      title: TtiPackageRO
      type: object
      properties:
        ttiTx:
          $ref: '#/components/schemas/TtiAttributeRO'
        ttiRx:
          $ref: '#/components/schemas/TtiAttributeRO'
        ttiExpectedRx:
          $ref: '#/components/schemas/TtiAttributeRO'
        traceFailedMode:
          $ref: '#/components/schemas/TraceFailedMode'
    TunnelPathRO:
      title: TunnelPathRO
      type: object
      properties:
        pathName:
          type: string
          description: The name of this explicit tunnel path
        hops:
          type: array
          items:
            $ref: '#/components/schemas/HopEntryRO'
          description: ''
    TxInfoRO:
      title: TxInfoRO
      type: object
      properties:
        dropPort:
          type: string
          description: dropPort Info
        transMode:
          type: string
          description: transMode Info
        frequency:
          type: string
          description: frequency Info
        minDispersion:
          type: string
          description: minDispersion Info
        maxDispersion:
          type: string
          description: maxDispersion Info
        lowFrequencyGuardband:
          type: string
          description: lowFrequencyGuardband Info
        highFrequencyGuardband:
          type: string
          description: highFrequencyGuardband Info
        expectedRestorationTime:
          type: string
          description: expectedRestorationTime Info
        linkOptimizationMode:
          type: string
          description: linkOptimizationMode Info
        egressRegenPort:
          type: string
          description: egressRegenPort Info
    UserConstraintsRO:
      title: UserConstraintsRO
      type: object
      properties:
        name:
          type: string
          description: Service Catalog Name
        description:
          type: string
          description: Service Catalog Description
        servicePriority:
          $ref: '#/components/schemas/ServicePriorityRO'
        optimizationAlgorithmMetric:
          $ref: '#/components/schemas/OptimizationAlgorithmMetric'
        additionalConstraints:
          $ref: '#/components/schemas/SRServiceCatalogAdditionalConstraintsRO'
    UtilizationDataRO:
      title: UtilizationDataRO
      type: object
      properties:
        totalCapacity:
          type: string
          description: Utilization total capacity
        overrideTotalCapacity:
          type: string
          description: Utilization total capacity override - User entered REST API value
        calculatedTotalCapacity:
          type: string
          description: Utilization total capacity - MCP calculated value
        usedCapacity:
          type: string
          description: Utilization used capacity
        utilizationPercent:
          type: string
          description: Utilization percentage of total capacity that is used
        capacityUnits:
          type: string
          description: Units of the capacity information
    VirtualTpeBWConstraintsRO:
      title: VirtualTpeBWConstraintsRO
      type: object
      properties:
        id:
          type: string
        owningPoolAdapterType:
          type: string
        unitsToConsume:
          type: string
        adaptsToLayerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        isFre:
          type: boolean
          default: false
    VpnPackageRO:
      title: VpnPackageRO
      type: object
      properties:
        misconfigured:
          type: boolean
          description: true/false
          default: false
        eviCount:
          type: integer
          description: Evi Count of Evpn
          format: int32
        esiCount:
          type: integer
          description: Esi Count of Evpn
          format: int32
        peCount:
          type: integer
          description: Pe Count of Evpn
          format: int32
        endPointCount:
          type: integer
          description: EndPoint Count of Evpn
          format: int32
        rtCount:
          type: integer
          description: RT count inside EVPN.
          format: int32
        rdCount:
          type: integer
          description: RD count inside EVPN.
          format: int32
        rtList:
          type: array
          items:
            type: string
          description: Set of RT list associated with EVPN
        rdList:
          type: array
          items:
            type: string
          description: Set of RD List associated with EVPN
        transportPolicy:
          $ref: '#/components/schemas/TransportPolicyRO'
    Y1731AttributesRO:
      title: Y1731AttributesRO
      type: object
      properties:
        enabled:
          type: boolean
          description: True when the particular measurement is enabled
          default: false
        mode:
          $ref: '#/components/schemas/Mode'
        interval:
          type: string
          description: 'The interval between transmitting each message (e.g.: 1)'
        intervalUnit:
          type: string
          description: 'The unit of interval between transmitting each message (e.g.: seconds)'
        priority:
          type: string
          description: The priority of the messages being transmitted (0-7)
        frameSize:
          type: string
          description: The frame size of the messages being transmitted (numeric), if applicable to this measurement
        repeatDelay:
          type: integer
          description: The repeat delay of the message being transmitted
          format: int32
        count:
          type: integer
          description: The count of the message being transmitted
          format: int32
        iterate:
          type: integer
          description: The iteration number of the message being transmitted
          format: int32
        remoteMepId:
          type: string
          description: The ID of the remote MEP
        remoteMepMacAddress:
          type: string
          description: The MAC address of the remote MEP
        thresholdProfile:
          type: string
          description: The name of the thresh-hold profile to be used
        accelerate:
          type: boolean
          description: To create accelerated sessions
          default: false
        storedIntervalCount:
          type: integer
          description: Determines session history size (0-96)
          format: int32
        testId:
          type: integer
          description: The ID of the test
          format: int32
        sessionId:
          type: integer
          description: The ID of the test session
          format: int32
        cosMode:
          type: boolean
          description: To enable cos-mode on session
          default: false
        delayBins:
          type: string
          description: The name of the delay bin profile
        delayRangeBins:
          type: string
          description: The name of the delay range bin profile
        ifdvBins:
          type: string
          description: The name of the jitter bin profile
        alignMeasurementInterval:
          type: boolean
          description: Allows measurement intervals to be aligned with the hour on a time-of-day clock
          default: false
        forwardIfdvBins:
          type: string
          description: The name of the forward jitter bin profile
        backwardIfdvBins:
          type: string
          description: The name of the backward jitter bin profile
        measurementInterval:
          type: integer
          description: Discrete interval of time over which a set of PM statistics are calculated and stored
          format: int32
        alignMeasurementOffset:
          type: integer
          description: Allows measurement intervals to be offset a number of minutes from the hour when Align Measurement Intervals is in effect (0-60)
          format: int32
        availConsecutiveHighFlr:
          type: integer
          description: (1-1000)
          format: int32
        availConsecutiveIntervals:
          type: integer
          description: (1-1000)
          format: int32
        availFlrThreshold:
          type: integer
          description: (0-100000 millipercent)
          format: int32
        availConsecutivePduCount:
          type: integer
          description: (10-1000000)
          format: int32
        availMeasurementInterval:
          type: integer
          description: (0-43200 minutes)
          format: int32
        messagePeriod:
          type: integer
          description: 'The interval between message transmission (e.g.: 1)'
          format: int32
        messagePeriodUnit:
          type: string
          description: 'The unit of interval between transmitting each message (e.g.: seconds)'
        repetitionTime:
          type: integer
          description: The period of time between the start of subsequent measurement intervals.
          format: int32
    eDtlRegenIdPackageRO:
      title: eDtlRegenIdPackageRO
      type: object
      properties:
        regenPhotonicAddDropTid:
          type: string
          description: Regen Photonic ID TID
        nearPhotonicTxAddDrop:
          type: string
          description: near Photonic Tx Add Drop Shelf SLot Port
    socketClient:
      title: socketClient
      type: object
      properties:
        consumerGroup:
          type: string
        ip:
          type: string
          description: The address of the machine connected to the socket
        username:
          type: string
    CursorListRO:
      title: CursorListRO
      type: object
      properties:
        links:
          type: object
          additionalProperties:
            type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/DataROReturnable'
          description: ''
        meta:
          type: object
          additionalProperties:
            type: object
    DataROReturnable:
      title: DataROReturnable
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        attributes:
          $ref: '#/components/schemas/Returnable'
    FeatureResponseInterface:
      title: FeatureResponseInterface
      type: object
      properties:
        responseId:
          type: string
        expiry:
          type: string
          description: expiry
          format: date-time
        commonName:
          type: string
          description: commonName
        permanent:
          type: boolean
          description: permanent
          default: false
        featureName:
          type: string
          description: featureName
        licensed:
          type: boolean
          description: licensed
          default: false
          readOnly: true
        message:
          type: string
          description: message
    File:
      title: File
      type: object
      properties:
        path:
          type: string
        name:
          type: string
        parent:
          type: string
        absolute:
          type: boolean
          default: false
        canonicalPath:
          type: string
        parentFile:
          $ref: '#/components/schemas/File'
        absolutePath:
          type: string
        absoluteFile:
          $ref: '#/components/schemas/File'
        canonicalFile:
          $ref: '#/components/schemas/File'
        directory:
          type: boolean
          default: false
        file:
          type: boolean
          default: false
        hidden:
          type: boolean
          default: false
        totalSpace:
          type: integer
          format: int64
        freeSpace:
          type: integer
          format: int64
        usableSpace:
          type: integer
          format: int64
    LicenseServerStatusInterface:
      title: LicenseServerStatusInterface
      type: object
      properties:
        ip:
          type: string
        status:
          $ref: '#/components/schemas/Status2'
    LicenseSiteStatusInterface:
      title: LicenseSiteStatusInterface
      type: object
      properties:
        licenseServers:
          type: array
          items:
            $ref: '#/components/schemas/LicenseServerStatusInterface'
          description: ''
        siteIP:
          type: string
        state:
          $ref: '#/components/schemas/State10'
    Report:
      title: Report
      type: object
      properties:
        name:
          type: string
        message:
          type: string
        status:
          $ref: '#/components/schemas/Status3'
        criticalAlarmCount:
          type: integer
          format: int32
        majorAlarmCount:
          type: integer
          format: int32
        minorAlarmCount:
          type: integer
          format: int32
        warnAlarmCount:
          type: integer
          format: int32
        totalFeatures:
          type: integer
          format: int32
        totalClients:
          type: integer
          format: int32
        includeArrears:
          type: boolean
          default: false
        captureSiteId:
          type: string
        grSync:
          type: boolean
          default: false
        reportId:
          type: integer
          format: int32
        reportDate:
          type: string
          readOnly: true
    ReportRequestObject:
      title: ReportRequestObject
      type: object
      properties:
        name:
          type: string
    ReportRequestRO:
      title: ReportRequestRO
      type: object
      properties:
        message:
          type: string
        reportId:
          type: integer
          format: int32
        reportName:
          type: string
      description: The information regarding the request of a report
    ResponseListRO:
      title: ResponseListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DataROReturnable'
          description: data
    Returnable:
      title: Returnable
      type: object
      properties:
        responseId:
          type: string
        type:
          type: string
    StatusAttributes:
      title: StatusAttributes
      type: object
      properties:
        sites:
          type: array
          items:
            $ref: '#/components/schemas/LicenseSiteStatusInterface'
          description: ''
    StatusData:
      title: StatusData
      type: object
      properties:
        id:
          type: integer
          format: int32
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/StatusAttributes'
    StatusRO:
      title: StatusRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/StatusData'
      description: The status of the licensing service
    UpdateRO:
      title: UpdateRO
      type: object
      properties:
        status:
          type: integer
          format: int32
        message:
          type: string
    ListReply6:
      title: ListReply6
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ClaimedJob'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    RelationshipSetting:
      title: RelationshipSetting
      type: object
      properties:
        sourceTypeId:
          type: string
          description: Resource type of the relationship source
        targetTypeId:
          type: string
          description: Resource type of the relationship target
        capabilityName:
          type: string
          description: Identifies the relationship capability name
        requirementName:
          type: string
          description: Identifies the relationship requirement name
        relationshipTypeId:
          type: string
          description: Identifies the relationship type
        fieldKind:
          $ref: '#/components/schemas/FieldKind'
        fieldLocator:
          type: string
          description: JSON path expression identifying the property field to use for relationship identification
        multiFieldLocator:
          type: array
          items:
            type: string
          description: Multiple JSON path expresssion to be used identifying property fields to use in relationship identification
        isDomainMangled:
          type: boolean
          description: Whether the remote providerResourceId specified in this property is domain-mangled when receiving from and sending to the provider
        translate:
          type: boolean
          description: Whether translation between providerResourceIds and Market Ids should be done
        namespaceProperty:
          type: string
          description: JSON path expression identifying the property field to be prepended to each field locator value
      description: Settings to declare how relationships can be identified between two resource types
    AddResourcesToSubDomainReport:
      title: AddResourcesToSubDomainReport
      required:
      - message
      - resourcesAdded
      type: object
      properties:
        message:
          type: string
        resourcesAdded:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    Address:
      title: Address
      type: object
      properties:
        city:
          type: string
          description: City
        zip:
          type: string
          description: Postal/zip code
        street:
          type: string
          description: Street
        state:
          type: string
          description: State/province
        country:
          type: string
          description: Country
        latitude:
          type: number
          description: Latitude
        longitude:
          type: number
          description: Longitude
      description: Represents a physical location/address
    ListReply7:
      title: ListReply7
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Domain'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    Product:
      title: Product
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the product (ignored during create request)
        resourceTypeId:
          type: string
          description: The type of resource provided by the product
        title:
          type: string
          description: Name or title describing the product
        description:
          type: string
          description: Detailed description of the product
        active:
          type: boolean
          description: State of the product (active or inactive)
        domainId:
          type: string
          description: Identifier of the domain that advertises the product
        providerProductId:
          type: string
          description: Identifier within the provider's context or scope for the product
        constraints:
          $ref: '#/components/schemas/JObject'
        providerData:
          $ref: '#/components/schemas/JObject'
      description: Information describing a product
    ListReply8:
      title: ListReply8
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/UnclaimedJob'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    TypeLayerCurrentReply:
      title: TypeLayerCurrentReply
      type: object
      properties:
        current:
          type: boolean
          description: Is the Type Catalog current?
        version:
          type: string
          description: Type Catalog version
        headCommit:
          type: string
          description: Asset Area head commit
      description: Version values used to determine if the Type Catalog is current with respect to the Asset Area
    PutResourceProp:
      title: PutResourceProp
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
      description: Information describing a resource PUT request
    ValidateDefinitionRealmReply:
      title: ValidateDefinitionRealmReply
      type: object
      properties:
        description:
          type: string
          description: Human readable description of what is wrong with the model
        issues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          description: Specific issues which caused validation to fail
    DiscoveryStrategy:
      title: DiscoveryStrategy
      type: object
      properties:
        strategyType:
          $ref: '#/components/schemas/StrategyType'
        pollingMode:
          $ref: '#/components/schemas/PollingMode'
        pollingSettings:
          $ref: '#/components/schemas/PollingSettings'
      description: Settings to declare how resource type discovery should be performed
    SubDomain:
      title: SubDomain
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the sub-domain
          format: uuid
        name:
          type: string
          description: Name of the sub-domain
        description:
          type: string
          description: Description of the sub-domain
        ownerTenantId:
          type: string
          description: The ID of the owner tenant
        domainId:
          type: string
          description: ID of the domain this sub-domain belongs to
        scope:
          $ref: '#/components/schemas/Scope1'
        decomposable:
          type: boolean
          description: Whether the sub-domain can be decomposed
        assignable:
          type: boolean
          description: Whether the sub-domain can be re-assigned
        applicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices this sub-domain is in
        extendedApplicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices for which this sub-domain acts as an extended sub-domain
        parentId:
          type: string
          description: The ID of the container sub-domain, if applicable
          format: uuid
        isDefault:
          type: boolean
          description: Whether this sub-domain is its domain's default sub-domain
      description: Information describing a sub-domain
    ListReply9:
      title: ListReply9
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResourceTypeDigest'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply10:
      title: ListReply10
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ResourceSubDomainInfo:
      title: ResourceSubDomainInfo
      type: object
      properties:
        subDomainId:
          type: string
          description: The ID of the sub-domain
          format: uuid
      description: Information describing a sub-domain for a resource to assign to
    DomainType:
      title: DomainType
      type: object
      properties:
        name:
          type: string
          description: Name for the domain type
        description:
          type: string
          description: Description of a domain type
        providers:
          type: array
          items:
            type: string
          description: Providers for this domain type
      description: Defines a the type of a domain
    TypeArtifactDefinition:
      title: TypeArtifactDefinition
      type: object
      properties:
        id:
          type: string
          description: Uniquely identifier of artifact
        title:
          type: string
          description: Title (label) of the artifact
        artifactType:
          type: string
          description: Type of the artifact
        description:
          type: string
          description: Description of the artifact
        version:
          type: string
          description: Version level of the artifact
        derivedFrom:
          type: array
          items:
            type: string
          description: URI of model artifacts from which this artifact is derived from
        experimental:
          type: boolean
          description: Experimental type artifact
        model:
          $ref: '#/components/schemas/JObject'
      description: Information describing a single type artifact
    ListReply11:
      title: ListReply11
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Product'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ResyncReplyItem:
      title: ResyncReplyItem
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code for the item
          format: int32
        message:
          type: string
          description: Message of the item
        source:
          type: string
          description: Source that produced the item
        properties:
          $ref: '#/components/schemas/JObject'
      description: Information describing an item of a resync request reply
    JobClaim:
      title: JobClaim
      type: object
      properties:
        executorUrl:
          type: string
          description: URL that implements the Executor API for this job
        capabilities:
          type: array
          items:
            type: string
          description: Array of strings that expresses the capabilities supported by the job executor
      description: Job claim
    ClaimedJob:
      title: ClaimedJob
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the job
          format: uuid
        type:
          $ref: '#/components/schemas/Type47'
        state:
          $ref: '#/components/schemas/State11'
        resourceId:
          type: string
          description: Resource Id
        operationId:
          type: string
          description: Operation Id
        operation:
          type: string
          description: Operation
        createdAt:
          type: string
          description: When the job was created
          format: date-time
        claimedAt:
          type: string
          description: When the job was claimed
          format: date-time
        executorUrl:
          type: string
          description: Job executor
      description: A digest version of the Job entity for executing jobs
    ResourceProvider:
      title: ResourceProvider
      type: object
      properties:
        id:
          type: string
          description: Unique identifier to address the resource provider
        domainType:
          type: string
          description: Type of domain managed by the resource provider
        uri:
          type: string
          description: Address to contact the resource provider
        resourceTypes:
          type: array
          items:
            $ref: '#/components/schemas/ResourceTypeSetting'
          description: List of resource types managed by the resource provider
        domainSettings:
          $ref: '#/components/schemas/DomainSettings2'
        properties:
          $ref: '#/components/schemas/JObject'
        title:
          type: string
          description: Name of the resource provider
        description:
          type: string
          description: Description of the resource provider
        providerId:
          type: string
          description: Identifier of the resource provider in provider's context
        protocolVersion:
          $ref: '#/components/schemas/ProtocolVersion2'
        asyncProtocolVersion:
          $ref: '#/components/schemas/AsyncProtocolVersion'
        relationships:
          type: array
          items:
            $ref: '#/components/schemas/RelationshipSetting'
          description: Settings to declare how relationships should be identified for resource types managed by this resource provider
        lastUpsertTime:
          type: string
          description: Last time the resource provider is upserted in the database
          format: date-time
      description: Information describing a resource provider
    AuditReply:
      title: AuditReply
      type: object
      properties:
        message:
          type: string
          description: Message of the item
      description: Information describing an item of a audit request reply
    Job:
      title: Job
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the job
          format: uuid
        resourceId:
          type: string
          description: Resource identifier
        operationId:
          type: string
          description: Operation identifier
        operation:
          type: string
          description: Name of the operation, normally the interface name for custom operations and 'activate', 'terminate', or 'update' for lifecycle operations.
        state:
          $ref: '#/components/schemas/State11'
        type:
          type: string
          description: Type of job
        typeParams:
          $ref: '#/components/schemas/JObject'
        createdAt:
          type: string
          description: Time of creation
          format: date-time
        claimedAt:
          type: string
          description: Time when the job was claimed
          format: date-time
        completedAt:
          type: string
          description: Time when the job was completed
          format: date-time
        idempotencyKey:
          type: string
          description: Idempotent job claim key
        executorUrl:
          type: string
          description: Job executor
        capabilities:
          type: array
          items:
            type: string
          description: Supported capabilities
        traceId:
          type: string
          description: Trace identifier
          format: uuid
        upstreamId:
          type: string
          description: Upstream identifier
          format: uuid
        userId:
          type: string
          description: User identifier
          format: uuid
        tenantId:
          type: string
          description: Tenant identifier
          format: uuid
        roleIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Role identifiers
        partitionIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Partition identifiers
        subdomainIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Subdomain identifiers
        typeLayerVersion:
          type: string
          description: Version of the Market type realm in effect at the time of operation execution
        jobParams:
          $ref: '#/components/schemas/JObject'
      description: Job entity tracking the execution of a resource operation
    ListReply12:
      title: ListReply12
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SharingPermission'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    DomainProps:
      title: DomainProps
      type: object
      properties:
        title:
          type: string
          description: Descriptive name/title of domain
        description:
          type: string
          description: Detailed description
        accessUrl:
          type: string
          description: Access URL to the domain
        properties:
          $ref: '#/components/schemas/JObject'
        address:
          $ref: '#/components/schemas/Address1'
        rpId:
          type: string
          description: Resource provider managing this domain
        operationMode:
          $ref: '#/components/schemas/OperationMode'
        tenantId:
          type: string
          description: Orchestrator tenant ID for the domain owner (if unspecified defaults to requester)
        onlyEnableTypes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: When non-empty, only enable these resource types in the domain
      description: Properties for creating a domain
    CheckJobStatusResponse:
      title: CheckJobStatusResponse
      type: object
      properties:
        httpStatus:
          type: integer
          description: Status code returned from executorURL
          format: int32
        executorUrl:
          type: string
          description: Original executorURL from Job
        state:
          type: string
          description: State from executorURL or None
      description: Response for CheckJob
    SharingPermissionProp:
      title: SharingPermissionProp
      type: object
      properties:
        id:
          type: string
          description: Unique id of the permission
        label:
          type: string
          description: Label of the permission
        description:
          type: string
          description: Description of the permission
        visibleToSubTenants:
          type: boolean
          description: Whether subject is visible to subtenants if shared
        updatableBySubTenants:
          type: boolean
          description: Whether subject is updatable by subtenants if shared
        deletableBySubTenants:
          type: boolean
          description: Whether subject is deletable by subtenants if shared
      description: Properties for creating a sharing permission
    ListReply13:
      title: ListReply13
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Relationship'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply14:
      title: ListReply14
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TagKey'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ResyncRequestScope:
      title: ResyncRequestScope
      required:
      - domainId
      type: object
      properties:
        domainId:
          type: string
        resourceTypeId:
          type: string
        providerResourceId:
          type: string
      description: Information describing the status of a resync request
    TypeArtifactDigest:
      title: TypeArtifactDigest
      type: object
      properties:
        id:
          type: string
          description: Uniquely identifier of artifact
        title:
          type: string
          description: Title (label) of the artifact
        artifactType:
          type: string
          description: Type of the artifact
        description:
          type: string
          description: Description of the artifact
        version:
          type: string
          description: Version level of the artifact
        derivedFrom:
          type: array
          items:
            type: string
          description: URI of model artifacts from which this artifact is derived from
        experimental:
          type: boolean
          description: Experimental type artifact
      description: Information describing a single type artifact
    ResourceInterface:
      title: ResourceInterface
      type: object
      properties:
        id:
          type: string
          description: Interface identifier
        title:
          type: string
          description: Title of the resource interface
        description:
          type: string
          description: Description of the resource interface
        inputs:
          $ref: '#/components/schemas/JObject'
        outputs:
          $ref: '#/components/schemas/JObject'
        executionGroup:
          type: string
          description: The execution group this interface will use
        internalOnly:
          type: boolean
          description: Whether the interface is for internal use only
      description: Information describing a resource operation interface
    UnresolvedRelationship:
      title: UnresolvedRelationship
      type: object
      properties:
        id:
          type: string
          description: The id of the unresolved relationship
          format: uuid
        resourceId:
          type: string
          description: The id of the resource where the unresolved locator id is defined
        mangledProviderId:
          type: string
          description: The unresolved domain-mangled providerResourceId for the relationship
        requirement:
          type: string
          description: Identifies the relationship requirement name
        capability:
          type: string
          description: Identifies the relationship capability name
        relationshipTypeId:
          type: string
          description: Identifies the relationship type ID
        isTarget:
          type: boolean
          description: Is the unresolved locator the targetId of the relationship
        isDomainMangled:
          type: number
          description: Should the translated locator be written back to the resource in domain-mangled form
        locatorPath:
          type: string
          description: The locator path of the relationship setting, used for writing the translated property back
        index:
          type: number
          description: The index of the locator in an array, used for writing the translated property back
      description: Description of an unresolved relationship
    JobExecutionResult:
      title: JobExecutionResult
      type: object
      properties:
        _type:
          $ref: '#/components/schemas/Type48'
        result:
          $ref: '#/components/schemas/JObject'
        reason:
          type: string
          description: For JobFailure, a String description of the failure
      description: Job execution result
    ListReply15:
      title: ListReply15
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TagValue'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply16:
      title: ListReply16
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationSlice'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ResourceHistoryEvent:
      title: ResourceHistoryEvent
      type: object
      properties:
        time:
          type: string
          description: The timestamp of the transaction making the change
          format: date-time
        userId:
          type: string
          description: The ID of the user making the change
        changes:
          type: array
          items:
            $ref: '#/components/schemas/AttributeChange'
          description: The set of attributes changed on the resource
      description: Description of all changes made to a resource at a single time instant or transaction
    ResourceTypeSetting:
      title: ResourceTypeSetting
      type: object
      properties:
        id:
          type: string
          description: Identifies the resource type
        discoveryStrategy:
          $ref: '#/components/schemas/DiscoveryStrategy1'
        apiSettings:
          $ref: '#/components/schemas/ApiSettings'
        noInitialDiscoveryMarkers:
          type: number
          description: Specifies if initial discovery status for this resource type should be ignored
        updateCompleteOnPutReturn:
          type: number
          description: Specifies if a PUT update response signals update completion for this resource type
        updateCompletionTimeoutMs:
          type: number
          description: Timeout in milliseconds for an update on a resource to be force completed by RA Manager. If `updateCompleteOnPutReturn` is true, then this timeout has no effect.
      description: Settings to declare how resource types should be managed by adapters
    ResourceTypeDigest:
      title: ResourceTypeDigest
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the resource type
        title:
          type: string
          description: Resource type name
        description:
          type: string
          description: Resource type description
        version:
          type: string
          description: Resource type version identifier
        derivedFrom:
          type: array
          items:
            type: string
          description: URI of model artifacts from which this artifact is derived from
        experimental:
          type: boolean
          description: Experimental type artifact
        abstract:
          type: boolean
          description: Abstract type artifact
      description: Meta-information describing a resource type
    ValidationReport:
      title: ValidationReport
      type: object
      properties:
        state:
          $ref: '#/components/schemas/State13'
        results:
          type: array
          items:
            $ref: '#/components/schemas/ValidationItem'
          description: List of validation results
      description: A report for the processing results of a resource validation request
    AttributeChange:
      title: AttributeChange
      type: object
      properties:
        attrName:
          type: string
          description: Name of the attribute that was changed
        changeType:
          $ref: '#/components/schemas/ChangeType'
        migration:
          type: boolean
          description: Indicates whether the change was part of a migration
        newValue:
          type: object
        oldValue:
          type: object
      description: Description of a single attribute change
    PollingStrategySettings:
      title: PollingStrategySettings
      type: object
      properties:
        pollingIntervalMs:
          type: integer
          description: Polling interval in milliseconds
          format: int64
        immediateDeletion:
          type: boolean
          description: Whether the deletion is considered done when the API returns
        deletePollingIntervalMs:
          type: integer
          description: Polling interval for delete verification
          format: int64
        deletePollingLimit:
          type: integer
          description: Maximum number of delete verification polling
          format: int32
        delayCreateTimeoutMs:
          type: integer
          description: Timeout value for a delayed creation to be considered failed
          format: int64
        syncTimeoutMs:
          type: integer
          description: Timeout for sync and queries
          format: int64
        verifyMissingList:
          type: boolean
          description: Whether an extra GET will be called to verify a missing resource in LIST
      description: Detailed settings on resource polling strategy
    UpdateApplicationSliceSubDomainsReport:
      title: UpdateApplicationSliceSubDomainsReport
      required:
      - message
      - subdomains
      type: object
      properties:
        message:
          type: string
        subdomains:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: ''
    Domain:
      title: Domain
      type: object
      properties:
        id:
          type: string
          description: Unique id of the domain
        title:
          type: string
          description: Descriptive name/title of domain
        description:
          type: string
          description: Detailed description
        domainType:
          type: string
          description: Type of the domain
        accessUrl:
          type: string
          description: Access URL to the domain
        properties:
          $ref: '#/components/schemas/JObject'
        address:
          $ref: '#/components/schemas/Address1'
        tenantId:
          type: string
          description: Orchestrator tenant
        rpId:
          type: string
          description: Resource provider that creates this domain
        operationMode:
          $ref: '#/components/schemas/OperationMode'
        lastConnected:
          type: string
          description: Last time domain was connected to southbound
          format: date-time
        reason:
          type: string
          description: Reason message for connection failure
        connectionStatus:
          type: object
        initialDiscoveryStatus:
          type: object
        onlyEnableTypes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: When non-empty, only enable these resource types in the domain
      description: Represents an autonomous domain provider
    JArray:
      title: JArray
      required:
      - arr
      type: object
      properties:
        arr:
          type: array
          items:
            type: object
          description: ''
    JobProgress:
      title: JobProgress
      type: object
      properties:
        progress:
          type: object
      description: Job progress
    DiscoveryApiSettings:
      title: DiscoveryApiSettings
      type: object
      properties:
        serverTimeoutMs:
          type: integer
          description: Timeout for HTTP client when connecting to a server
          format: int64
        maxConnections:
          type: integer
          description: Maximum concurrent http connections
          format: int32
        maxHttpRetries:
          type: integer
          description: Maximum retries when an http request fails
          format: int32
        maxRedirections:
          type: integer
          description: Maximum redirections for http request
          format: int32
        idleTimeoutMs:
          type: integer
          description: Time to keep an idle connection open before disconnecting it
          format: int64
      description: Settings on API client for resource discovery
    SubDomainResourceSet:
      title: SubDomainResourceSet
      required:
      - resources
      type: object
      properties:
        resources:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    ApplicationSliceProp:
      title: ApplicationSliceProp
      type: object
      properties:
        name:
          type: string
          description: Name of the application slice
        description:
          type: string
          description: Description of the application slice
        extendable:
          type: boolean
          description: Whether the application slice is extendable
        holderTenantId:
          type: string
          description: The id of the tenant holding the slice
        ownerTenantId:
          type: string
          description: The id of the tenant owning the slice
        parentId:
          type: string
          description: The id of the parent application slice
          format: uuid
        isDefault:
          type: boolean
          description: Whether the application slice is the default slice of the owner tenant
        requiredAppSlicesIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Application slices this slice depends on
        sliceRole:
          type: object
      description: Information describing a to-be-created application slice
    ListReply17:
      title: ListReply17
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TypeArtifactDigest'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    DomainSettings:
      title: DomainSettings
      type: object
      properties:
        connection_status:
          type: boolean
          description: Specifies if maintenance of domain's connection status is supported
        initial_discovery_status:
          type: boolean
          description: Specifies if maintenance of domain's initial discovery status is supported
        metaInfoDiscoveryStrategy:
          type: object
        minInterUpsertIntervalMs:
          type: number
          description: Specifies the minimal inter-call interval bpocore should honor when upserting the Domain
        rpType:
          type: object
        asyncDeviceTypes:
          type: array
          items:
            type: string
          description: Specifies the Resource Type IDs that use async discovery strategy
      description: Settings to declare how domain should be managed
    Tuple2StringJValue:
      title: Tuple2StringJValue
      required:
      - _1
      - _2
      type: object
      properties:
        _1:
          type: string
        _2:
          type: object
    ResourceProp:
      title: ResourceProp
      type: object
      properties:
        productId:
          type: string
          description: The type of product for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission of the resource
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        providerData:
          $ref: '#/components/schemas/JObject'
        subDomainId:
          type: string
          description: Sub-domain ID
          format: uuid
      description: Information describing a resource creation request
    Tenant:
      title: Tenant
      required:
      - id
      - isMaster
      type: object
      properties:
        id:
          type: string
        parent:
          type: string
        isMaster:
          type: boolean
      description: Information describing a tenant
    AppSliceSubDomains:
      title: AppSliceSubDomains
      required:
      - subDomains
      type: object
      properties:
        subDomains:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    ListReply18:
      title: ListReply18
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/UnresolvedRelationship'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    TagKey:
      title: TagKey
      type: object
      properties:
        key:
          type: string
          description: Tag key
        description:
          type: string
          description: Textual description of tag key
        autoIndexed:
          type: boolean
          description: Are tag value for this key auto-indexed?
      description: Tag key with description
    ValidationItem:
      title: ValidationItem
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code for the result
          format: int32
        pointer:
          type: string
          description: JSON pointer to the source of the issue
        detail:
          type: string
          description: Detailed description of the validation
        validator:
          type: string
          description: Validator that produced the status
    JObject:
      title: JObject
      required:
      - obj
      type: object
      properties:
        obj:
          type: array
          items:
            $ref: '#/components/schemas/Tuple2StringJValue'
          description: ''
    TagValue:
      title: TagValue
      type: object
      properties:
        value:
          type: string
          description: Tag value
        key:
          type: string
          description: Tag key
        description:
          type: string
          description: Description of the meaning of a tag value
      description: Tag value with description
    JobSuspension:
      title: JobSuspension
      type: object
      properties:
        suspended:
          type: boolean
          description: Job suspension state
      description: Job suspension
    UnclaimedJob:
      title: UnclaimedJob
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the job
          format: uuid
        traceId:
          type: string
          description: Trace identifier
          format: uuid
        upstreamId:
          type: string
          description: Upstream identifier
          format: uuid
      description: A digest version of the Job entity for unclaimed jobs
    SharingPermission:
      title: SharingPermission
      type: object
      properties:
        id:
          type: string
          description: Unique id of the permission
        label:
          type: string
          description: Label of the permission
        description:
          type: string
          description: Description of the permission
        visibleToSubTenants:
          type: boolean
          description: Whether subject is visible to subtenants if shared
        updatableBySubTenants:
          type: boolean
          description: Whether subject is updatable by subtenants if shared
        deletableBySubTenants:
          type: boolean
          description: Whether subject is deletable by subtenants if shared
        isBuiltIn:
          type: boolean
          description: Whether this is a built-in permission
      description: Information describing a sharing permission
    ApplicationSlice:
      title: ApplicationSlice
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the application slice
          format: uuid
        name:
          type: string
          description: Name of the application slice
        description:
          type: string
          description: Description of the application slice
        extendable:
          type: boolean
          description: Whether the application slice is extendable
        holderTenantId:
          type: string
          description: The id of the tenant holding the slice
        ownerTenantId:
          type: string
          description: The id of the tenant owning the slice
        parentId:
          type: string
          description: The id of the parent application slice
          format: uuid
        isDefault:
          type: boolean
          description: Whether the application slice is the default slice of the owner tenant
        requiredAppSlicesIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Application slices this slice depends on
        sliceRole:
          type: object
      description: Information describing an application slice
    RelationshipProp:
      title: RelationshipProp
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the relationship (optional/ignored on calls to create)
        relationshipTypeId:
          type: string
          description: URI of relationship type
        properties:
          $ref: '#/components/schemas/JObject'
        sourceId:
          type: string
          description: UUID of source resource
        requirementName:
          type: string
          description: Requirement name in source resource
        targetId:
          type: string
          description: UUID of target resource
        capabilityName:
          type: string
          description: Capability name in target resource
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        providerData:
          $ref: '#/components/schemas/JObject'
      description: Information describing a relationship to create
    SubDomainProp:
      title: SubDomainProp
      type: object
      properties:
        name:
          type: string
          description: Name of the sub-domain
        description:
          type: string
          description: Description of the sub-domain
        domainId:
          type: string
          description: ID of the domain this sub-domain belongs to
        scope:
          $ref: '#/components/schemas/Scope1'
        decomposable:
          type: boolean
          description: Whether the sub-domain can be decomposped
        assignable:
          type: boolean
          description: Whether the sub-domain can be re-assigned
        applicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices this sub-domain is in
        extendedApplicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices for which this sub-domain acts as an extended sub-domain
        parentId:
          type: string
          description: The ID of the container sub-domain, if applicable
          format: uuid
      description: Information describing a to-be-created sub-domain
    MarkerResyncScopeFilter:
      title: MarkerResyncScopeFilter
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            type: string
      description: Marker Filter Data
    ResyncReply:
      title: ResyncReply
      type: object
      properties:
        id:
          type: string
          description: ID of the resync
          format: uuid
        status:
          type: integer
          description: HTTP status code for the reply
          format: int32
        message:
          type: string
          description: Message of the response
        source:
          type: string
          description: Source that produced the reply
        properties:
          $ref: '#/components/schemas/JObject'
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResyncReplyItem'
          description: Optional items of the reply
      description: Information describing the reply of a resync request
    ListReply19:
      title: ListReply19
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOperation'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ValidationIssue:
      title: ValidationIssue
      required:
      - moduleSource
      - category
      type: object
      properties:
        moduleSource:
          type: string
        category:
          type: object
        message:
          type: string
        report:
          type: object
    ListReply20:
      title: ListReply20
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResourceInterface'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply21:
      title: ListReply21
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResourceProvider'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ResourceOperationProp:
      title: ResourceOperationProp
      type: object
      properties:
        interface:
          type: string
          description: ID of the interface
        title:
          type: string
          description: Title of the operation
        description:
          type: string
          description: Description of the operation
        inputs:
          $ref: '#/components/schemas/JObject'
        resourceStateConstraints:
          $ref: '#/components/schemas/JObject'
      description: Information describing a resource operation creation request
    ResyncStatus:
      title: ResyncStatus
      type: object
      properties:
        id:
          type: string
          description: ID of the resync request
          format: uuid
        full:
          type: boolean
          description: Whether the resync is a full one
        state:
          type: object
        requestScope:
          $ref: '#/components/schemas/RequestScope'
        markerScope:
          $ref: '#/components/schemas/MarkerResyncScope'
        eventsReceived:
          type: integer
          description: Number of events received
          format: int32
        eventsProcessed:
          type: integer
          description: Number of events processed
          format: int32
        pendingTerminateRequest:
          type: number
          description: Number of resources to terminate
        processedTerminateRequest:
          type: number
          description: Number of termination processed
        detail:
          type: string
          description: Detail about the status
        createdAt:
          type: string
          description: Detail about the status
          format: date-time
        updatedAt:
          type: string
          description: Detail about the status
          format: date-time
      description: Information describing the status of a resync request
    ResourceTypeDefinition:
      title: ResourceTypeDefinition
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the resource type
        title:
          type: string
          description: Resource type name
        description:
          type: string
          description: Resource type description
        version:
          type: string
          description: Resource type version identifier
        derivedFrom:
          type: array
          items:
            type: string
          description: URI of model artifacts from which this artifact is derived from
        experimental:
          type: boolean
          description: Experimental type artifact
        abstract:
          type: boolean
          description: Abstract type artifact
        model:
          $ref: '#/components/schemas/JObject'
      description: Meta-information and content for a resource type
    Tuple2:
      title: Tuple2
      required:
      - _1
      - _2
      type: object
      properties:
        _1:
          type: number
        _2:
          type: number
    ListReply22:
      title: ListReply22
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResourceHistoryEvent'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    MarkerResyncScope:
      title: MarkerResyncScope
      type: object
      properties:
        resourceTypes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        filterParam:
          $ref: '#/components/schemas/FilterParam'
        providerResourceId:
          type: string
    ListReply23:
      title: ListReply23
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SubDomain'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply24:
      title: ListReply24
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DomainType'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ResourceOperation:
      title: ResourceOperation
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the operation
        resourceId:
          type: string
          description: ID of the resource
        interface:
          type: string
          description: ID of the interface
        title:
          type: string
          description: Title of the operation
        description:
          type: string
          description: Description of the operation
        inputs:
          $ref: '#/components/schemas/JObject'
        outputs:
          $ref: '#/components/schemas/JObject'
        state:
          $ref: '#/components/schemas/State14'
        reason:
          type: string
          description: Reason for the operation state
        progress:
          $ref: '#/components/schemas/JArray'
        providerData:
          $ref: '#/components/schemas/JObject'
        createdAt:
          type: string
          description: When the operation was created
          format: date-time
        updatedAt:
          type: string
          description: When the operation was last updated
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update
          format: int64
        resourceStateConstraints:
          $ref: '#/components/schemas/JObject'
        executionGroup:
          type: string
          description: Execution group of the operation
      description: Information describing a resource operation
    Aggregation:
      title: Aggregation
      type: object
      properties:
        name:
          type: string
          description: An explanation about the purpose of this instance.
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/Bucket'
          description: An explanation about the purpose of this instance.
    AggregationBucket:
      title: AggregationBucket
      type: object
      properties:
        bucketKey:
          type: string
        bucketValue:
          type: string
        subAggregations:
          $ref: '#/components/schemas/Aggregation'
    ApplyFPGAAttributes:
      title: ApplyFPGAAttributes
      type: object
      properties:
        networkConstructName:
          type: string
        aid:
          type: string
    AttributesBO:
      title: AttributesBO
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        supportedTypeGroups:
          type: array
          items:
            type: string
          description: ''
        supportedProfileTypes:
          type: array
          items:
            type: string
          description: ''
        executionBO:
          $ref: '#/components/schemas/ExecutionBO'
    BGPSessionAddPaths:
      title: BGPSessionAddPaths
      type: object
      properties:
        capability:
          $ref: '#/components/schemas/Capability2'
        advertise:
          $ref: '#/components/schemas/Advertise2'
    BGPSessionNE:
      title: BGPSessionNE
      type: object
      properties:
        neName:
          type: string
        description:
          type: string
        ipInterface:
          type: string
        nodeRole:
          type: string
        peerAs:
          type: integer
          format: int64
        peerIp:
          type: string
        shelf:
          type: string
        group:
          type: string
        rrEnabled:
          type: boolean
          default: false
        isSecretMode:
          type: boolean
          default: false
        authenticationPassword:
          type: string
        orf:
          $ref: '#/components/schemas/BGPSessionORF'
        prefixList:
          $ref: '#/components/schemas/BGPSessionPrefixList'
        routeMap:
          $ref: '#/components/schemas/BGPSessionRouteMap'
        nextHopSelf:
          $ref: '#/components/schemas/BGPSessionNextHopSelf'
        addPaths:
          $ref: '#/components/schemas/BGPSessionAddPaths'
    BGPSessionNextHopSelf:
      title: BGPSessionNextHopSelf
      type: object
      properties:
        enabled:
          type: boolean
          default: false
        excludeReflectedRoutes:
          type: string
    BGPSessionORF:
      title: BGPSessionORF
      type: object
      properties:
        enabled:
          type: boolean
          default: false
        type:
          type: string
        direction:
          type: string
    BGPSessionPrefixList:
      title: BGPSessionPrefixList
      type: object
      properties:
        type:
          type: string
        direction:
          type: string
    BGPSessionRequest:
      title: BGPSessionRequest
      type: object
      properties:
        action:
          $ref: '#/components/schemas/Action3'
        addressFamilies:
          type: array
          items:
            type: string
          description: ''
        bfdMonitor:
          $ref: '#/components/schemas/BfdMonitor'
        bgpBest2:
          type: string
        vpnUnicast:
          type: string
        bgpDiversePath:
          type: string
        description:
          type: string
        keepaliveTime:
          type: integer
          format: int32
        holdTime:
          type: integer
          format: int32
        advertisementInterval:
          type: integer
          format: int32
        grEnabled:
          type: boolean
          default: false
        aEnd:
          $ref: '#/components/schemas/BGPSessionNE'
        zEnd:
          $ref: '#/components/schemas/BGPSessionNE'
    BGPSessionRouteMap:
      title: BGPSessionRouteMap
      type: object
      properties:
        name:
          type: string
        direction:
          $ref: '#/components/schemas/Direction14'
    BackupImageDetails:
      title: BackupImageDetails
      type: object
      properties:
        imageLocation:
          type: string
        creationTime:
          type: string
        neType:
          type: string
        fileSize:
          type: string
        backupType:
          $ref: '#/components/schemas/BackupType'
    BackupImageFtpProfileMapper:
      title: BackupImageFtpProfileMapper
      type: object
      properties:
        profileName:
          type: string
        backupImageDetails:
          type: array
          items:
            $ref: '#/components/schemas/BackupImageDetails'
          description: ''
    BackupImages:
      title: BackupImages
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/BackupImageFtpProfileMapper'
    BackupOperationDetails:
      title: BackupOperationDetails
      type: object
      properties:
        status:
          type: string
        operationTime:
          type: string
          format: date-time
    BatchAttributes:
      title: BatchAttributes
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/Type49'
        configMgmtJobId:
          type: string
        state:
          $ref: '#/components/schemas/State15'
        lastExecutionTime:
          type: string
          format: date-time
        nextExecutionTime:
          type: string
          format: date-time
        scheduleDetails:
          $ref: '#/components/schemas/ScheduleDetails'
        neDetails:
          type: array
          items:
            $ref: '#/components/schemas/BatchNeDetails'
          description: ''
        additionalAttributes:
          type: object
    BatchNeDetails:
      title: BatchNeDetails
      type: object
      properties:
        ncId:
          type: string
        neName:
          type: string
        neType:
          type: string
        typeGroup:
          type: string
    BatchNeStatus:
      title: BatchNeStatus
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/BatchNeStatusAttributes'
    BatchNeStatusAttributes:
      title: BatchNeStatusAttributes
      type: object
      properties:
        ncId:
          type: string
        type:
          type: string
        typeGroup:
          type: string
        siteName:
          type: string
        syncState:
          type: string
        associationState:
          type: string
        maintenanceState:
          type: string
        batches:
          type: array
          items:
            type: string
          description: ''
        operationType:
          type: string
        lastOperationResult:
          type: string
        lastExecutionTime:
          type: string
        nextExecutionTime:
          type: string
        lastRestoreTime:
          type: string
        triggerType:
          $ref: '#/components/schemas/TriggerType'
        operationStage:
          type: string
        softwareVersion:
          type: string
    BatchNeStatusList:
      title: BatchNeStatusList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BatchNeStatus'
          description: ''
    BatchRemoveRequest:
      title: BatchRemoveRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BatchRemoveRequestData'
    BatchRemoveRequestData:
      title: BatchRemoveRequestData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type50'
        attributes:
          $ref: '#/components/schemas/BatchRemoveRequestDataAttributes'
    BatchRemoveRequestDataAttributes:
      title: BatchRemoveRequestDataAttributes
      type: object
      properties:
        batchIds:
          type: array
          items:
            type: string
          description: ''
    BatchStatus:
      title: BatchStatus
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/BatchAttributes'
    BatchStatusList:
      title: BatchStatusList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BatchStatus'
          description: ''
    BulkOperationAttributes:
      title: BulkOperationAttributes
      type: object
      properties:
        operationType:
          type: string
        operationStartTime:
          type: string
          format: date-time
        operationStatus:
          type: string
        totalResources:
          type: integer
          format: int32
        applicableResources:
          type: integer
          format: int32
    BulkOperationsResponse:
      title: BulkOperationsResponse
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/BulkOperationAttributes'
    CMOperationStatus:
      title: CMOperationStatus
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/CMOperationStatusAttributes'
    CMOperationStatusAttributes:
      title: CMOperationStatusAttributes
      type: object
      properties:
        ncId:
          type: string
        type:
          type: string
        typeGroup:
          type: string
        siteName:
          type: string
        maintenanceState:
          type: string
        syncState:
          type: string
        associationState:
          type: string
        softwareVersion:
          type: string
        lastOperationTime:
          type: string
        nextOperationTime:
          type: string
        operationStage:
          type: string
        batches:
          type: array
          items:
            type: string
          description: ''
        lastOperationResult:
          type: string
    CMOperationStatusList:
      title: CMOperationStatusList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CMOperationStatus'
          description: ''
    CentralizedRadiusServer:
      title: CentralizedRadiusServer
      type: object
      properties:
        queryMode:
          type: string
        authenticationState:
          type: string
        alternateMode:
          type: string
        sharedSecret:
          type: string
    CommandResult:
      title: CommandResult
      type: object
      properties:
        command:
          type: string
        result:
          type: object
    Commissioning:
      title: Commissioning
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CommissioningData'
    CommissioningData:
      title: CommissioningData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
        relationships:
          $ref: '#/components/schemas/Relationships'
    CommissioningFunctionAttributes:
      title: CommissioningFunctionAttributes
      type: object
      properties:
        name:
          type: string
    CommissioningFunctionData:
      title: CommissioningFunctionData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/CommissioningFunctionAttributes'
    CommissioningFunctionList:
      title: CommissioningFunctionList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/CommissioningFunctionData'
          description: ''
    CommissioningProfile:
      title: CommissioningProfile
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CommissioningProfileData'
    CommissioningProfileAttributes:
      title: CommissioningProfileAttributes
      type: object
      properties:
        function:
          type: string
        profileType:
          $ref: '#/components/schemas/ProfileType'
        profileName:
          type: string
        typeGroups:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        description:
          type: string
        profileData:
          type: array
          items:
            $ref: '#/components/schemas/ProfileDataItem'
          description: ''
        role:
          type: string
        lastUpdatedTime:
          type: string
          format: date-time
    CommissioningProfileData:
      title: CommissioningProfileData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/CommissioningProfileAttributes'
    CommissioningProfileList:
      title: CommissioningProfileList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/CommissioningProfileData'
          description: ''
    CommissioningSettingDetails:
      title: CommissioningSettingDetails
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/CommissioningSettingDetailsAttribute'
    CommissioningSettingDetailsAttribute:
      title: CommissioningSettingDetailsAttribute
      type: object
      properties:
        networkConstructId:
          type: string
        managementSessionId:
          type: string
        name:
          type: string
        displayName:
          type: string
        resourceType:
          type: string
        typeGroup:
          type: string
        ipAddress:
          type: string
        associationState:
          type: string
        ntpSettings:
          $ref: '#/components/schemas/NTPSettings'
        ntpPn10xSettings:
          $ref: '#/components/schemas/NtpPn10xSettings'
        isisSettings:
          type: array
          items:
            $ref: '#/components/schemas/ISISSettings'
          description: ''
        licensePn10xSettings:
          $ref: '#/components/schemas/LicensePn10xSettings'
        pmStatsConfigurationSettings:
          $ref: '#/components/schemas/PMStatsConfigurationSettings'
        shelf:
          type: array
          items:
            $ref: '#/components/schemas/CommissioningShelf'
          description: ''
    CommissioningSettingDetailsList:
      title: CommissioningSettingDetailsList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/CommissioningSettingDetails'
          description: ''
    CommissioningShelf:
      title: CommissioningShelf
      type: object
      properties:
        shelfName:
          type: string
        radiusSettings:
          $ref: '#/components/schemas/RadiusSettings'
        licenseSettings:
          $ref: '#/components/schemas/LicenseSettings'
        sshSettings:
          $ref: '#/components/schemas/SSHSettings'
        systemSettings:
          $ref: '#/components/schemas/SystemSettings'
        ndpSettings:
          $ref: '#/components/schemas/NDPSettings'
        docSettings:
          $ref: '#/components/schemas/DOCSettings'
        osrpNodesSettings:
          $ref: '#/components/schemas/OSRPNodesSettings'
    ConfigDOC:
      title: ConfigDOC
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ConfigDOCAttributes'
    ConfigDOCAttributes:
      title: ConfigDOCAttributes
      type: object
      properties:
        networkConstructName:
          type: string
        networkConstructId:
          type: string
        primaryState:
          type: string
        docName:
          type: string
        selected:
          type: boolean
          default: false
    ConfigDOCResponse:
      title: ConfigDOCResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConfigDOC'
          description: ''
    ConfigMgmtJobOutput:
      title: ConfigMgmtJobOutput
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ConfigMgmtJobOutputData'
    ConfigMgmtJobOutputData:
      title: ConfigMgmtJobOutputData
      type: object
      properties:
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ScriptResultAttributes'
    ConfigMgmtJobResponse:
      title: ConfigMgmtJobResponse
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
        input:
          $ref: '#/components/schemas/UserInput'
        output:
          $ref: '#/components/schemas/ConfigMgmtJobOutput'
    ConflictingSid:
      title: ConflictingSid
      type: object
      properties:
        conflictingData:
          type: array
          items:
            $ref: '#/components/schemas/NCData'
          description: ''
        prefixSids:
          type: string
    ConnectionAttributes:
      title: ConnectionAttributes
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionAttributesData'
          description: ''
    ConnectionAttributesData:
      title: ConnectionAttributesData
      type: object
      properties:
        type:
          type: string
        id:
          type: string
    CreateBFDSessionRequest:
      title: CreateBFDSessionRequest
      type: object
      properties:
        bfdSessionName:
          type: string
        source:
          type: string
        neighbour:
          type: string
        bfdProfile:
          type: string
    CreateBGPSessionRequest:
      title: CreateBGPSessionRequest
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BGPSessionRequest'
          description: ''
    CustomScript:
      title: CustomScript
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/CustomScriptAttributes'
    CustomScriptAttributes:
      title: CustomScriptAttributes
      type: object
      properties:
        typeGroup:
          type: string
        protocolType:
          type: string
        scriptName:
          type: string
        description:
          type: string
    CustomScriptList:
      title: CustomScriptList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomScript'
          description: ''
    CustomScriptsList:
      title: CustomScriptsList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomScript'
          description: ''
    DOCDetail:
      title: DOCDetail
      type: object
      properties:
        networkConstructName:
          type: string
        docNames:
          type: array
          items:
            type: string
          description: ''
    DOCSettings:
      title: DOCSettings
      type: object
      properties:
        docState:
          type: string
        autoAddChannels:
          type: string
        autoDeleteChannels:
          type: string
        autoSquelchChannels:
          type: string
        autoSquelchHoldOff:
          type: string
        mode:
          type: string
    DeleteBFDSessionRequest:
      title: DeleteBFDSessionRequest
      type: object
      properties:
        bfdSessionName:
          type: string
        source:
          type: string
        neighbour:
          type: string
    DeleteCommissioningRequest:
      title: DeleteCommissioningRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DeleteCommissioningRequestData'
    DeleteCommissioningRequestAttributes:
      title: DeleteCommissioningRequestAttributes
      type: object
      properties:
        neCommissioningDetails:
          type: array
          items:
            $ref: '#/components/schemas/NeCommissioningDetail'
          description: ''
    DeleteCommissioningRequestData:
      title: DeleteCommissioningRequestData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/DeleteCommissioningRequestAttributes'
    Distribution:
      title: Distribution
      type: object
      properties:
        protocol:
          type: string
        throttle:
          type: string
    EditDOC:
      title: EditDOC
      type: object
      properties:
        operationType:
          $ref: '#/components/schemas/OperationType'
        docDetails:
          type: array
          items:
            $ref: '#/components/schemas/DOCDetail'
          description: ''
    ExecutionBO:
      title: ExecutionBO
      type: object
      properties:
        type:
          type: string
        raCommand:
          type: string
        productRequestParams:
          $ref: '#/components/schemas/ProductRequestParamsBO'
    FPGADetails:
      title: FPGADetails
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/FPGADetailsAttributes'
    FPGADetailsAttributes:
      title: FPGADetailsAttributes
      type: object
      properties:
        softwareType:
          type: string
        currentFPGA:
          type: string
        availableFPGA:
          type: string
    FPGADetailsResponse:
      title: FPGADetailsResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FPGADetails'
          description: ''
    FallbackPasswordPolicyBO:
      title: FallbackPasswordPolicyBO
      type: object
      properties:
        lowercaseMinimum:
          type: integer
          format: int32
        uppercaseMinimum:
          type: integer
          format: int32
        digitMinimum:
          type: integer
          format: int32
        specialMinimum:
          type: integer
          format: int32
        passwordLength:
          type: integer
          format: int32
        maximumConsecutiveCharacters:
          type: integer
          format: int32
    FallbackPasswordPolicyRequest:
      title: FallbackPasswordPolicyRequest
      type: object
      properties:
        lowercaseMinimum:
          type: integer
          format: int32
        uppercaseMinimum:
          type: integer
          format: int32
        digitMinimum:
          type: integer
          format: int32
        specialMinimum:
          type: integer
          format: int32
        passwordLength:
          type: integer
          format: int32
        maximumConsecutiveCharacters:
          type: integer
          format: int32
    FallbackPasswordPolicyResponse:
      title: FallbackPasswordPolicyResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FallbackPasswordPolicyRequest'
    FallbackPasswordResetRequest:
      title: FallbackPasswordResetRequest
      type: object
      properties:
        neType:
          type: string
        neNames:
          type: array
          items:
            type: string
          description: ''
        resetSchedule:
          $ref: '#/components/schemas/FallbackResetScheduleRequest'
    FallbackPasswordResetResponse:
      title: FallbackPasswordResetResponse
      type: object
      properties:
        neType:
          type: string
        neNames:
          type: array
          items:
            type: string
          description: ''
        resetSchedule:
          $ref: '#/components/schemas/FallbackResetScheduleResponse'
        state:
          type: string
    FallbackResetScheduleListResponse:
      title: FallbackResetScheduleListResponse
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/FallbackUserListMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/FallbackResetScheduleResponse'
          description: ''
    FallbackResetScheduleRequest:
      title: FallbackResetScheduleRequest
      type: object
      properties:
        frequency:
          type: string
        startTime:
          type: string
        jobId:
          type: string
    FallbackResetScheduleResponse:
      title: FallbackResetScheduleResponse
      type: object
      properties:
        id:
          type: string
        frequency:
          type: string
        neNames:
          type: array
          items:
            type: string
          description: ''
        nextExecutionTime:
          type: string
    FallbackUserCreationRequest:
      title: FallbackUserCreationRequest
      type: object
      properties:
        neType:
          type: string
        neNames:
          type: array
          items:
            type: string
          description: ''
    FallbackUserCreationResponse:
      title: FallbackUserCreationResponse
      type: object
      properties:
        neType:
          type: string
        neNames:
          type: array
          items:
            type: string
          description: ''
        state:
          type: string
    FallbackUserDeletionRequest:
      title: FallbackUserDeletionRequest
      type: object
      properties:
        neType:
          type: string
        neNames:
          type: array
          items:
            type: string
          description: ''
    FallbackUserDeletionResponse:
      title: FallbackUserDeletionResponse
      type: object
      properties:
        neType:
          type: string
        neNames:
          type: array
          items:
            type: string
          description: ''
        state:
          type: string
    FallbackUserListMeta:
      title: FallbackUserListMeta
      type: object
      properties:
        total:
          type: integer
          format: int32
    FallbackUserListResponse:
      title: FallbackUserListResponse
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/FallbackUserListMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/FallbackUserResponse'
          description: ''
    FallbackUserResponse:
      title: FallbackUserResponse
      type: object
      properties:
        neType:
          type: string
        neName:
          type: string
        userName:
          type: string
        password:
          type: string
        lastOperationState:
          type: string
        lastOperationNote:
          type: string
        lastOperationTime:
          type: string
    FtpProfile:
      title: FtpProfile
      type: object
      properties:
        name:
          type: string
        profileType:
          $ref: '#/components/schemas/ProfileType1'
        protocolType:
          $ref: '#/components/schemas/ProtocolType'
        storageMethod:
          $ref: '#/components/schemas/StorageMethod'
        userName:
          type: string
        userPassword:
          type: string
        ipAddress:
          type: string
        port:
          type: integer
          format: int32
        imageLocation:
          type: string
    FtpProfileAttribs:
      title: FtpProfileAttribs
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/FtpProfile'
    FtpProfileResponse:
      title: FtpProfileResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FtpProfileAttribs'
          description: ''
    Function:
      title: Function
      type: object
      properties:
        functionName:
          type: string
        relationships:
          $ref: '#/components/schemas/FunctionRelationship'
    FunctionRelationship:
      title: FunctionRelationship
      type: object
      properties:
        commissioningProfile:
          $ref: '#/components/schemas/CommissioningProfile'
    GracefulRestart:
      title: GracefulRestart
      type: object
      properties:
        graceful-restart:
          type: boolean
          default: false
    ISISSettings:
      title: ISISSettings
      type: object
      properties:
        name:
          type: string
        netAddress:
          type: string
        isisLevel:
          type: string
        srState:
          type: string
        adminDistance:
          type: string
        metricStyle:
          type: string
        lspRefreshTimer:
          type: string
        lspLifeTime:
          type: string
        dynamicHostnameEnabled:
          type: boolean
          default: false
        cspfFlag:
          type: boolean
          default: false
        mplsTe:
          $ref: '#/components/schemas/MplsTe'
        graceful-restart:
          $ref: '#/components/schemas/GracefulRestart'
        overload:
          $ref: '#/components/schemas/Overload'
        level-1:
          $ref: '#/components/schemas/LevelData'
        level-2:
          $ref: '#/components/schemas/LevelData'
        ipv4Redistribution:
          type: object
        ipv6Redistribution:
          type: object
        segmentRoutingBindings:
          type: object
        operationalRangeList:
          type: array
          items:
            type: object
          description: ''
        adminRangeList:
          type: array
          items:
            type: object
          description: ''
        frr:
          type: object
        multiTopology:
          type: array
          items:
            $ref: '#/components/schemas/MultiTopology'
          description: ''
        distribution:
          $ref: '#/components/schemas/Distribution'
        algorithm:
          type: string
        total-sid:
          type: string
        preference:
          type: string
        srMappingEntries:
          type: array
          items:
            type: object
          description: ''
    Included:
      title: Included
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/IncludedAttributes'
    IncludedAttributes:
      title: IncludedAttributes
      type: object
      properties:
        ncId:
          type: string
        neName:
          type: string
        ipAddress:
          type: string
        profileName:
          type: string
        profileId:
          type: string
        file:
          type: string
        neType:
          type: string
        typeGroup:
          type: string
        failOnServiceAffectingAlarms:
          type: boolean
          default: false
        manuallyInvokeCards:
          type: boolean
          default: false
    IncludedAttributesBO:
      title: IncludedAttributesBO
      type: object
      properties:
        file:
          type: string
    IncludedDataBO:
      title: IncludedDataBO
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        attributes:
          $ref: '#/components/schemas/IncludedAttributesBO'
    Input:
      title: Input
      type: object
      properties:
        inputId:
          type: string
        cmdFile:
          type: string
        function:
          type: string
        protocolType:
          $ref: '#/components/schemas/ProtocolType1'
    KeyValuePair:
      title: KeyValuePair
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    LagProvisioningRequest:
      title: LagProvisioningRequest
      type: object
      properties:
        neName:
          type: string
        shelf:
          type: string
        group:
          type: string
        action:
          $ref: '#/components/schemas/Action1'
        attributes:
          type: object
    LevelData:
      title: LevelData
      type: object
      properties:
        level-type:
          type: string
        lsp-gen-interval:
          type: string
        spf-min-delay:
          type: string
        spf-max-delay:
          type: string
        lsp-mtu:
          type: string
    LicensePn10xSettings:
      title: LicensePn10xSettings
      type: object
      properties:
        serverEnable:
          type: string
        hostname:
          type: string
        protocol:
          type: string
        serverPort:
          type: string
        refreshTime:
          type: string
    LicenseSettings:
      title: LicenseSettings
      type: object
      properties:
        primaryServerIp:
          type: string
        primaryStatus:
          type: string
        secondaryServerIp:
          type: string
        secondaryStatus:
          type: string
        port:
          type: string
        protocol:
          type: string
        proxy:
          type: string
        proxyServerIp:
          type: string
        proxyPort:
          type: string
        auditTime:
          type: string
        lastExchangeTime:
          type: string
        licensingPolicy:
          type: string
    Links:
      title: Links
      type: object
      properties:
        self:
          type: string
          description: A `self` member, whose value is a URL for the relationship itself (a "relationship URL"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.
        first:
          type: string
          description: The first page of data
        last:
          type: string
          description: The last page of data
        prev:
          type: string
          description: The previous page of data
        next:
          type: string
          description: The next page of data
        current:
          type: string
          description: The current page of data
    ManualInvokeAttributes:
      title: ManualInvokeAttributes
      type: object
      properties:
        networkConstructName:
          type: string
        slotId:
          type: string
    ManualResume:
      title: ManualResume
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ManualResumeData'
    ManualResumeAttributes:
      title: ManualResumeAttributes
      type: object
      properties:
        neDetails:
          type: array
          items:
            $ref: '#/components/schemas/NeDetail'
          description: ''
    ManualResumeData:
      title: ManualResumeData
      type: object
      properties:
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ManualResumeAttributes'
    ManualSuspend:
      title: ManualSuspend
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ManualSuspendData'
    ManualSuspendAttributes:
      title: ManualSuspendAttributes
      type: object
      properties:
        neDetails:
          type: array
          items:
            $ref: '#/components/schemas/NeDetail'
          description: ''
    ManualSuspendData:
      title: ManualSuspendData
      type: object
      properties:
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ManualSuspendAttributes'
    MetaData:
      title: MetaData
      type: object
      properties:
        descriptors:
          type: array
          items:
            type: string
          description: ''
        delimiter:
          type: string
    MplsTe:
      title: MplsTe
      type: object
      properties:
        routerId:
          type: string
        level-type:
          type: string
    MultiTopology:
      title: MultiTopology
      type: object
      properties:
        level:
          type: string
        transition:
          type: string
    NCData:
      title: NCData
      type: object
      properties:
        ncId:
          type: string
        ncIpAddress:
          type: string
        neTypeGrp:
          type: string
        neName:
          type: string
        prefixType:
          type: string
    NDPSettings:
      title: NDPSettings
      type: object
      properties:
        state:
          type: string
    NTPServer:
      title: NTPServer
      type: object
      properties:
        ipAddress:
          type: string
        status:
          type: string
    NTPSettings:
      title: NTPSettings
      type: object
      properties:
        tod:
          type: string
        nextSync:
          type: string
        lastSync:
          type: string
        detectedOffset:
          type: string
        ntpServer1:
          $ref: '#/components/schemas/NTPServer'
        ntpServer2:
          $ref: '#/components/schemas/NTPServer'
        ntpServer3:
          $ref: '#/components/schemas/NTPServer'
        ntpServer4:
          $ref: '#/components/schemas/NTPServer'
        ntpServer5:
          $ref: '#/components/schemas/NTPServer'
        pollingInterval:
          type: string
        sync:
          type: string
    NeBackupImagesResponse:
      title: NeBackupImagesResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BackupImages'
          description: ''
    NeBackupRestoreStatus:
      title: NeBackupRestoreStatus
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/NeBackupRestoreStatusAttributes'
    NeBackupRestoreStatusAttributes:
      title: NeBackupRestoreStatusAttributes
      type: object
      properties:
        ncId:
          type: string
        type:
          type: string
        typeGroup:
          type: string
        siteName:
          type: string
        maintenanceState:
          type: string
        syncState:
          type: string
        associationState:
          type: string
        lastBackupTime:
          type: string
        lastRestoreTime:
          type: string
        nextBackupTime:
          type: string
        backupType:
          $ref: '#/components/schemas/BackupType'
        batches:
          type: array
          items:
            type: string
          description: ''
        lastOperationResult:
          type: string
    NeBackupRestoreStatusList:
      title: NeBackupRestoreStatusList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NeBackupRestoreStatus'
          description: ''
    NeCommissioningDetail:
      title: NeCommissioningDetail
      type: object
      properties:
        neName:
          type: string
        identifiers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/NeCommissioningIdentifier'
          description: ''
    NeCommissioningIdentifier:
      title: NeCommissioningIdentifier
      type: object
      properties:
        id:
          type: string
        result:
          $ref: '#/components/schemas/NeCommissioningIdentifierResult'
    NeCommissioningIdentifierResult:
      title: NeCommissioningIdentifierResult
      type: object
      properties:
        state:
          type: string
        msg:
          type: string
    NeDetail:
      title: NeDetail
      type: object
      properties:
        neName:
          type: string
        neType:
          type: string
        typeGroup:
          type: string
    NeMaintenanceDetails:
      title: NeMaintenanceDetails
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/NeMaintenanceDetailsAttributes'
    NeMaintenanceDetailsAttributes:
      title: NeMaintenanceDetailsAttributes
      type: object
      properties:
        networkConstructId:
          type: string
        name:
          type: string
        longName:
          type: string
        displayName:
          type: string
        managementSessionId:
          type: string
        resourceType:
          type: string
        deviceType:
          type: string
        typeGroup:
          type: string
        ipAddress:
          type: string
        associationState:
          type: string
        associationStateQualifier:
          $ref: '#/components/schemas/AssociationStateQualifier1'
        associationStateQualifierReason:
          type: string
        syncState:
          type: string
        physicalLocationId:
          type: string
        subnetName:
          type: string
        softwareActiveVersion:
          type: string
        softwareAvailableVersions:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        backupSchedules:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        upgradeSchedules:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        customScriptSchedules:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        recentOperation:
          type: string
        recentOperationTime:
          type: string
          format: date-time
        nextOperation:
          type: string
        nextOperationTime:
          type: string
          format: date-time
        recentOperationState:
          type: string
        recentOperationProgressStage:
          type: string
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    NeMaintenanceDetailsList:
      title: NeMaintenanceDetailsList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/NeMaintenanceDetails'
          description: ''
    NeMaintenanceProfile:
      title: NeMaintenanceProfile
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/NeMaintenanceProfileAttributes'
    NeMaintenanceProfileAttributes:
      title: NeMaintenanceProfileAttributes
      type: object
      properties:
        name:
          type: string
        profileType:
          $ref: '#/components/schemas/ProfileType1'
        protocolType:
          $ref: '#/components/schemas/ProtocolType'
        storageMethod:
          $ref: '#/components/schemas/StorageMethod'
        userName:
          type: string
        userPassword:
          type: string
        ipAddress:
          type: string
        port:
          type: integer
          format: int32
        imageLocation:
          type: string
    NeMaintenanceProfilesList:
      title: NeMaintenanceProfilesList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/NeMaintenanceProfile'
          description: ''
    NeUpgradeDetails:
      title: NeUpgradeDetails
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/NeUpgradeDetailsAttributes'
    NeUpgradeDetailsAttributes:
      title: NeUpgradeDetailsAttributes
      type: object
      properties:
        networkConstructId:
          type: string
        name:
          type: string
        longName:
          type: string
        displayName:
          type: string
        managementSessionId:
          type: string
        resourceType:
          type: string
        deviceType:
          type: string
        typeGroup:
          type: string
        ipAddress:
          type: string
        associationState:
          type: string
        associationStateQualifier:
          $ref: '#/components/schemas/AssociationStateQualifier1'
        associationStateQualifierReason:
          type: string
        syncState:
          type: string
        physicalLocationId:
          type: string
        subnetName:
          type: string
        gneOrRNE:
          type: string
        recentOperation:
          type: string
        recentOperationTime:
          type: string
          format: date-time
        recentOperationState:
          type: string
        recentOperationProgressStage:
          type: string
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        backupOperation:
          $ref: '#/components/schemas/BackupOperationDetails'
        releaseManagementOperation:
          $ref: '#/components/schemas/ReleaseManagementOperationDetails'
        upgradeOperation:
          $ref: '#/components/schemas/UpgradeOperationDetails'
    NeUpgradeDetailsList:
      title: NeUpgradeDetailsList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/NeUpgradeDetails'
          description: ''
    NetworkConstructs:
      title: NetworkConstructs
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NetworkConstructsData'
          description: ''
    NetworkConstructsData:
      title: NetworkConstructsData
      type: object
      properties:
        type:
          type: string
        id:
          type: string
    NtpPn10xServer:
      title: NtpPn10xServer
      type: object
      properties:
        address:
          type: string
        adminState:
          type: string
    NtpPn10xSettings:
      title: NtpPn10xSettings
      type: object
      properties:
        mode:
          type: string
        adminState:
          type: string
        pollingIntervalMin:
          type: string
        pollingIntervalMax:
          type: string
        remoteNtpServers:
          type: array
          items:
            $ref: '#/components/schemas/NtpPn10xServer'
          description: ''
    OSRPNodesSettings:
      title: OSRPNodesSettings
      type: object
      properties:
        retainHomePath:
          type: string
        revertType:
          type: string
        timeToRevert:
          type: string
    OperationNEResource:
      title: OperationNEResource
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/OperationNEResourceAttributes'
    OperationNEResourceAttributes:
      title: OperationNEResourceAttributes
      type: object
      properties:
        operationType:
          type: string
        state:
          type: string
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        networkConstructId:
          type: string
        name:
          type: string
        displayName:
          type: string
        resourceType:
          type: string
        typeGroup:
          type: string
        associationState:
          type: string
        ipAddress:
          type: string
        softwareActiveVersion:
          type: string
        loopbackIpAddress:
          type: string
        nodeSid:
          type: integer
          format: int32
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    OperationNEResourceCollection:
      title: OperationNEResourceCollection
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/OperationNEResource'
          description: ''
    OperationProgressStatus:
      title: OperationProgressStatus
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/OperationProgressStatusAttributes'
    OperationProgressStatusAttributes:
      title: OperationProgressStatusAttributes
      type: object
      properties:
        operationType:
          type: string
        executedResources:
          type: string
    OperationStatus:
      title: OperationStatus
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/OperationStatusAttributes'
    OperationStatusAttributes:
      title: OperationStatusAttributes
      type: object
      properties:
        operationType:
          type: string
        state:
          type: string
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        failureStatus:
          type: string
        totalResources:
          type: integer
          format: int32
    OperationStatusCollection:
      title: OperationStatusCollection
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/OperationStatus'
          description: ''
    Overload:
      title: Overload
      type: object
      properties:
        on-startup:
          type: string
        suppress:
          type: string
        timeout:
          type: string
    PMStatsConfigurationSettings:
      title: PMStatsConfigurationSettings
      type: object
      properties:
        statsCollection:
          type: string
    PacketNEInfo:
      title: PacketNEInfo
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/PacketNEInfoAttributes'
    PacketNEInfoAttributes:
      title: PacketNEInfoAttributes
      type: object
      properties:
        networkConstructId:
          type: string
        name:
          type: string
        displayName:
          type: string
        resourceType:
          type: string
        typeGroup:
          type: string
        associationState:
          type: string
        ipAddress:
          type: string
        softwareActiveVersion:
          type: string
        loopbackIpAddress:
          type: string
        nodeSid:
          type: integer
          format: int32
        prefixType:
          type: string
        srEnabled:
          type: boolean
          default: false
        startRange:
          type: integer
          format: int32
        endRange:
          type: integer
          format: int32
        recentOperation:
          type: string
        recentOperationTime:
          type: string
          format: date-time
        recentOperationState:
          type: string
        failureReason:
          type: string
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    PacketNEInfoCollection:
      title: PacketNEInfoCollection
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/PacketNEInfo'
          description: ''
    ParentPolicerCreateDetails:
      title: ParentPolicerCreateDetails
      type: object
      properties:
        neName:
          type: string
        ncId:
          type: string
        parentPolicerName:
          type: string
        port:
          type: string
        cir:
          type: string
        cbs:
          type: string
        reSyncInventory:
          type: boolean
          default: false
    ParentPolicerDeleteDetails:
      title: ParentPolicerDeleteDetails
      type: object
      properties:
        neName:
          type: string
        ncId:
          type: string
        parentPolicerName:
          type: string
        reSyncInventory:
          type: boolean
          default: false
    ParentPolicerUpdateDetails:
      title: ParentPolicerUpdateDetails
      type: object
      properties:
        neName:
          type: string
        ncId:
          type: string
        parentPolicerName:
          type: string
        cir:
          type: string
        cbs:
          type: string
        reSyncInventory:
          type: boolean
          default: false
    PortDeProvisioningDetails:
      title: PortDeProvisioningDetails
      type: object
      properties:
        name:
          type: string
        shelf:
          type: string
        slot:
          type: string
        port:
          type: string
        otn:
          type: boolean
          default: false
        scriptFileProperties:
          type: object
          additionalProperties:
            type: string
        reSyncInventory:
          type: boolean
          default: false
    PortMapping:
      title: PortMapping
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/PortMappingAttributes'
    PortMappingAttributes:
      title: PortMappingAttributes
      type: object
      properties:
        name:
          type: string
    PortMappingList:
      title: PortMappingList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PortMapping'
          description: ''
    PortProvisioningDetails:
      title: PortProvisioningDetails
      type: object
      properties:
        name:
          type: string
        shelf:
          type: string
        slot:
          type: string
        port:
          type: string
        clientType:
          type: string
        otn:
          type: boolean
          default: false
        maxFrameSize:
          type: string
        description:
          type: string
        rate:
          type: string
        customerId:
          type: string
        scriptFileProperties:
          type: object
          additionalProperties:
            type: string
        reSyncInventory:
          type: boolean
          default: false
    ProductRequestParamsBO:
      title: ProductRequestParamsBO
      type: object
      properties:
        q:
          type: string
        p:
          type: string
    ProfileAssociationAttributes:
      title: ProfileAssociationAttributes
      type: object
      properties:
        jobExecuted:
          type: boolean
          default: false
        associatedSchedules:
          type: array
          items:
            type: string
          description: ''
    ProfileAssociations:
      title: ProfileAssociations
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProfileAssociationsData'
    ProfileAssociationsData:
      title: ProfileAssociationsData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ProfileAssociationAttributes'
    ProfileDataBO:
      title: ProfileDataBO
      type: object
      properties:
        type:
          type: string
        id:
          type: string
    ProfileDataItem:
      title: ProfileDataItem
      type: object
      properties:
        key:
          type: string
        value:
          type: string
        parent:
          type: string
        grandParent:
          type: string
    ProfilesBO:
      title: ProfilesBO
      type: object
      properties:
        profileDataBOList:
          type: array
          items:
            $ref: '#/components/schemas/ProfileDataBO'
          description: ''
    QueuePortRootScheduler:
      title: QueuePortRootScheduler
      type: object
      properties:
        portRootschedulerName:
          type: string
        cirPolicy:
          $ref: '#/components/schemas/CirPolicy'
        cirPercent:
          type: integer
          format: int32
        cbs:
          type: integer
          format: int32
        eirPolicy:
          $ref: '#/components/schemas/EirPolicy'
        eirPercent:
          type: integer
          format: int32
        ebs:
          type: integer
          format: int32
    QueuePortScheduler:
      title: QueuePortScheduler
      type: object
      properties:
        schedulerAlgorithm:
          $ref: '#/components/schemas/SchedulerAlgorithm'
        cirPolicy:
          $ref: '#/components/schemas/CirPolicy1'
        cirPercent:
          type: integer
          format: int32
        cbs:
          type: integer
          format: int32
        eirPolicy:
          $ref: '#/components/schemas/EirPolicy1'
        eirPercent:
          type: integer
          format: int32
        ebs:
          type: integer
          format: int32
    QueueProvisionAttributes:
      title: QueueProvisionAttributes
      type: object
      properties:
        schedulerName:
          type: string
        schedulerInstanceName:
          type: string
        schedulerInstanceId:
          type: integer
          format: int32
        interfaceName:
          type: string
        portScheduler:
          $ref: '#/components/schemas/QueuePortScheduler'
        portRootScheduler:
          $ref: '#/components/schemas/QueuePortRootScheduler'
        queues:
          $ref: '#/components/schemas/Queues'
        queueWeights:
          type: array
          items:
            $ref: '#/components/schemas/QueueWeights'
          description: ''
        queueGroupInstanceEnabled:
          type: boolean
          default: false
        schedulerInstanceEnabled:
          type: boolean
          default: false
    QueueProvisionRequest:
      title: QueueProvisionRequest
      type: object
      properties:
        neName:
          type: string
        shelf:
          type: string
        group:
          type: string
        portName:
          type: string
        aggName:
          type: string
        attributes:
          $ref: '#/components/schemas/QueueProvisionAttributes'
    QueueWeights:
      title: QueueWeights
      type: object
      properties:
        tapPoint:
          type: integer
          format: int32
        weight:
          type: integer
          format: int32
        priority:
          type: integer
          format: int32
    Queues:
      title: Queues
      type: object
      properties:
        queueGroup:
          type: string
        queueInstanceName:
          type: string
        queueInstanceId:
          type: integer
          format: int32
        queueStatsCollection:
          type: string
        cbs:
          type: integer
          format: int32
        ebs:
          type: integer
          format: int32
        shapeCompensation:
          type: number
        settings:
          type: array
          items:
            $ref: '#/components/schemas/Queuessettings'
          description: ''
    Queuessettings:
      title: Queuessettings
      type: object
      properties:
        congestionAvoidanceProfile:
          type: string
        queueNo:
          type: integer
          format: int32
        cirPercent:
          type: integer
          format: int32
        eirPercent:
          type: integer
          format: int32
        schedulerWeight:
          type: integer
          format: int32
        eirPolicy:
          type: string
    RadiusServer:
      title: RadiusServer
      type: object
      properties:
        state:
          type: string
        ipAddress:
          type: string
        port:
          type: string
        timeout:
          type: string
        autoGenerateSharedSecret:
          type: string
        sharedSecret:
          type: string
    RadiusSettings:
      title: RadiusSettings
      type: object
      properties:
        primaryRadius:
          $ref: '#/components/schemas/RadiusServer'
        secondaryRadius:
          $ref: '#/components/schemas/RadiusServer'
        centralizedRadius:
          $ref: '#/components/schemas/CentralizedRadiusServer'
    Relationships:
      title: Relationships
      type: object
      properties:
        osData:
          $ref: '#/components/schemas/OneToManyRelationship1'
        fres:
          $ref: '#/components/schemas/OneToManyRelationship1'
    RelationshipsBO:
      title: RelationshipsBO
      type: object
      properties:
        profilesBO:
          $ref: '#/components/schemas/ProfilesBO'
        schemasBO:
          $ref: '#/components/schemas/SchemasBO'
    ReleaseManagementOperationDetails:
      title: ReleaseManagementOperationDetails
      type: object
      properties:
        softwareActiveVersion:
          type: string
        softwareAvailableVersions:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        schedules:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        stage:
          type: string
        status:
          type: string
    SSHSettings:
      title: SSHSettings
      type: object
      properties:
        server:
          type: string
        idleTimeout:
          type: string
        maxSessions:
          type: string
    ScheduleAttributes:
      title: ScheduleAttributes
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/Type49'
        configMgmtJobId:
          type: string
        state:
          $ref: '#/components/schemas/State15'
        lastExecutionTime:
          type: string
          format: date-time
        nextExecutionTime:
          type: string
          format: date-time
        numberOfNEs:
          type: integer
          format: int32
        scheduleDetails:
          $ref: '#/components/schemas/ScheduleDetails'
        additionalAttributes:
          type: object
    ScheduleData:
      title: ScheduleData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ScheduleAttributes'
    ScheduleDetails:
      title: ScheduleDetails
      type: object
      properties:
        scheduleFrequency:
          $ref: '#/components/schemas/ScheduleFrequency'
        scheduleTime:
          type: string
          format: date-time
        scheduleWeeklyDays:
          $ref: '#/components/schemas/ScheduleWeeklyDays'
    ScheduleDetailsResponse:
      title: ScheduleDetailsResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScheduleData'
    ScheduleDetailsResponseList:
      title: ScheduleDetailsResponseList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleData'
          description: ''
    ScheduleNesPatch:
      title: ScheduleNesPatch
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleNesPatchOperation'
          description: ''
    ScheduleNesPatchOperation:
      title: ScheduleNesPatchOperation
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op5'
        scheduleId:
          type: string
        neDetails:
          type: array
          items:
            $ref: '#/components/schemas/BatchNeDetails'
          description: ''
    ScheduleWeeklyDays:
      title: ScheduleWeeklyDays
      type: object
      properties:
        mon:
          $ref: '#/components/schemas/Mon'
        tue:
          $ref: '#/components/schemas/Tue'
        wed:
          $ref: '#/components/schemas/Wed'
        thu:
          $ref: '#/components/schemas/Thu'
        fri:
          $ref: '#/components/schemas/Fri'
        sat:
          $ref: '#/components/schemas/Sat'
        sun:
          $ref: '#/components/schemas/Sun'
    SchedulesAssignNE:
      title: SchedulesAssignNE
      type: object
      properties:
        ipAddress:
          type: string
        additionalIpAddresses:
          type: array
          items:
            type: string
          description: ''
        resourcePartitionInfo:
          type: array
          items:
            type: string
          description: ''
        backupSchedule:
          type: string
    SchemasBO:
      title: SchemasBO
      type: object
      properties:
        schemasDataBOList:
          type: array
          items:
            $ref: '#/components/schemas/SchemasDataBO'
          description: ''
    SchemasDataBO:
      title: SchemasDataBO
      type: object
      properties:
        type:
          type: string
        id:
          type: string
    Script:
      title: Script
      type: object
      properties:
        scriptName:
          type: string
        inputs:
          type: array
          items:
            $ref: '#/components/schemas/Input'
          description: ''
        relationships:
          $ref: '#/components/schemas/ScriptRelationships'
    ScriptBO:
      title: ScriptBO
      type: object
      properties:
        scriptDataBO:
          $ref: '#/components/schemas/ScriptDataBO'
        includedBO:
          type: array
          items:
            $ref: '#/components/schemas/IncludedDataBO'
          description: ''
    ScriptDataBO:
      title: ScriptDataBO
      type: object
      properties:
        type:
          type: string
        attributesBO:
          $ref: '#/components/schemas/AttributesBO'
        relationshipsBO:
          $ref: '#/components/schemas/RelationshipsBO'
    ScriptDefRequestBO:
      title: ScriptDefRequestBO
      type: object
      properties:
        scriptBO:
          $ref: '#/components/schemas/ScriptBO'
    ScriptDefResponseBO:
      title: ScriptDefResponseBO
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ScriptDefRequestBO'
        creationTime:
          type: string
          format: date-time
    ScriptExecutionDetailAttributes:
      title: ScriptExecutionDetailAttributes
      type: object
      properties:
        id:
          type: string
        jobId:
          type: string
        operationType:
          type: string
        scriptExecutionTime:
          type: string
          format: date-time
        scriptName:
          type: string
        scriptExecutionStatus:
          type: string
        details:
          type: string
        targetNEs:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        mcpUser:
          type: string
        executionType:
          $ref: '#/components/schemas/ExecutionType'
        scheduleName:
          type: string
    ScriptExecutionDetailsData:
      title: ScriptExecutionDetailsData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ScriptExecutionDetailAttributes'
    ScriptExecutionDetailsList:
      title: ScriptExecutionDetailsList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScriptExecutionDetailsData'
          description: ''
    ScriptProfile:
      title: ScriptProfile
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScriptProfileData'
    ScriptProfileAttributes:
      title: ScriptProfileAttributes
      type: object
      properties:
        profileName:
          type: string
        profileParams:
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePair'
          description: ''
    ScriptProfileData:
      title: ScriptProfileData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ScriptProfileAttributes'
    ScriptProfileList:
      title: ScriptProfileList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScriptProfileData'
          description: ''
    ScriptRelationship:
      title: ScriptRelationship
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScriptRelationshipData'
    ScriptRelationshipData:
      title: ScriptRelationshipData
      type: object
      properties:
        type:
          type: string
        id:
          type: string
    ScriptRelationships:
      title: ScriptRelationships
      type: object
      properties:
        profile:
          $ref: '#/components/schemas/ScriptRelationship'
        userdata:
          $ref: '#/components/schemas/ScriptRelationship'
    ScriptResult:
      title: ScriptResult
      type: object
      properties:
        scriptName:
          type: string
        status:
          type: string
        commandResults:
          type: array
          items:
            $ref: '#/components/schemas/CommandResult'
          description: ''
    ScriptResultAttributes:
      title: ScriptResultAttributes
      type: object
      properties:
        scriptResults:
          type: array
          items:
            $ref: '#/components/schemas/ScriptResult'
          description: ''
    StopUpgradeAttributes:
      title: StopUpgradeAttributes
      type: object
      properties:
        networkConstructNames:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    SystemSettings:
      title: SystemSettings
      type: object
      properties:
        alarmCorrelation:
          type: string
        darkFiberLossMeasurement:
          type: string
        autoFacilityProvisioning:
          type: string
        autoRouteProvisioning:
          type: string
        coherentSelectControl:
          type: string
        highFiberLossDetectionAlarm:
          type: string
        autoGCC0Provisioning:
          type: string
        autoGCC1Provisioning:
          type: string
        laserOffFarEndFail:
          type: string
        autoNDPProvisioning:
          type: string
        shelfSynch:
          type: string
    TransportResourceAttributes:
      title: TransportResourceAttributes
      type: object
      properties:
        ncId:
          type: string
        state:
          $ref: '#/components/schemas/State17'
    TransportResourceData:
      title: TransportResourceData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type52'
        attributes:
          $ref: '#/components/schemas/TransportResourceAttributes'
    TransportResourceList:
      title: TransportResourceList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransportResourceData'
          description: ''
    UpgradeOperationDetails:
      title: UpgradeOperationDetails
      type: object
      properties:
        manualInvoke:
          type: boolean
          default: false
        isWorkFlow:
          type: boolean
          default: false
        haltOnUpgradeFailure:
          type: boolean
          default: false
        sequenceOrder:
          type: integer
          format: int32
        mcpManaged:
          type: boolean
          default: false
        pendingQueue:
          type: integer
          format: int32
        stage:
          type: string
        status:
          type: string
        schedules:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    UpgradeStatus:
      title: UpgradeStatus
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/UpgradeStatusAttributes'
    UpgradeStatusAttributes:
      title: UpgradeStatusAttributes
      type: object
      properties:
        networkConstructName:
          type: string
        isWorkFlow:
          type: boolean
          default: false
        shelf:
          type: string
        equipment:
          type: string
        stage:
          type: string
        result:
          type: string
        fpgaApplied:
          type: boolean
          default: false
        featureList:
          type: array
          items:
            type: string
          description: ''
        statusList:
          type: array
          items:
            type: string
          description: ''
    UpgradeStatusResponse:
      title: UpgradeStatusResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UpgradeStatus'
          description: ''
    UserInput:
      title: UserInput
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserInputData'
        included:
          type: array
          items:
            $ref: '#/components/schemas/Included'
          description: ''
    UserInputData:
      title: UserInputData
      type: object
      properties:
        type:
          type: string
        attributes:
          type: object
        batchattributes:
          $ref: '#/components/schemas/BatchAttributes'
        relationships:
          $ref: '#/components/schemas/Relationships'
    VpnResource:
      title: VpnResource
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/VpnResourceAttributes'
    VpnResourceAttributes:
      title: VpnResourceAttributes
      type: object
      properties:
        networkConstructId:
          type: string
        name:
          type: string
        associatedEntity:
          type: string
        state:
          type: string
        routeTargets:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        evis:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        bindingSIDs:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        serviceIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
    VpnResourceCollection:
      title: VpnResourceCollection
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        links:
          $ref: '#/components/schemas/Links'
        data:
          type: array
          items:
            $ref: '#/components/schemas/VpnResource'
          description: ''
    NEConnectionProfileAttributesV3RO:
      title: NEConnectionProfileAttributesV3RO
      type: object
      properties:
        name:
          type: string
          description: Name of the NE Connection Profile
        profileDescription:
          type: string
          description: A short description of the NE Connection Profile
        typeGroup:
          type: string
          description: The NE Type Group which supports this profile
        isDefault:
          type: boolean
          description: Indicates if this is a default NE Connection Profile
          default: false
        isEnabled:
          type: boolean
          description: Indicates if this NE Connection Profile is enabled
          default: false
        protocolEndpoints:
          type: object
    NEConnectionProfileDataV3RO:
      title: NEConnectionProfileDataV3RO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the NE Connection Profile resource
        type:
          $ref: '#/components/schemas/Type53'
        attributes:
          $ref: '#/components/schemas/NEConnectionProfileAttributesV3RO'
    NEConnectionProfileListV3RO:
      title: NEConnectionProfileListV3RO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NEConnectionProfileDataV3RO'
          description: ''
        links:
          $ref: '#/components/schemas/LinksRO'
    NEConnectionProfileV3RO:
      title: NEConnectionProfileV3RO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/NEConnectionProfileDataV3RO'
    ManagementSessionAttributesRO:
      title: ManagementSessionAttributesRO
      type: object
      properties:
        displayData:
          $ref: '#/components/schemas/ManagementSessionDisplayDataRO'
        ipAddress:
          type: string
          description: the manual enrollment address of the management session. An auto enrolled NE (such as RNE) has no enrollment address.
        typeGroup:
          type: string
          description: Resource adapter type group.
        name:
          type: string
          description: Name (e.g. TID) of the Network Construct
        longName:
          type: string
          description: Extended name of the Network Construct
        profile:
          type: string
          description: Id of the NE-Security profile.
        profileName:
          type: string
          description: Name of the NE-Security profile
        resourceType:
          type: string
          description: Resource Type.
        discoveryState:
          $ref: '#/components/schemas/DiscoveryState'
        enrollmentTime:
          type: string
          description: Date when the management session is enrolled.
        created:
          type: string
          description: Date when the management session is created.
        lastResyncTime:
          type: string
          description: Date when the management session is resync last time.
        associationState:
          $ref: '#/components/schemas/AssociationState1'
        associationStateQualifier:
          $ref: '#/components/schemas/AssociationStateQualifier'
        associationStateQualifierReason:
          type: string
          description: Reason for going into maintenance mode.
        associationStateLastUpdatedTime:
          type: string
          description: Date at which we last changed association state.
        failReason:
          type: string
          description: Failure Reason when processing this network construct.
        pokeCount:
          type: integer
          description: Number of times this network construct was poked.
          format: int64
        pokeInterval:
          type: integer
          description: The delay between pokes.
          format: int64
        lastPokeTime:
          type: integer
          description: The last time this network construct was poked.
          format: int64
        failureUpdatedTime:
          type: integer
          description: The amount of time it took to fail to update
          format: int64
        managementAddresses:
          type: array
          items:
            type: string
          description: public IPs addresses of the NE's shelves. The management session connects to the NE at one of the management addresses.
        sessionType:
          $ref: '#/components/schemas/SessionType1'
        onPreferredGNE:
          type: boolean
          description: indicate that the NE is connected through the preferred connection.
          default: false
        connectionAddress:
          type: string
          description: active connection address to the NE.
        preferredConnectionAddress:
          $ref: '#/components/schemas/ManagementSessionConnectionAttributesRO'
        additionalIpAddresses:
          uniqueItems: true
          type: array
          items:
            type: string
          description: additional IP addresses to the NE.
        alternateConnectionAddresses:
          type: array
          items:
            $ref: '#/components/schemas/ManagementSessionConnectionAttributesRO'
          description: alternate access IPs addresses to the NE.
        connectionStates:
          type: array
          items:
            $ref: '#/components/schemas/ManagementSessionEndpointStateRO'
          description: ''
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Resource partitioning info.
        additionalAttributes:
          type: object
    ManagementSessionConnectionAttributesRO:
      title: ManagementSessionConnectionAttributesRO
      type: object
      properties:
        address:
          type: string
          description: Connection address of the NE
        cost:
          type: integer
          description: Connection cost of the address (optional)
          format: int32
    ManagementSessionDataRO:
      title: ManagementSessionDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the NetworkConstruct resource
        type:
          $ref: '#/components/schemas/Type54'
        attributes:
          $ref: '#/components/schemas/ManagementSessionAttributesRO'
        relationships:
          $ref: '#/components/schemas/ManagementSessionRelationshipsRO'
    ManagementSessionDisplayDataRO:
      title: ManagementSessionDisplayDataRO
      type: object
      properties:
        displayName:
          type: string
          description: Name of the Management Session
        displayState:
          $ref: '#/components/schemas/DisplayState1'
        displayPreferredConnectionName:
          type: string
          description: Preferred connection name of the Management Session
        displayPartitions:
          type: object
          description: Partition names of the management session
        displayAlternativeConnectionIPs:
          type: object
          description: Alternative connection IPs of the management session
        displayAlternativeConnectionNames:
          type: object
          description: Alternative connection names of the management session
        profileName:
          type: string
          description: Name of the NE profile
        shortResourceType:
          type: string
          description: Short Resource Type. If resourceType is 'Waveserver' or 'Waveserver Ai', shortResourceType is 'WS'. If resourceType is 'SubCom', shortResourceType is 'TEMS'. Otherwise, the value of resourceType and shortResourceType are the same.
    ManagementSessionEndpointStateRO:
      title: ManagementSessionEndpointStateRO
      type: object
      properties:
        protocolType:
          type: string
          description: The type of protocol used to connect to the network construct (e.g. TL1, SNMP, CLI, etc.)
        connectionState:
          type: string
          description: Connection state of the endpoint.
    ManagementSessionListRO:
      title: ManagementSessionListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ManagementSessionDataRO'
          description: ''
    ManagementSessionPatchOperationRO:
      title: ManagementSessionPatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op6'
        reason:
          type: string
          description: Reason for putting a Management Session to inMaintenance mode.
        syncComponent:
          $ref: '#/components/schemas/SyncComponent'
        attributes:
          $ref: '#/components/schemas/ManagementSessionAttributesRO'
    ManagementSessionPatchRO:
      title: ManagementSessionPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/ManagementSessionPatchOperationRO'
          description: ''
    ManagementSessionRO:
      title: ManagementSessionRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ManagementSessionDataRO'
    ManagementSessionRelationshipsRO:
      title: ManagementSessionRelationshipsRO
      type: object
      properties:
        preferredGateway:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        alternativeGateways:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        extendedSessions:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    NetworkConstructExpectationAttributesRO:
      title: NetworkConstructExpectationAttributesRO
      type: object
      properties:
        policies:
          type: array
          items:
            type: object
          description: Policies to be applied to the entity.
        startDate:
          type: string
          description: The scheduled start date and time of the expectation, with RFC 3339 date-time format
        endDate:
          type: string
          description: The scheduled end date and time of the expectation, with RFC 3339 date-time format
        ipAddress:
          type: string
          description: IP address of the network construct.
        typeGroup:
          type: string
          description: Resource adapter type group.
        resourceType:
          type: string
          description: Resource Type.
        deviceType:
          type: string
          description: Device Type.
        softwareVersion:
          type: string
          description: Software version running in the device.
        nativeSoftwareVersion:
          type: string
          description: Native Software version running in the device.
        accessIdentifier:
          type: string
          description: 'AID of the device, i.e. for 6500 shelf : SHELF-n.'
        macAddress:
          type: string
          description: MAC address of the device.
        name:
          type: string
          description: Name (e.g. TID) of the Network Construct
        longName:
          type: string
          description: Extended name of the Network Construct
        geoLocation:
          $ref: '#/components/schemas/GeoLocationRO'
        serialNumber:
          type: string
          description: Serial number (e.g. NNTMHQDP0001)
        deviceVersion:
          type: string
          description: Device version (e.g. 6500 32-SLOT OPTICAL)
        softwareType:
          type: string
          description: Software type (e.g. OCP)
        softwareImage:
          type: string
          description: Software image
        subnetName:
          type: string
          description: Subnet name (e.g. ROADM1---ROADM2---SUBNET)
        numberOfShelves:
          type: integer
          description: Number of shelves (primary + member shelves in case of TIDc)
          format: int32
        memberShelvesData:
          type: array
          items:
            $ref: '#/components/schemas/ShelfDataRO'
          description: It represents the shelf data on the NE.
        memberFunction:
          $ref: '#/components/schemas/MemberFunction'
        shelfType:
          $ref: '#/components/schemas/ShelfType'
        capabilitySpecRef:
          type: string
          description: Name of the file which contains the constraint rules of the network device.
        modelType:
          $ref: '#/components/schemas/ModelType'
        networkConstructType:
          $ref: '#/components/schemas/NetworkConstructType'
        l2Data:
          type: array
          items:
            $ref: '#/components/schemas/L2DataRO'
          description: It represents the L2 Configuration Data on the NE.
        l0Data:
          $ref: '#/components/schemas/L0DataRO'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the NE belongs to.
        associationState:
          $ref: '#/components/schemas/AssociationState'
        associationStateQualifier:
          $ref: '#/components/schemas/AssociationStateQualifier'
        associationStateQualifierReason:
          type: string
          description: Reason for going into maintenance mode.
        associationStateLastUpdatedTime:
          type: string
          description: Date at which we last changed association state.
        ipCommunicationDetails:
          $ref: '#/components/schemas/IPCommunicationDetailsRO'
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
        managementAddresses:
          type: array
          items:
            type: string
          description: IP address of the shelf(ves). This is a passive attribute that isn't used to create connections to the NE (conn-addrs are).
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared Srlgs on this NC.
        siteId:
          type: string
          description: Site ID for the networkConstruct
        siteName:
          type: string
          description: Site name for the networkConstruct
        packetData:
          type: array
          items:
            $ref: '#/components/schemas/PacketDataRO'
          description: Holds packet infra data.
    NetworkConstructExpectationDataRO:
      title: NetworkConstructExpectationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the network construct expectation
        type:
          $ref: '#/components/schemas/Type55'
        attributes:
          $ref: '#/components/schemas/NetworkConstructExpectationAttributesRO'
        relationships:
          $ref: '#/components/schemas/NetworkConstructExpectationRelationshipsRO'
    NetworkConstructExpectationRO:
      title: NetworkConstructExpectationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/NetworkConstructExpectationDataRO'
    NetworkConstructExpectationRelationshipsRO:
      title: NetworkConstructExpectationRelationshipsRO
      type: object
      properties:
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        serviceIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        intent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        physicalLocation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        parentNetworkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        childrenNetworkConstruct:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concreteAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        groups:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    NetworkConstructPatchOperationRO:
      title: NetworkConstructPatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op7'
        attributes:
          $ref: '#/components/schemas/NetworkConstructAttributesRO'
        attribute:
          type: string
          description: Name of an attribute to be deleted
        keys:
          type: array
          items:
            type: string
          description: Used to target specific key(s) of the attribute to be deleted
        srlgRelationships:
          $ref: '#/components/schemas/SrlgPatchDataRO'
        relationships:
          $ref: '#/components/schemas/NetworkConstructPlannedRelationshipsRO'
        path:
          type: string
          description: Used to target the specific attribute for deleting
        identifier:
          type: string
          description: Name of the interface details object
    NetworkConstructPatchRO:
      title: NetworkConstructPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/NetworkConstructPatchOperationRO'
          description: ''
    NetworkConstructPlannedAttributesRO:
      title: NetworkConstructPlannedAttributesRO
      type: object
      properties:
        ipAddress:
          type: string
          description: IP address of the network construct.
        typeGroup:
          type: string
          description: Resource adapter type group.
        resourceType:
          type: string
          description: Resource Type.
        deviceType:
          type: string
          description: Device Type.
        softwareVersion:
          type: string
          description: Software version running in the device.
        nativeSoftwareVersion:
          type: string
          description: Native Software version running in the device.
        accessIdentifier:
          type: string
          description: 'AID of the device, i.e. for 6500 shelf : SHELF-n.'
        macAddress:
          type: string
          description: MAC address of the device.
        name:
          type: string
          description: Name (e.g. TID) of the Network Construct
        longName:
          type: string
          description: Extended name of the Network Construct
        geoLocation:
          $ref: '#/components/schemas/GeoLocationRO'
        serialNumber:
          type: string
          description: Serial number (e.g. NNTMHQDP0001)
        deviceVersion:
          type: string
          description: Device version (e.g. 6500 32-SLOT OPTICAL)
        softwareType:
          type: string
          description: Software type (e.g. OCP)
        softwareImage:
          type: string
          description: Software image
        subnetName:
          type: string
          description: Subnet name (e.g. ROADM1---ROADM2---SUBNET)
        numberOfShelves:
          type: integer
          description: Number of shelves (primary + member shelves in case of TIDc)
          format: int32
        memberShelvesData:
          type: array
          items:
            $ref: '#/components/schemas/ShelfDataRO'
          description: It represents the shelf data on the NE.
        memberFunction:
          $ref: '#/components/schemas/MemberFunction'
        shelfType:
          $ref: '#/components/schemas/ShelfType'
        capabilitySpecRef:
          type: string
          description: Name of the file which contains the constraint rules of the network device.
        modelType:
          $ref: '#/components/schemas/ModelType'
        networkConstructType:
          $ref: '#/components/schemas/NetworkConstructType'
        l2Data:
          type: array
          items:
            $ref: '#/components/schemas/L2DataRO'
          description: It represents the L2 Configuration Data on the NE.
        l0Data:
          $ref: '#/components/schemas/L0DataRO'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the NE belongs to.
        associationState:
          $ref: '#/components/schemas/AssociationState'
        associationStateQualifier:
          $ref: '#/components/schemas/AssociationStateQualifier'
        associationStateQualifierReason:
          type: string
          description: Reason for going into maintenance mode.
        associationStateLastUpdatedTime:
          type: string
          description: Date at which we last changed association state.
        ipCommunicationDetails:
          $ref: '#/components/schemas/IPCommunicationDetailsRO'
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
        managementAddresses:
          type: array
          items:
            type: string
          description: IP address of the shelf(ves). This is a passive attribute that isn't used to create connections to the NE (conn-addrs are).
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared Srlgs on this NC.
        siteId:
          type: string
          description: Site ID for the networkConstruct
        siteName:
          type: string
          description: Site name for the networkConstruct
        packetData:
          type: array
          items:
            $ref: '#/components/schemas/PacketDataRO'
          description: Holds packet infra data.
    NetworkConstructPlannedDataRO:
      title: NetworkConstructPlannedDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the network construct planned
        type:
          $ref: '#/components/schemas/Type56'
        attributes:
          $ref: '#/components/schemas/NetworkConstructPlannedAttributesRO'
        relationships:
          $ref: '#/components/schemas/NetworkConstructPlannedRelationshipsRO'
    NetworkConstructPlannedRO:
      title: NetworkConstructPlannedRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/NetworkConstructPlannedDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    NetworkConstructPlannedRelationshipsRO:
      title: NetworkConstructPlannedRelationshipsRO
      type: object
      properties:
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        serviceIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        manualSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicAutoSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicInheritedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicPropagatedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        manualShareSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicPropagatedShareSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        physicalLocation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        parentNetworkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        childrenNetworkConstruct:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concreteAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        groups:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    NetworkConstructRO:
      title: NetworkConstructRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        data:
          $ref: '#/components/schemas/NetworkConstructDataRO'
        included:
          type: array
          items:
            type: object
          description: Referenced resources (discovered, planned, expectations, physical locations, or parent/child Network Constructs)
    PhysicalLocationAttributesRO:
      title: PhysicalLocationAttributesRO
      type: object
      properties:
        userData:
          type: object
        identifiers:
          type: array
          items:
            type: object
          description: ''
        policies:
          $ref: '#/components/schemas/AttributePoliciesRO'
        name:
          type: string
          description: Name of the physical location.
        geoLocation:
          $ref: '#/components/schemas/GeoLocationRO'
        additionalAttributes:
          type: object
    PhysicalLocationDataRO:
      title: PhysicalLocationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the physical location
        type:
          $ref: '#/components/schemas/Type57'
    PhysicalLocationExpectationAttributesRO:
      title: PhysicalLocationExpectationAttributesRO
      type: object
      properties:
        intentId:
          type: string
          description: The intent id of the physical expectation location
        name:
          type: string
          description: Name of the physical location.
        geoLocation:
          $ref: '#/components/schemas/GeoLocationRO'
        additionalAttributes:
          type: object
    PhysicalLocationExpectationDataRO:
      title: PhysicalLocationExpectationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the physical location
        type:
          $ref: '#/components/schemas/Type58'
        attributes:
          $ref: '#/components/schemas/PhysicalLocationExpectationAttributesRO'
    PhysicalLocationExpectationRO:
      title: PhysicalLocationExpectationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PhysicalLocationExpectationDataRO'
    PhysicalLocationListRO:
      title: PhysicalLocationListRO
      type: object
      properties:
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/PhysicalLocationDataRO'
          description: ''
    PhysicalLocationRO:
      title: PhysicalLocationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PhysicalLocationDataRO'
    PhysicalLocationRelationshipsRO:
      title: PhysicalLocationRelationshipsRO
      type: object
      properties:
        physicalLocationPlanned:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        physicalLocationExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        physicalLocationDiscovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    FreqGlobalRo:
      title: FreqGlobalRo
      type: object
      properties:
        eqptId:
          type: string
          description: The equipment group ID for timing nodes which may include multiple shelves
        clockState:
          $ref: '#/components/schemas/ClockState'
        adminState:
          $ref: '#/components/schemas/AdminState10'
        networkOption:
          type: string
          description: The network option configuration.
        reversionMode:
          $ref: '#/components/schemas/ReversionMode'
        waitToRestore:
          type: string
        holdoverInterval:
          type: string
          description: The holdover interval
        internalOcxoQualLevel:
          type: string
          description: The internal OCXO quality level
        selectedInputRef:
          type: string
          description: The currently selected timing reference
        durationSeconds:
          type: string
          description: The elapsed time since the selected reference was selected
    FreqRefAttributesRo:
      title: FreqRefAttributesRo
      type: object
      properties:
        eqptId:
          type: string
          description: The equipment group ID for timing nodes which may include multiple shelves
        name:
          type: string
          description: The input or output frequency reference name
        direction:
          $ref: '#/components/schemas/Direction15'
        shelfNumber:
          type: string
          description: The shelf number if applicable
        eqptGrpNumber:
          type: string
          description: The equipmentGroup number if applicable
        interface:
          type: string
          description: The timing interface port number
        operState:
          $ref: '#/components/schemas/OperState1'
        priority:
          type: string
          description: The timing reference priority
        operQualLevel:
          $ref: '#/components/schemas/OperQualLevel'
        qualLevel:
          $ref: '#/components/schemas/OperQualLevel'
        ssm:
          type: string
          description: The SSM quality level
        supportingPtpId:
          type: string
          description: The ID of the supporting PTP
        timingLinkId:
          type: string
          description: The ID of the TimingLink when discovered
    FreqRefRo:
      title: FreqRefRo
      type: object
      properties:
        id:
          type: string
          description: The ID of the frequency timing reference. Format 'SYNCE_{IN|OUT}_{shelfNumber}_{eqptGrpNumber}_{interface}'
        type:
          $ref: '#/components/schemas/Type59'
        attributes:
          $ref: '#/components/schemas/FreqRefAttributesRo'
    OneToOneRelationshipRo1:
      title: OneToOneRelationshipRo1
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RelationshipDataRO'
    PhaseGlobalRo:
      title: PhaseGlobalRo
      type: object
      properties:
        eqptId:
          type: string
          description: The equipment group ID for timing nodes which may include multiple shelves
        clockState:
          $ref: '#/components/schemas/ClockState'
        clockType:
          $ref: '#/components/schemas/ClockType'
        profile:
          type: string
          description: The PTP telecom profile (e.g. G.8275.1)
        clockIdent:
          type: string
          description: The clock identity
        clockClass:
          type: string
          description: The clock class
        clockAccuracy:
          type: string
          description: The clock accuracy
        parentPortClockIdent:
          type: string
          description: The identity of the parent port clock
        parentPortNum:
          type: string
          description: The port number of the parent port
        gmIdent:
          type: string
          description: The identity of the grandmaster clock
        gmClockClass:
          type: string
          description: The quality class of the grandmaster clock
        gmClockAccuracy:
          type: string
          description: The accuracy of the grandmaster clock
        selectedInputRef:
          type: string
          description: The currently selected timing reference
        durationSeconds:
          type: string
          description: The elapsed time since the selected reference was selected
    PhaseRefAttributesRo:
      title: PhaseRefAttributesRo
      type: object
      properties:
        eqptId:
          type: string
          description: The equipment group ID for timing nodes which may include multiple shelves
        name:
          type: string
          description: The input or output phase reference name
        direction:
          $ref: '#/components/schemas/Direction15'
        shelfNumber:
          type: string
          description: The shelf number if applicable
        eqptGrpNumber:
          type: string
          description: The equipmentGroup number if applicable
        interface:
          type: string
          description: The timing interface port number
        operState:
          $ref: '#/components/schemas/OperState1'
        stepsRemoved:
          type: string
          description: The number of steps removed from the grandmaster clock
        portNumber:
          type: string
          description: The port number of the timing reference
        portState:
          $ref: '#/components/schemas/PortState2'
        parentPortClockIdent:
          type: string
          description: The identity of the parent port clock
        parentPortNum:
          type: string
          description: The port number of the parent port
        gmIdent:
          type: string
          description: The identity of the grandmaster clock
        supportingPtpId:
          type: string
          description: The ID of the supporting PTP
        timingLinkId:
          type: string
          description: The ID of the TimingLink when discovered
    PhaseRefRo:
      title: PhaseRefRo
      type: object
      properties:
        id:
          type: string
          description: The ID of the phase timing reference. Format 'PTP_{IN|OUT}_{shelfNumber}_{eqptGrpNumber}_{interface}'
        type:
          $ref: '#/components/schemas/Type60'
        attributes:
          $ref: '#/components/schemas/PhaseRefAttributesRo'
    TimingLinkAttributesRo:
      title: TimingLinkAttributesRo
      type: object
      properties:
        layer:
          $ref: '#/components/schemas/Layer4'
        fromRef:
          type: string
          description: The internal TimingNode layer ref ID - the source endpoint
        toRef:
          type: string
          description: The internal TimingNode layer ref ID - the destination/target endpoint
        lagFreId:
          type: string
          description: The LAG FRE ID if this link supporting LLDP FRE supports a LAG
    TimingLinkRelationshipsRo:
      title: TimingLinkRelationshipsRo
      type: object
      properties:
        supportingFre:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        fromNetworkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        fromTimingNode:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        toNetworkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        toTimingNode:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
    TimingLinkResourceRo:
      title: TimingLinkResourceRo
      type: object
      properties:
        id:
          type: string
          description: The TimingLink resource identifier.
        type:
          $ref: '#/components/schemas/Type61'
        relationships:
          $ref: '#/components/schemas/TimingLinkRelationshipsRo'
        attributes:
          $ref: '#/components/schemas/TimingLinkAttributesRo'
        additionalAttributes:
          type: object
    TimingNodeAttributesRo:
      title: TimingNodeAttributesRo
      type: object
      properties:
        phaseGlobal:
          type: array
          items:
            $ref: '#/components/schemas/PhaseGlobalRo'
          description: The list of TimingNode Phase attributes by equipmentGroups
        freqGlobal:
          type: array
          items:
            $ref: '#/components/schemas/FreqGlobalRo'
          description: The list of TimingNode Frequency attributes by equipmentGroups
        phaseRefs:
          type: array
          items:
            $ref: '#/components/schemas/PhaseRefRo'
          description: The list of TimingNode phase endpoints
        freqRefs:
          type: array
          items:
            $ref: '#/components/schemas/FreqRefRo'
          description: The list of TimingNode Frequency endpoints
        geohash:
          type: string
          description: The GEO HASH as assigned to the NC for this node
        neName:
          type: string
          description: The name of the NC for this node
        synchronizedTimestamp:
          type: string
          description: The date and time when this TimingNode data was synchronized from the NE
    TimingNodeDataRo:
      title: TimingNodeDataRo
      type: object
      properties:
        id:
          type: string
          description: "The TimingNode identifier. Format: '{ncId}::TIMING'"
        type:
          $ref: '#/components/schemas/Type62'
        attributes:
          $ref: '#/components/schemas/TimingNodeAttributesRo'
        relationships:
          $ref: '#/components/schemas/TimingNodeRelationshipsRo'
    TimingNodeRelationshipsRo:
      title: TimingNodeRelationshipsRo
      type: object
      properties:
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
    TimingNodeRo:
      title: TimingNodeRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TimingNodeDataRo'
        included:
          type: array
          items:
            $ref: '#/components/schemas/TimingLinkResourceRo'
          description: The Timing Node included resources
    CaptureAvailabilityRO:
      title: CaptureAvailabilityRO
      type: object
      properties:
        originalFilename:
          type: string
          readOnly: true
        internalFilename:
          type: string
          readOnly: true
        locationOnSFTP:
          type: string
          readOnly: true
        availableLocally:
          type: boolean
          default: false
          readOnly: true
        availableOnSFTP:
          type: boolean
          default: false
          readOnly: true
        captureAvailabilityState:
          $ref: '#/components/schemas/CaptureAvailabilityState'
    CaptureSummaryRO:
      title: CaptureSummaryRO
      type: object
      properties:
        source:
          type: string
          readOnly: true
        fileName:
          type: string
          readOnly: true
        remoteFileLocation:
          type: string
          readOnly: true
        snapshotTimestamp:
          type: string
          readOnly: true
        availableExternally:
          type: boolean
          default: false
        captureAvailability:
          $ref: '#/components/schemas/CaptureAvailabilityRO'
    CardsRO:
      title: CardsRO
      type: object
      properties:
        reportType:
          type: string
          readOnly: true
        schema:
          $ref: '#/components/schemas/ReportSchema'
    ColumnDescription:
      title: ColumnDescription
      type: object
      properties:
        id:
          type: string
          readOnly: true
        field:
          type: string
          readOnly: true
        label:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        subtype:
          type: string
          readOnly: true
    DeleteCaptureRO:
      title: DeleteCaptureRO
      type: object
      properties:
        local:
          type: boolean
          default: false
        remote:
          type: boolean
          default: false
    OMSReportRow:
      title: OMSReportRow
      type: object
      properties:
        id:
          type: string
          format: uuid
        gridType:
          type: string
        growthTrend:
          $ref: '#/components/schemas/ReportLink'
        domain:
          type: string
        spectrumGrowthTrend:
          $ref: '#/components/schemas/ReportLink'
        minSnr:
          type: number
        deltaSnrPlanned:
          type: number
        deltaSnrReference:
          type: number
        equivRefSpans:
          type: number
        minSnrTrend:
          $ref: '#/components/schemas/ReportLink'
        omsname:
          type: string
        section:
          type: string
        fibers:
          $ref: '#/components/schemas/ReportLink'
        clientServices:
          $ref: '#/components/schemas/ReportLink'
        photonicServices:
          $ref: '#/components/schemas/ReportLink'
        wavelengths:
          $ref: '#/components/schemas/ReportLink'
        provisionedBw:
          type: number
        usedBw:
          type: number
        predictedFiberExhaustDate:
          type: string
        predictedSpectrumFiberExhaustDate:
          type: string
        totalCapacity:
          type: number
        provisionedCapacity:
          type: number
        provisionedCapacityPercentage:
          type: number
        serviceUtilization:
          type: number
        remainingBw:
          type: number
    ReportFilter:
      title: ReportFilter
      type: object
      properties:
        attribute:
          type: string
        values:
          type: array
          items:
            type: string
          description: ''
    ReportLink:
      title: ReportLink
      type: object
      properties:
        title:
          type: string
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ReportFilter'
          description: ''
    ReportRO:
      title: ReportRO
      type: object
      properties:
        snapshotTimestamp:
          type: string
        reportName:
          type: string
        reportType:
          type: string
        isDelta:
          type: boolean
          default: false
        version:
          type: string
        rows:
          type: array
          items:
            type: object
          description: ''
        schema:
          $ref: '#/components/schemas/ReportSchema'
    ReportSchema:
      title: ReportSchema
      type: object
      properties:
        columns:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ColumnDescription'
          readOnly: true
    ReportSummaryRO:
      title: ReportSummaryRO
      type: object
      properties:
        reportsAvailable:
          type: array
          items:
            type: string
            format: uuid
          description: ''
          readOnly: true
        reportGenerationTimestamp:
          type: string
          readOnly: true
        statistics:
          type: object
          additionalProperties:
            type: integer
            format: int32
          readOnly: true
    ResourceEnvelopeSFTPConfigurationRequest:
      title: ResourceEnvelopeSFTPConfigurationRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceObjectSFTPConfigurationRequest'
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        included:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ResourceObjectObject'
          description: ''
    ResourceEnvelopeScheduleRO:
      title: ResourceEnvelopeScheduleRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceObjectScheduleRO'
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        included:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ResourceObjectObject'
          description: ''
    ResourceEnvelopeSnapshotRO:
      title: ResourceEnvelopeSnapshotRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceObjectSnapshotRO'
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        included:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ResourceObjectObject'
          description: ''
    ResourceObjectSFTPConfigurationRequest:
      title: ResourceObjectSFTPConfigurationRequest
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        relationships:
          type: object
          additionalProperties:
            type: object
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        attributes:
          $ref: '#/components/schemas/SFTPConfigurationRequest'
    ResourceObjectScheduleRO:
      title: ResourceObjectScheduleRO
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        relationships:
          type: object
          additionalProperties:
            type: object
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        attributes:
          $ref: '#/components/schemas/ScheduleRO'
    ResourceObjectSnapshotRO:
      title: ResourceObjectSnapshotRO
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        relationships:
          type: object
          additionalProperties:
            type: object
        links:
          type: object
          additionalProperties:
            type: object
        meta:
          type: object
          additionalProperties:
            type: object
        attributes:
          $ref: '#/components/schemas/SnapshotRO'
    SFTPConfigurationRequest:
      title: SFTPConfigurationRequest
      type: object
      properties:
        host:
          type: string
        port:
          type: integer
          format: int32
        username:
          type: string
        password:
          type: string
        rootDir:
          type: string
    ScheduleRO:
      title: ScheduleRO
      type: object
      properties:
        schedule:
          $ref: '#/components/schemas/Schedule'
        enabled:
          type: boolean
          default: false
          readOnly: true
        creationTimestamp:
          type: string
    SectionReportResponseRO:
      title: SectionReportResponseRO
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: '#/components/schemas/OMSReportRow'
          description: ''
        snapshotId:
          type: string
          format: uuid
    SnapshotRO:
      title: SnapshotRO
      type: object
      properties:
        state:
          $ref: '#/components/schemas/State18'
        status:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
        reportSummary:
          $ref: '#/components/schemas/ReportSummaryRO'
        captureSummary:
          $ref: '#/components/schemas/CaptureSummaryRO'
        mode:
          $ref: '#/components/schemas/Mode2'
    TrendGroup:
      title: TrendGroup
      type: object
      properties:
        trendPoints:
          type: array
          items:
            $ref: '#/components/schemas/TrendPoint'
          description: ''
    TrendGroupRO:
      title: TrendGroupRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TrendGroup'
    TrendPoint:
      title: TrendPoint
      type: object
      properties:
        trendName:
          type: string
        entityName:
          type: string
        captureDate:
          type: string
          format: date-time
        snapshotID:
          type: string
          format: uuid
        valueName:
          type: string
        stringValue:
          type: string
        doubleValue:
          type: number
    startstoptrace:
      title: startstoptrace
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters'
      description: Parameters for start/stop  trace.
    sordownloadv1:
      title: sordownloadv1
      type: object
      properties:
        trace_id:
          type: string
          default: OTDRCFG-1-1-8
        trace_tag:
          type: string
          default: current
        trace_type:
          type: string
          default: long
      description: Parameters for SOR download.
    sordownloadv2:
      title: sordownloadv2
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters1'
      description: Parameters for SOR download.
    otdrprofile:
      title: otdrprofile
      type: object
      properties:
        description:
          type: string
          description: Supports alphanumeric characters, space, hyphen and underscore only.
          default: '2000'
        passwd:
          type: string
          description: Supports any character except single/double quotes and @ symbol.
          default: password
        user_name:
          type: string
          description: Supports any character except single/double quotes and @ symbol.
          default: admin
        port:
          type: string
          default: '22'
        profile_name:
          type: string
          description: Supports alphanumeric characters and underscore only.
          default: test
        location:
          type: string
          default: /temp
        ip_address:
          type: string
          default: 1.1.1.1
        protocol_type:
          type: string
          default: sftp
      description: SOR download profile parameters.
    otdrentity:
      title: otdrentity
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters2'
      description: OTDR entity edit parameters.
    otdrtraceprofiles:
      title: otdrtraceprofiles
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters3'
      description: Parameters for OTDR trace profile.
    editsortrace:
      title: editsortrace
      required:
      - network_construct_id
      - trace_id
      - file_name
      - label
      type: object
      properties:
        network_construct_id:
          type: string
          description: Identifier of the Network Construct
        trace_id:
          type: string
          description: OTDR entity id
        file_name:
          type: string
          description: SOR Trace file name
        label:
          type: string
          description: Label for SOR Trace file
      description: Parameters for Edit SOR trace record label.
    parsesortrace:
      title: parsesortrace
      required:
      - file_names
      type: object
      properties:
        file_names:
          type: array
          items:
            type: string
          description: ''
      description: Parameters for retrieving parsed SOR trace file.
    ChanList:
      title: ChanList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ChanMargin'
          description: ''
        links:
          $ref: '#/components/schemas/LinksRO'
        meta:
          $ref: '#/components/schemas/MetaDataRO'
    ChanListV1:
      title: ChanListV1
      type: object
      properties:
        services:
          type: array
          items:
            $ref: '#/components/schemas/ChanMarginV1'
          description: ''
    ChanMargin:
      title: ChanMargin
      required:
      - valid
      type: object
      properties:
        direction:
          type: string
        freId:
          type: string
        layerRate:
          type: string
        maxMargin:
          type: number
        meanMargin:
          type: number
        minMargin:
          type: number
        oduFreId:
          type: string
        otsiFreId:
          type: string
        sdMargin:
          type: number
        status:
          type: string
        tpeId:
          type: string
        upgrMargin:
          type: number
        valid:
          type: boolean
        viable:
          type: string
    ChanMarginV1:
      title: ChanMarginV1
      required:
      - valid
      type: object
      properties:
        circuitId:
          type: string
        direction:
          type: string
        freId:
          type: string
        layerRate:
          type: string
        maxMargin:
          type: number
        meanMargin:
          type: number
        minMargin:
          type: number
        sdMargin:
          type: number
        status:
          type: string
        upgrMargin:
          type: number
        valid:
          type: boolean
        viable:
          type: string
    ConfigurationAttributesRO:
      title: ConfigurationAttributesRO
      type: object
      properties:
        safety:
          maximum: 10
          type: number
        validity:
          maximum: 35040
          minimum: 1
          type: integer
          format: int32
    FiberData:
      title: FiberData
      type: object
      properties:
        loss:
          type: string
    FiberList:
      title: FiberList
      type: object
      properties:
        links:
          $ref: '#/components/schemas/LinksRO'
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        services:
          type: array
          items:
            $ref: '#/components/schemas/FiberLoss'
          description: ''
    FiberListv1:
      title: FiberListv1
      type: object
      properties:
        links:
          $ref: '#/components/schemas/LinksRO'
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        services:
          type: array
          items:
            $ref: '#/components/schemas/FiberLossv1'
          description: ''
    FiberLoss:
      title: FiberLoss
      type: object
      properties:
        avgFiberSpanLoss:
          type: number
        avgFiberSpanLossSource:
          type: string
        avgFiberSpanLossTime:
          type: string
        avgOscLoss:
          type: number
        avgOscLossSource:
          type: string
        avgOscLossTime:
          type: string
        avgTotalPowerLoss:
          type: number
        avgTotalPowerLossTime:
          type: string
        currentLoss:
          type: number
        currentLossSource:
          type: string
        currentLossTime:
          type: string
        deltaPlannedToAvgFiberSpanLoss:
          type: number
        deltaPlannedToAvgOscLoss:
          type: number
        deltaPlannedToAvgTotalPowerLoss:
          type: number
        freId:
          type: string
        method:
          type: string
        plannedLoss:
          type: number
        plannedMargin:
          type: number
        status:
          type: string
    FiberLossv1:
      title: FiberLossv1
      type: object
      properties:
        deltaLoss:
          type: string
        freId:
          type: string
        measuredLoss:
          type: string
        measuredTime:
          type: string
        method:
          type: string
        plannedLoss:
          type: string
        plannedMargin:
          type: string
        status:
          type: string
    MarginDetails:
      title: MarginDetails
      required:
      - minMargin
      - valid
      type: object
      properties:
        direction:
          type: string
        endNcId:
          type: string
        endTpeId:
          type: string
        freId:
          type: string
        histogram:
          type: array
          items:
            type: integer
            format: int32
          description: ''
        intervals:
          type: integer
          format: int32
        maxMargin:
          type: number
        meanMargin:
          type: number
        minMargin:
          type: number
        oduFreId:
          type: string
        otsiFreId:
          type: string
        sdMargin:
          type: number
        startNcId:
          type: string
        startTpeId:
          type: string
        status:
          type: string
        timeEnd:
          type: string
        timeStart:
          type: string
        tpeId:
          type: string
        upgrMargin:
          type: number
        upgrRate:
          type: string
        valid:
          type: boolean
        viable:
          type: string
    MarginDetailsV1:
      title: MarginDetailsV1
      required:
      - minMargin
      - valid
      type: object
      properties:
        circuitId:
          type: string
        histogram:
          type: array
          items:
            type: integer
            format: int32
          description: ''
        intervals:
          type: integer
          format: int32
        maxMargin:
          type: number
        meanMargin:
          type: number
        minMargin:
          type: number
        sdMargin:
          type: number
        status:
          type: string
        timeEnd:
          type: string
        timeStart:
          type: string
        upgrMargin:
          type: number
        upgrRate:
          type: string
        valid:
          type: boolean
        viable:
          type: string
    MarginSummary:
      title: MarginSummary
      required:
      - counts
      - goodCount
      - totalCount
      type: object
      properties:
        counts:
          type: array
          items:
            $ref: '#/components/schemas/RateCount'
          description: ''
        goodCount:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PpgMarginSummary:
      title: PpgMarginSummary
      required:
      - roadmLine
      type: object
      properties:
        fiber:
          $ref: '#/components/schemas/PpgSummary'
        roadmLine:
          $ref: '#/components/schemas/PpgSummary'
    PpgMediaParams:
      title: PpgMediaParams
      type: object
      properties:
        chromatic dispersion (ps/nm):
          type: number
        distance (km):
          type: number
        freId:
          type: string
        latency (ms):
          type: number
    PpgPlannedSummary:
      title: PpgPlannedSummary
      type: object
      properties:
        above:
          type: integer
          format: int32
        below:
          type: integer
          format: int32
        normal:
          type: integer
          format: int32
    PpgSnrDetails:
      title: PpgSnrDetails
      type: object
      properties:
        expsmooth:
          type: number
        frequency_GHz:
          type: number
        max:
          type: number
        maxTime:
          type: string
        min:
          type: number
        minTime:
          type: string
        mostRecent:
          type: number
    PpgSummary:
      title: PpgSummary
      type: object
      properties:
        deltaReference:
          type: array
          items:
            type: number
          description: ''
        planned:
          $ref: '#/components/schemas/PpgPlannedSummary'
    RateCount:
      title: RateCount
      type: object
      properties:
        degradeCount:
          type: integer
          format: int32
        rate:
          type: string
        upgradeCount:
          type: integer
          format: int32
    Safety:
      title: Safety
      required:
      - factor
      type: object
      properties:
        factor:
          type: number
    Validity:
      title: Validity
      required:
      - factor
      type: object
      properties:
        factor:
          type: integer
          format: int32
    ppgMediaParamsList:
      title: ppgMediaParamsList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PpgMediaParams'
          description: ''
        links:
          $ref: '#/components/schemas/LinksRO'
        meta:
          $ref: '#/components/schemas/MetaDataRO'
    ppgSnrDetailsList:
      title: ppgSnrDetailsList
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PpgSnrDetails'
          description: ''
        fillRatio:
          type: string
        filter:
          type: string
        freId:
          type: string
        mostRecentTime:
          type: string
        units:
          type: string
    autoCompleteResponse:
      title: autoCompleteResponse
      type: object
      properties:
        results:
          type: array
          items:
            type: string
          description: ''
    cardType:
      title: cardType
      required:
      - shortName
      type: object
      properties:
        longName:
          type: string
          description: CTYPE of card such as the full name of card reported by NE
        partNumber:
          type: string
          description: 'PEC code of the card. Ex: NTK553MA'
        shortName:
          type: string
          description: Card name such as 100g MUX, OTR, OTNFLEX
      description: The card type information
    collectionCountGetData:
      title: collectionCountGetData
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data9'
      example:
        data:
          attributes:
            LOACount: 2
            failureOrDelayedCollectionCount: 3
            networkElementNames:
              LOA_NEs:
              - NE_5
              - NE_6
              failureOrDelayed:
                NE_4:
                  lastCollection: 2021-02-17 08:17:12.723 +0000 UTC
                  previousCollection: 2021-01-29 07:59:20.135 +0000 UTC
                NE_5:
                  lastCollection: 2021-02-08 11:03:13.899 +0000 UTC
                  previousCollection: 2021-01-29 07:57:02.014 +0000 UTC
                NE_6:
                  lastCollection: 2021-02-17 04:47:59.295 +0000 UTC
                  previousCollection: 2021-01-29 07:57:02.031 +0000 UTC
              success:
                NE_1:
                  lastCollection: 2021-02-18 08:47:21.061 +0000 UTC
                  previousCollection: 2021-01-05 06:48:16.019 +0000 UTC
                NE_2:
                  lastCollection: 2021-02-18 08:46:55.895 +0000 UTC
                  previousCollection: 2021-01-29 07:57:02.182 +0000 UTC
                NE_3:
                  lastCollection: 2021-02-18 08:46:46.503 +0000 UTC
                  previousCollection: 2021-01-29 07:57:02.162 +0000 UTC
            successCount: 3
            totalNetworkElementCount: 6
    collectionsBulkRequest:
      title: collectionsBulkRequest
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/collectionsBulkRequestData'
          description: ''
      example:
        data:
        - attributes:
            applyForNeNames:
            - PV0045
            - PV0046
            configName: 15_MINUTES
            enabled: true
            pollingInterval:
              unit: HOURS
              value: 3
            resolution:
              unit: MINUTES
              value: 15
          type: config
    collectionsBulkRequestData:
      title: collectionsBulkRequestData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes7'
        type:
          $ref: '#/components/schemas/Type63'
    collectionsGet:
      title: collectionsGet
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/collectionsGetData'
          description: ''
    collectionsGetData:
      title: collectionsGetData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes8'
        id:
          type: string
          description: Network Element Name
        raType:
          type: string
          description: Network Element Type Group
        type:
          $ref: '#/components/schemas/Type63'
    collectionsPatch:
      title: collectionsPatch
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/collectionsPatchData'
          description: ''
      example:
        data:
        - attributes:
            configName: 15_MINUTES
            enabled: true
            pollingInterval:
              unit: HOURS
              value: 3
            resolution:
              unit: MINUTES
              value: 15
          id: PV0445A
          type: config
    collectionsPatchData:
      title: collectionsPatchData
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes9'
        id:
          type: string
          description: Network Element Name (PV0445A) or Type (6500)
        type:
          enum:
          - config
          type: string
    correlatedRequestV1:
      title: correlatedRequestV1
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data10'
      example:
        data:
          attributes:
            filter:
              networkElementsAndFacilities:
                P8250A:
                - SDMON-1-6-5
                - SDMON-1-6-7
                P8250B:
                - SDMON-1-6-5
                - SDMON-1-6-7
            range:
              endTime: 2020-07-01T18:00:00.000Z
              startTime: 2020-07-01T12:00:00.000Z
              type: absolute
            tags:
            - networkElementName
            - parameterNative
            - facilityNameNative
    correlatedResponseV1:
      title: correlatedResponseV1
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data11'
          description: ''
        links:
          $ref: '#/components/schemas/Links1'
    hpmRequest:
      title: hpmRequest
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/hpmRequestData'
      description: The Historical metrics query
    hpmRequestAttributes:
      title: hpmRequestAttributes
      required:
      - filter
      - range
      type: object
      properties:
        filter:
          type: array
          items:
            type: object
          description: Define a filter for your query. The filter syntax matches heroics filter syntax
        range:
          $ref: '#/components/schemas/hpmRequestRange'
    hpmRequestData:
      title: hpmRequestData
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/hpmRequestAttributes'
    hpmRequestRange:
      title: hpmRequestRange
      type: object
      properties:
        endTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/requestTypeEnum'
        unit:
          $ref: '#/components/schemas/timeUnitEnum'
        value:
          maximum: 2147483646
          minimum: 1
          type: integer
          format: int32
    hpmRequestV2:
      title: hpmRequestV2
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data12'
    hpmResponseV2:
      title: hpmResponseV2
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data13'
          description: ''
        links:
          $ref: '#/components/schemas/Links2'
      example:
        data:
        - attributes:
            tags:
              direction: NEND
              facilityNameNative: OTM4-3-4-2
              networkElementName: Ottawa_011
              parameter: Fiberloss
            values:
              2019-02-04T15:15:00Z: 4.556
              2019-02-04T15:30:00Z: 5.56
        - attributes:
            tags:
              direction: FEND
              facilityNameNative: OTM4-3-4-2
              networkElementName: Ottawa_011
              parameter: Fiberloss
            values:
              2019-02-04T15:15:00Z: 2.556
        links:
          nextInterval: /pm/api/v2/query/metrics?start=1556783931000&end=1556913531000&page=1
          nextPage: /pm/api/v2/query/metrics?start=1556783931000&end=1556827131000&page=2
          previousInterval: /pm/api/v2/query/metrics?start=1556740714000&end=1556783931000&page=1
          previousPage: /pm/api/v2/query/metrics?start=1556783931000&end=1556827131000&page=0
          self: /pm/api/v2/query/metrics?start=1556783931000&end=1556913531000&page=1
    hpmResponseV3:
      title: hpmResponseV3
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data14'
          description: ''
        links:
          $ref: '#/components/schemas/Links2'
      example:
        data:
        - attributes:
            tags:
              direction: NEND
              facilityNameNative: OTM4-3-4-2
              networkElementName: Ottawa_011
              parameter: Fiberloss
            values:
              2019-02-04T15:15:00Z:
                binState: PTRL
                condition: OOR
                value: 4.556
              2019-02-04T15:30:00Z:
                condition: OOR
                value: 5.56
        - attributes:
            tags:
              direction: FEND
              facilityNameNative: OTM4-3-4-2
              networkElementName: Ottawa_011
              parameter: Fiberloss
            values:
              2019-02-04T15:15:00Z:
                condition: OOR
                value: 2.556
        links:
          nextInterval: /pm/api/v3/query/metrics?start=1556783931000&end=1556913531000&cursor=0
          nextPage: /pm/api/v3/query/metrics?start=1556783931000&end=1556827131000&cursor=40
          previousInterval: /pm/api/v3/query/metrics?start=1556740714000&end=1556783931000&cursor=0
          previousPage: /pm/api/v3/query/metrics?start=1556783931000&end=1556827131000&cursor=19&backwards=true
          self: /pm/api/v3/query/metrics?start=1556783931000&end=1556913531000&cursor=20
    initRegCriteria:
      title: initRegCriteria
      type: object
      properties:
        granularity:
          type: array
          items:
            $ref: '#/components/schemas/Granularity'
          description: '[6500 only] The granularity of the desired binTypes'
        monVal:
          maximum: 2147483646
          minimum: -2147483646
          type: integer
          description: Value of the monitored PM parameter
          format: int32
          default: 0
        powerType:
          $ref: '#/components/schemas/PowerType'
      description: Criteria allow qualification of the result set
    initRegRequestAttr:
      title: initRegRequestAttr
      required:
      - measurementPoints
      type: object
      properties:
        criteria:
          $ref: '#/components/schemas/Criteria'
        measurementPoints:
          type: array
          items:
            $ref: '#/components/schemas/measurementPoint'
          description: ''
      description: INIT-REG request attributes
      example:
        criteria:
          granularity:
          - 15_MINUTE
          - UNTIMED
        measurementPoints:
        - nodeId: 36b4c0eb-4a24-3339-96d9-cfa3912df58a
          resourceId: 36b4c0eb-4a24-3339-96d9-cfa3912df58a::TPE_36b4c0eb-4a24-3339-96d9-cfa3912df58a::EQPT_0_1-6-CTPServerToClient-1
          resourceObject:
            nativeFacilityName: OPTMON-0-1-6
            type: initRegister
          resurceType: TPE
    initRegStatus:
      title: initRegStatus
      required:
      - aid
      - success
      type: object
      properties:
        aid:
          type: string
          description: AID for the corresponding measurement point for the request
        error:
          $ref: '#/components/schemas/Error12'
        success:
          type: boolean
          description: Tells the Init Register response for the specific MeasurementPoint is success or not
    initRegisterRequest:
      title: initRegisterRequest
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data15'
      description: The Real-Time metrics query
    initRegisterResponse:
      title: initRegisterResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/initRegisterResponseItem'
          description: ''
      description: INIT-REG response
    initRegisterResponseItem:
      title: initRegisterResponseItem
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes15'
      description: Response of a INIT-REG measurement point
    intervalsGetData:
      title: intervalsGetData
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data16'
          description: ''
    locationsResponse:
      title: locationsResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data17'
          description: ''
    measurementPoint:
      title: measurementPoint
      type: object
      properties:
        facilityNameNative:
          type: string
        parameterNameNative:
          type: string
        variableName:
          type: string
    metaRequest:
      title: metaRequest
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data18'
    metaResponse:
      title: metaResponse
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/Meta2'
    metricAttributes:
      title: metricAttributes
      required:
      - resourceId
      type: object
      properties:
        location:
          $ref: '#/components/schemas/Location2'
        meta_tags:
          type: object
          additionalProperties:
            type: string
        nativePmFacilityName:
          type: string
          description: The name of the PM facility being requested
        resourceId:
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/sample'
          description: ''
        version:
          type: string
          default: '1.0'
    metricData:
      title: metricData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/metricAttributes'
        type:
          $ref: '#/components/schemas/Type65'
    pmError:
      title: pmError
      type: object
      properties:
        code:
          type: string
          description: The error code
        detail:
          type: string
          description: The detailed description of the error
        source:
          type: string
          description: The source of the error
        title:
          type: string
          description: The error title
      description: An error that occurred during PM collection
    pmErrorV2:
      title: pmErrorV2
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Errors3'
          description: ''
      description: Errors that occurred
    queryResponse:
      title: queryResponse
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/queryResponseData'
          description: ''
        errors:
          type: array
          items:
            $ref: '#/components/schemas/pmError'
          description: ''
    queryResponseAttributes:
      title: queryResponseAttributes
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/pmError'
          description: ''
        lastBatch:
          type: boolean
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/metricData'
          description: ''
        nodeId:
          type: string
        requestId:
          type: string
        status:
          $ref: '#/components/schemas/Status4'
    queryResponseData:
      title: queryResponseData
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/queryResponseAttributes'
        id:
          type: string
          description: The UUIDv4 identifying the PM query request
        type:
          $ref: '#/components/schemas/Type66'
    requestTypeEnum:
      title: requestTypeEnum
      enum:
      - absolute
      - relative
      type: string
    resourceObject:
      title: resourceObject
      type: object
      properties:
        cardType:
          $ref: '#/components/schemas/CardType1'
        location:
          $ref: '#/components/schemas/Location2'
        nativePmFacilityName:
          type: string
          description: The native name of the facility of the network element that is subject to this query
        signalIndex:
          $ref: '#/components/schemas/SignalIndex12'
        tpe:
          type: object
          description: A JSON-formatted TPE object
        type:
          type: string
      description: Inventory resource object
    rollupCalcRequestV1:
      title: rollupCalcRequestV1
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data19'
    rollupCalcResponseV1:
      title: rollupCalcResponseV1
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data20'
          description: ''
      example:
        data:
        - attributes:
            tags:
              direction: RECEIVE
              facilityNameNative: port1
              granularity: 1_Day
              networkElementName: NE1
              parameter: Average Throughput
            values:
              2019-02-04T00:00:00Z:
                binState: COMPL
                value: 2.556
        - attributes:
            tags:
              direction: RECEIVE
              facilityNameNative: port1
              granularity: 1_Day
              networkElementName: NE1
              parameter: Max Throughput
            values:
              2019-02-04T00:00:00Z:
                binState: COMPL
                value: 3.5
        - attributes:
            tags:
              direction: RECEIVE
              facilityNameNative: port1
              granularity: 1_Day
              networkElementName: NE1
              parameter: NinetyFifth Throughput
            values:
              2019-02-04T00:00:00Z:
                binState: COMPL
                value: 3.23
    rpmCriteria:
      title: rpmCriteria
      type: object
      properties:
        binIndex:
          pattern: (\d{1,2}(-\d{1,2})?,?){1,}
          type: string
          description: bin index. User can input data in any of the following format 0 | 0,1-3,5-7,21 | 0-32 | 1,3,5,7,9
        granularity:
          type: array
          items:
            $ref: '#/components/schemas/Granularity'
          description: '[6500 only] The granularity of the desired binTypes'
        includeThreshold:
          type: boolean
          description: Include Threshold flag indicates whether response to include Threshold Level or not
          default: false
        parameters:
          type: array
          items:
            type: string
          description: PM parameters. For MCP 16.12 drop 1 and drop 2 it will native name instead of normalized names
        powerType:
          $ref: '#/components/schemas/PowerType1'
        suppress:
          $ref: '#/components/schemas/Suppress'
    rpmRequest:
      title: rpmRequest
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/rpmRequestData'
      description: The Real-Time metrics query
    rpmRequestAttributes:
      title: rpmRequestAttributes
      required:
      - measurementPoints
      type: object
      properties:
        criteria:
          $ref: '#/components/schemas/rpmCriteria'
        measurementPoints:
          type: array
          items:
            $ref: '#/components/schemas/measurementPoint'
          description: The measurement point defines the specific resource the retrieve metrics from. Multiple measurement points on the same or different network elements may be specified
      example:
        criteria:
          binIndex: 0-12
          granularity:
          - 15_MINUTE
          - 24_HOUR
          includeThreshold: false
          parameters:
          - OPR-OTS
          - CV-ODU
          suppress: NONE
        measurementPoints:
        - nodeId: 6bc1c116-bba6-3c25-bbe2-21423cd8dacd
          resourceId: 6bc1c116-bba6-3c25-bbe2-21423cd8dacd::TPE_6bc1c116-bba6-3c25-bbe2-21423cd8dacd::EQPT_0_1-5-PTP
          resourceObject:
            tpe:
              data:
                attributes:
                  locations:
                  - port: '6'
                    shelf: '0'
                    slot: '1'
            type: pmData
          resourceType: TPE
    rpmRequestData:
      title: rpmRequestData
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/rpmRequestAttributes'
    sample:
      title: sample
      required:
      - time
      - value
      type: object
      properties:
        condition:
          type: string
        time:
          type: string
        value:
          type: number
    signalIndex1:
      title: signalIndex1
      required:
      - index_name
      - index_value
      type: object
      properties:
        index_name:
          $ref: '#/components/schemas/IndexName'
        index_value:
          type: string
          description: Value of the signal index
      description: Signal index of entity queried for metrics if applicable
    tagResponse:
      title: tagResponse
      type: object
      properties:
        data:
          type: array
          items:
            type: string
          description: Array of existing values for the given tag
      example:
        data:
        - PV00456
        - PV77009
        - Ottawa_045
    timeUnit:
      title: timeUnit
      required:
      - unit
      - value
      type: object
      properties:
        unit:
          $ref: '#/components/schemas/Unit1'
        value:
          type: number
      description: A TimeUnit is represented by the unit (SECONDS/MINUTES/HOURS/DAYS) and a value that is quantifying the unit
      example:
        unit: HOURS
        value: 3
    timeUnitEnum:
      title: timeUnitEnum
      enum:
      - MILLISECONDS
      - SECONDS
      - MINUTES
      - HOURS
      - DAYS
      - WEEKS
      - MONTHS
      type: string
    ActiveTraceAttributes:
      title: ActiveTraceAttributes
      type: object
      properties:
        id:
          type: string
        ncid:
          type: string
        aid:
          type: string
        runningState:
          type: boolean
          default: false
        additionalAttributes:
          type: object
          additionalProperties:
            type: object
    ActiveTraceDataRO:
      title: ActiveTraceDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the active trace resource
        type:
          $ref: '#/components/schemas/Type67'
        attributes:
          $ref: '#/components/schemas/ActiveTraceAttributes'
    ActiveTraceListRO:
      title: ActiveTraceListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ActiveTraceDataRO'
          description: ''
    ActiveTraceRO:
      title: ActiveTraceRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ActiveTraceDataRO'
    DataPoint:
      title: DataPoint
      type: object
      properties:
        blockId:
          type: string
        numberOfDataPoint:
          type: integer
          format: int32
        totalNumberOfScaleFactorsUsed:
          type: integer
          format: int32
        scaleFactors:
          type: array
          items:
            $ref: '#/components/schemas/ScaleFactor'
          description: ''
        values:
          type: array
          items:
            $ref: '#/components/schemas/DataPointValue'
          description: ''
    DataPointValue:
      title: DataPointValue
      type: object
      properties:
        getyValue:
          type: number
        getxValue:
          type: number
    DistanceCoordinateAttributes:
      title: DistanceCoordinateAttributes
      type: object
      properties:
        distance:
          type: number
        coordinates:
          type: string
    DistanceCoordinateDataRO:
      title: DistanceCoordinateDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the DistanceCoordinateDataRO resource
        type:
          $ref: '#/components/schemas/Type68'
        attributes:
          $ref: '#/components/schemas/DistanceCoordinateAttributes'
    DistanceCoordinateListRO:
      title: DistanceCoordinateListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/DistanceCoordinateDataRO'
          description: ''
    FiberPathAttributes:
      title: FiberPathAttributes
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        length (km):
          type: number
        pathItems:
          type: array
          items:
            $ref: '#/components/schemas/PathItemAttributes'
          description: ''
    FiberPathDataRO:
      title: FiberPathDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the FiberPathDataRO resource
        type:
          $ref: '#/components/schemas/Type69'
        attributes:
          $ref: '#/components/schemas/FiberPathAttributes'
        relationships:
          $ref: '#/components/schemas/FiberPathRelationshipRO'
    FiberPathListRO:
      title: FiberPathListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/FiberPathDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: ''
    FiberPathRO:
      title: FiberPathRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FiberPathDataRO'
    FiberPathRelationshipRO:
      title: FiberPathRelationshipRO
      type: object
      properties:
        links:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    FixedParameter:
      title: FixedParameter
      type: object
      properties:
        blockId:
          type: string
        dataTimeStamp:
          type: string
        unitsOfDistance:
          type: string
        actualWavelength:
          type: number
        acquisitionOffset:
          type: integer
          format: int64
        acquisitionOffsetDistance:
          type: number
        dataSpacing:
          type: array
          items:
            type: integer
            format: int32
          description: ''
        groupIndex:
          type: number
        averageTime:
          type: number
        acquisitionRange:
          type: integer
          format: int32
        acquisitionRangeDistance:
          type: number
        frontPanelOffset:
          type: integer
          format: int32
        frontPanelOffsetDistance:
          type: number
        noiseFloorLevel:
          type: number
        noiseFloorScaleFactor:
          type: number
        powerOffsetFirstPoint:
          type: number
        reflectanceThreshold:
          type: number
        endOfFiberThreshold:
          type: number
        traceType:
          type: string
        windowCoordinates:
          type: array
          items:
            type: integer
            format: int32
          description: ''
        totalPulseWidth:
          type: integer
          format: int32
          readOnly: true
        pulseWidthUsed:
          type: array
          items:
            type: integer
            format: int32
          description: ''
          readOnly: true
        eachPulseWidthDataPoint:
          type: array
          items:
            type: integer
            format: int32
          description: ''
          readOnly: true
        backscatterCoe:
          type: number
          readOnly: true
        noOfAverages:
          type: integer
          format: int32
          readOnly: true
    GeneralParameter:
      title: GeneralParameter
      type: object
      properties:
        blockId:
          type: string
        languageCode:
          type: string
        cableId:
          type: string
        fiberId:
          type: string
        originatingLocation:
          type: string
        terminatingLocation:
          type: string
        cableCode:
          type: string
        currentDataFlag:
          type: string
        userOffset:
          type: integer
          format: int32
        userOffsetDistance:
          type: integer
          format: int32
        operator:
          type: string
        fiberType:
          type: string
        wavelength:
          type: integer
          format: int32
          readOnly: true
        notes:
          type: string
          readOnly: true
    GeometryAttributes:
      title: GeometryAttributes
      type: object
      properties:
        type:
          type: string
        coordinates:
          type: string
        outer-boundary:
          type: string
        length (km):
          type: number
        inner-boundaries:
          type: array
          items:
            type: string
          description: ''
    KeyEvent:
      title: KeyEvent
      type: object
      properties:
        eventNumber:
          type: integer
          format: int32
        eventPropagationTime:
          type: integer
          format: int32
        eventDistance:
          type: number
        attenuationCoefficientLeadInFiber:
          type: number
        eventLoss:
          type: number
        eventReflectance:
          type: number
        eventCode:
          type: string
        lossMeasurementTechnique:
          type: string
        makerLocations:
          type: array
          items:
            type: integer
            format: int32
          description: ''
        comment:
          type: string
        eventRelativeDistance:
          type: string
        eventCodeDetail:
          type: string
    KeyEventBlock:
      title: KeyEventBlock
      type: object
      properties:
        blockId:
          type: string
        numberOfKeyEvent:
          type: integer
          format: int32
        endToEndLoss:
          type: number
        endToEndMarkerPositions:
          type: array
          items:
            type: integer
            format: int32
          description: ''
        opticalReturnLoss:
          type: number
        opticalReturnLossMarkerPositions:
          type: array
          items:
            type: integer
            format: int32
          description: ''
        events:
          type: array
          items:
            $ref: '#/components/schemas/KeyEvent'
          description: ''
          readOnly: true
    KmlFileAttributes:
      title: KmlFileAttributes
      type: object
      properties:
        filename:
          type: string
        status:
          type: string
    KmlFileDataRO:
      title: KmlFileDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the kml file resource
        type:
          $ref: '#/components/schemas/Type70'
        attributes:
          $ref: '#/components/schemas/KmlFileAttributes'
    KmlFileListRO:
      title: KmlFileListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/KmlFileDataRO'
          description: ''
    LinkDataRO:
      title: LinkDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the link resource
        type:
          $ref: '#/components/schemas/Type71'
        attributes:
          $ref: '#/components/schemas/LinkAttributes'
    LinkListRO:
      title: LinkListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/LinkDataRO'
          description: ''
    MetadataRO1:
      title: MetadataRO1
      type: object
      properties:
        total:
          type: integer
          format: int64
    NetworkElementAttributes:
      title: NetworkElementAttributes
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        resourcetype:
          type: string
        ipaddress:
          type: string
        macaddress:
          type: string
        serialnumber:
          type: string
        latlong:
          type: string
        softwareversion:
          type: string
        member-function:
          type: string
        state:
          type: string
        typegroup:
          type: string
        device-type:
          type: string
        session-id:
          type: string
    NetworkElementDataRO:
      title: NetworkElementDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the network element resource
        type:
          $ref: '#/components/schemas/Type72'
        attributes:
          $ref: '#/components/schemas/NetworkElementAttributes'
        relationships:
          $ref: '#/components/schemas/NetworkElementRelationshipRO'
    NetworkElementListRO:
      title: NetworkElementListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/NetworkElementDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: ''
    NetworkElementRelationshipRO:
      title: NetworkElementRelationshipRO
      type: object
      properties:
        placemark:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    OtdrAttributes:
      title: OtdrAttributes
      type: object
      properties:
        maximum-acquisition-time-sec:
          type: integer
          format: int32
        short-pulse-nsec:
          type: string
        short-distance-mtr:
          type: string
        long-pulse-nsec:
          type: string
        long-distance-mtr:
          type: string
        office-pulse-nsec:
          type: string
        office-distance-mtr:
          type: string
        event-range-mtr:
          type: integer
          format: int32
        trace-type:
          $ref: '#/components/schemas/TraceType'
    OtdrDataRO:
      title: OtdrDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the otdr resource
        type:
          $ref: '#/components/schemas/Type73'
        attributes:
          $ref: '#/components/schemas/OtdrAttributes'
    OtdrRO:
      title: OtdrRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OtdrDataRO'
        included:
          type: array
          items:
            type: object
          description: ''
    PathItemAttributes:
      title: PathItemAttributes
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        geometry:
          type: string
        start-lag:
          type: number
        end-lag:
          type: number
        association-attributes:
          type: object
          additionalProperties:
            type: string
    PlacemarkAttributes:
      title: PlacemarkAttributes
      type: object
      properties:
        id:
          type: string
        getpId:
          type: string
        name:
          type: string
        description:
          type: string
        filename:
          type: string
        container:
          type: string
        geometry:
          $ref: '#/components/schemas/GeometryAttributes'
        style:
          $ref: '#/components/schemas/StyleAttributes'
        additional-attributes:
          type: object
          additionalProperties:
            type: string
    PlacemarkDataRO:
      title: PlacemarkDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the placemark resource
        type:
          $ref: '#/components/schemas/Type74'
        attributes:
          $ref: '#/components/schemas/PlacemarkAttributes'
        relationships:
          $ref: '#/components/schemas/PlacemarkRelationshipRO'
    PlacemarkListRO:
      title: PlacemarkListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlacemarkDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: ''
    PlacemarkRO:
      title: PlacemarkRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PlacemarkDataRO'
        included:
          type: array
          items:
            type: object
          description: ''
    PlacemarkRelationshipRO:
      title: PlacemarkRelationshipRO
      type: object
      properties:
        fiberpaths:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        ne:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        waypoint:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        spool:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    ScaleFactor:
      title: ScaleFactor
      type: object
      properties:
        scale:
          type: number
        firstPoint:
          type: integer
          format: int32
        numPoints:
          type: integer
          format: int32
    SorAttributes:
      title: SorAttributes
      type: object
      properties:
        id:
          type: string
        ncid:
          type: string
        aid:
          type: string
        filename:
          type: string
        status:
          type: string
        creationTime:
          type: string
        traceType:
          type: string
        traceTag:
          type: string
        parsedData:
          $ref: '#/components/schemas/SorResponse'
    SorDataRO:
      title: SorDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the sor trace resource
        type:
          $ref: '#/components/schemas/Type75'
        attributes:
          $ref: '#/components/schemas/SorAttributes'
    SorListRO:
      title: SorListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetadataRO1'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SorDataRO'
          description: ''
    SorMapEntry:
      title: SorMapEntry
      type: object
      properties:
        blockId:
          type: string
        revisionNumber:
          type: integer
          format: int32
        revisionString:
          type: string
        blockSize:
          type: integer
          format: int64
    SorRO:
      title: SorRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SorDataRO'
    SorResponse:
      title: SorResponse
      type: object
      properties:
        blockList:
          type: array
          items:
            $ref: '#/components/schemas/SorMapEntry'
          description: ''
        generalParameter:
          $ref: '#/components/schemas/GeneralParameter'
        supplierParameter:
          $ref: '#/components/schemas/SupplierParameter'
        fixedParameter:
          $ref: '#/components/schemas/FixedParameter'
        dataPoint:
          $ref: '#/components/schemas/DataPoint'
        checkSum:
          type: integer
          format: int32
        KeyEvents:
          $ref: '#/components/schemas/KeyEventBlock'
    SpoolWaypointAttributes:
      title: SpoolWaypointAttributes
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        label:
          type: string
        length:
          type: number
        description:
          type: string
    SpoolWaypointDataRO:
      title: SpoolWaypointDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the spool/waypoint resource
        type:
          $ref: '#/components/schemas/Type76'
        attributes:
          $ref: '#/components/schemas/SpoolWaypointAttributes'
        relationships:
          $ref: '#/components/schemas/SpoolWaypointRelationshipRO'
    SpoolWaypointRO:
      title: SpoolWaypointRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SpoolWaypointDataRO'
        included:
          type: array
          items:
            type: object
          description: ''
    SpoolWaypointRelationshipRO:
      title: SpoolWaypointRelationshipRO
      type: object
      properties:
        placemark:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    StyleAttributes:
      title: StyleAttributes
      type: object
      properties:
        color:
          type: string
        icon:
          type: string
        fill:
          type: boolean
          default: false
        width:
          type: number
    SupplierParameter:
      title: SupplierParameter
      type: object
      properties:
        blockId:
          type: string
        supplierName:
          type: string
        otdrMainframeId:
          type: string
        otdrMainframeSerialNumber:
          type: string
        opticalModuleId:
          type: string
        opticalModuleSerialNumber:
          type: string
        softwareRevision:
          type: string
        other:
          type: string
    calculationContext:
      title: calculationContext
      type: object
      properties:
        calculationName:
          type: string
        measurementpoints:
          type: array
          items:
            $ref: '#/components/schemas/measurementPoint'
          description: ''
        rootfreId:
          type: string
    calculationContexts:
      title: calculationContexts
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/calculationContext'
          description: ''
    deviation:
      title: deviation
      required:
      - baseValue
      - value
      type: object
      properties:
        baseValue:
          type: number
          description: the base value from which the deviation occurs
        value:
          type: number
          description: the absolute value of the deviation for the alert to be triggered
      description: a maximum value threshold
    error2:
      title: error2
      type: object
      properties:
        code:
          type: string
          description: The error code
        detail:
          type: string
          description: The detailed description of the error
        title:
          type: string
          description: The error title
      description: An error that occurred during PM processing
    maxValue:
      title: maxValue
      required:
      - value
      type: object
      properties:
        value:
          type: number
          description: the value that if the parameter goes above will trigger the alert
      description: a maximum value threshold
    minValue:
      title: minValue
      required:
      - value
      type: object
      properties:
        value:
          type: number
          description: the value that if the parameter goes below will trigger the alert
      description: a minimum value threshold
    pmProcessorError:
      title: pmProcessorError
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error2'
          description: ''
    rawAlarmEvent:
      title: rawAlarmEvent
      type: object
      properties:
        _type:
          $ref: '#/components/schemas/Type77'
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
        additionalText:
          type: string
          description: The alarm description, E.g. Circuit pack missing
        conditionSource:
          $ref: '#/components/schemas/ConditionSource'
        id:
          type: string
          description: The RA Alarm ID
        nativeConditionType:
          type: string
          description: E.g. EQPT_MISSING
        nativeConditionTypeQualifier:
          type: string
          description: I've not seen this one used before
        op:
          $ref: '#/components/schemas/Op8'
        resource:
          type: string
          description: The alarming entity, e.g. 40GMUX-2-2
        resourceId:
          type: string
          description: Resource ID used for one method of alarm to service correlation
        server:
          $ref: '#/components/schemas/Server2'
        serviceAffecting:
          $ref: '#/components/schemas/ServiceAffecting3'
        severity:
          $ref: '#/components/schemas/Severity1'
        time:
          type: string
          description: The alarm operation time
          format: date-time
      description: Event to send on topic bp.ra.v1.alarms in order to raise alarm in AEP
    resourceProfile:
      title: resourceProfile
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data213'
    resourceProfileAttributes:
      title: resourceProfileAttributes
      required:
      - nodeId
      - thresholdGroupId
      type: object
      properties:
        nodeId:
          uniqueItems: true
          type: array
          items:
            type: string
          description: The IDs for nodes containing the specified resource(s)
        tags:
          type: array
          items:
            type: string
          description: Specific tags to match on. Currently only the facilityNameNative tag is supported. Regexp match supported
        thresholdGroupId:
          uniqueItems: true
          type: array
          items:
            type: string
          description: The threshold group(s) to associate with the resource profile
      description: attributes of a resource profile
    resourceProfileData:
      title: resourceProfileData
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes232'
        id:
          type: string
          description: The unique resource profile identifer
        type:
          enum:
          - resourceProfile
          type: string
      description: A resource profile
    resourceProfiles:
      title: resourceProfiles
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/resourceProfileData'
          description: ''
    threshold:
      title: threshold
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data222'
      example:
        data:
          attributes:
            action:
              alarmAlert:
                severity: MINOR
            maxValue:
              value: 10.5
            name: My threshold
            pmParameter: fiberloss
            tags:
              granularityNative: 15-MIN
            thresholdType: max
          id: 0911c8ff-07e7-43dd-96f2-b2bdb3f987ad
          type: threshold
    thresholdAlarmAlert:
      title: thresholdAlarmAlert
      required:
      - severity
      type: object
      properties:
        severity:
          $ref: '#/components/schemas/Severity2'
      description: An alarm alert
    thresholdAlertAction:
      title: thresholdAlertAction
      required:
      - alarmAlert
      type: object
      properties:
        alarmAlert:
          $ref: '#/components/schemas/AlarmAlert'
      description: the threshold crossing alert action
    thresholdAttributes:
      title: thresholdAttributes
      required:
      - action
      - pmParameter
      - thresholdType
      type: object
      properties:
        action:
          $ref: '#/components/schemas/Action4'
        deviation:
          $ref: '#/components/schemas/Deviation1'
        maxValue:
          $ref: '#/components/schemas/MaxValue1'
        minValue:
          $ref: '#/components/schemas/MinValue1'
        name:
          type: string
          description: The threshold name
        pmParameter:
          type: string
          description: The PM parameter to apply the threshold to
        tags:
          type: object
          additionalProperties:
            type: string
          description: A key-value hash of tags to be matched upon, all tags must match for a positive match. Supports regexp matching
        thresholdType:
          $ref: '#/components/schemas/ThresholdType'
      description: attributes of a threshold
    thresholdData:
      title: thresholdData
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes242'
        id:
          type: string
          description: the unique threshold ID
        type:
          enum:
          - threshold
          type: string
      description: A threshold
    thresholdDataNoID:
      title: thresholdDataNoID
      required:
      - attributes
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes242'
        type:
          enum:
          - threshold
          type: string
      description: A threshold
    thresholdGroup:
      title: thresholdGroup
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data232'
      example:
        data:
          attributes:
            thresholdId:
            - threshold_id_1
            - threshold_id_2
          id: Troubleshoot
          type: thresholdGroup
    thresholdGroupAttributes:
      title: thresholdGroupAttributes
      required:
      - thresholdId
      type: object
      properties:
        thresholdId:
          uniqueItems: true
          type: array
          items:
            type: string
          description: The threshold ID(s) to group
      description: attributes of a threshold group
    thresholdGroupData:
      title: thresholdGroupData
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes262'
        id:
          type: string
          description: The unique threshold group identifer
        type:
          enum:
          - thresholdGroup
          type: string
      description: A threshold group
    thresholdGroups:
      title: thresholdGroups
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/thresholdGroupData'
          description: ''
      example:
        data:
        - attributes:
            thresholdId:
            - threshold_id_1
            - threshold_id_2
          id: Troubleshoot
          type: thresholdGroup
    thresholds:
      title: thresholds
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/thresholdData'
          description: ''
      example:
        data:
        - attributes:
            action:
              alarmAlert:
                severity: MINOR
            maxValue:
              value: 10.5
            name: My threshold
            pmParameter: fiberloss
            tags:
              granularityNative: 15-MIN
            thresholdType: max
          id: 0911c8ff-07e7-43dd-96f2-b2bdb3f987ad
          type: threshold
    thresholdsNoID:
      title: thresholdsNoID
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/thresholdDataNoID'
          description: ''
      example:
        data:
        - attributes:
            action:
              alarmAlert:
                severity: MINOR
            maxValue:
              value: 10.5
            name: My threshold
            pmParameter: fiberloss
            tags:
              granularityNative: 15-MIN
            thresholdType: max
          type: threshold
    Condition:
      title: Condition
      type: object
      properties:
        category:
          type: integer
          format: int32
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        creator:
          type: string
        evaluationChangeDate:
          type: string
          format: date-time
        evaluationMessage:
          type: string
        evaluationResult:
          type: boolean
        properties:
          type: object
        tag:
          type: string
        type:
          type: integer
          format: int32
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        updator:
          type: string
        uuid:
          type: string
        watcherUuid:
          type: string
    Policy2:
      title: Policy2
      type: object
      properties:
        id:
          type: string
          description: UUID of the policy
        policyType:
          type: object
        name:
          type: string
          description: Policy name
        authRealm:
          type: string
          description: Authentication realm to which the policy applies
        tenantId:
          type: string
          description: UUID for the tenant for whom this policy applies
        description:
          type: string
          description: Optional description of the policy
        conditionId:
          type: string
          description: Identifier for the logical condition used to determine applicability of this policy
        policyActions:
          type: object
        filter:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Set of filters to apply in this policy
        monitoredTopic:
          type: string
          description: Message bus topic for a monitor policy type
        actionInfo:
          $ref: '#/components/schemas/JObject'
      description: A description of a single policy
    AuthRealm:
      title: AuthRealm
      type: object
      properties:
        name:
          type: string
          description: Realm name
        description:
          type: string
          description: Optional description of the realm
      description: A description of a single authorization realm
    ListReply25:
      title: ListReply25
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Policy2'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ListReply26:
      title: ListReply26
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Condition'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    ConditionProp:
      title: ConditionProp
      type: object
      properties:
        id:
          type: string
          description: UUID of the condition. An UUID will be assigned if not specified
        name:
          type: string
          description: Condition name
        tenantId:
          type: string
          description: UUID for the tenant for whom this condition applies
        description:
          type: string
          description: Optional description of the condition
        definition:
          type: string
          description: Boolean expression that used to define the matching condition
      description: A description of a policy condition creation request
    ListReply27:
      title: ListReply27
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AuthRealm'
          description: List of requested items (in current page if paged)
        total:
          type: integer
          description: Total number of items in the reply (across all pages if applicable)
          format: int32
        nextPageToken:
          type: string
          description: Identifier used to fetch the next page of results
        offset:
          type: integer
          description: Offset within the total count of results where this current items list starts
          format: int32
        limit:
          type: integer
          description: Limit on the number of items included in a single response page
          format: int32
    PolicyProp:
      title: PolicyProp
      type: object
      properties:
        id:
          type: string
          description: UUID of the policy. An UUID will be assigned if not specified
        policyType:
          type: object
        name:
          type: string
          description: Policy name
        authRealm:
          type: string
          description: Authentication realm to which the policy applies
        tenantId:
          type: string
          description: UUID for the tenant for whom this policy applies
        description:
          type: string
          description: Optional description of the policy
        conditionId:
          type: string
          description: Identifier for the logical condition used to determine applicability of this policy
        policyActions:
          type: object
        filter:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Set of filters to apply in this policy
        monitoredTopic:
          type: string
          description: Message bus topic for a monitor policy type
        actionInfo:
          $ref: '#/components/schemas/JObject'
      description: A description of a policy creation request
    ResourceObjectRO:
      title: ResourceObjectRO
      type: object
      properties:
        nativeName:
          type: string
          description: Native name for the TPE resource
    TpeExpectationAttributesRO:
      title: TpeExpectationAttributesRO
      type: object
      properties:
        validateParameters:
          $ref: '#/components/schemas/ValidateParametersRO'
        pathType:
          $ref: '#/components/schemas/PathType1'
        startDate:
          type: string
          description: The scheduled start date and time of the expectation, with RFC 3339 date-time format
        endDate:
          type: string
          description: The scheduled end date and time of the expectation, with RFC 3339 date-time format
        policies:
          type: array
          items:
            type: object
          description: Policies to be applied to the entity.
        structureType:
          $ref: '#/components/schemas/StructureType2'
        structureSubType:
          $ref: '#/components/schemas/StructureSubType'
        tpeSpec:
          type: string
          description: 'Name of TPESpec describing this TPE instance. FUTURE: enumerated value, part of TPESpec catalog.'
        tpeGroupSpecs:
          type: array
          items:
            type: string
          description: 'Names of TPEGSpec-s this TPE belongs to. FUTURE: enumerated value, part of TPEGSpec catalog.'
        nativeName:
          type: string
          description: The name of the TPE that is native to the network element
        userLabel:
          type: string
          description: The label given to the TPE by an user
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
        layerTerminations:
          type: array
          items:
            $ref: '#/components/schemas/LayerTerminationRO'
          description: ''
        stackDirection:
          $ref: '#/components/schemas/StackDirection'
        displayAlias:
          type: string
          description: The displayAlias of the TPE
        dynamicFgiSpecificationRefList:
          type: array
          items:
            type: string
          description: A list of dynamic Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.  E.g 'May_Comment:1.0.0:1234'
        fgiSpecificationRefList:
          type: array
          items:
            type: string
          description: A list of Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.  E.g 'May_Comment:1.0.0:1234'
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        availableCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        capacityReservations:
          type: array
          items:
            $ref: '#/components/schemas/CapacityReservationRO'
          description: ''
        cardType:
          type: string
        category:
          $ref: '#/components/schemas/Category4'
        roadmLine:
          type: string
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/SyncScopeRO'
          description: The sync scope for the TPE
        modelType:
          $ref: '#/components/schemas/ModelType'
        active:
          type: boolean
          description: An indicator to flag when a TPE is active, or simply a potential.
          default: false
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        lifeCycleOwner:
          type: string
          description: Specifies who owns the lifecycle of a TPE
        provisioningAttributes:
          type: object
        capabilitySpecification:
          $ref: '#/components/schemas/CapabilitySpecRO'
        cardMode:
          $ref: '#/components/schemas/CardMode'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
        customerCode:
          type: string
          description: Customer code
        owningServerTpeListType:
          $ref: '#/components/schemas/OwningServerTpeListType'
        resiliencyHandlingPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyHandlingPackageRO'
          description: triggers stitcher building resiliency view and NSI updating layerRate in resiliency view
        resiliencyPackage:
          $ref: '#/components/schemas/TpeResiliencyPackageRO'
        parentEBBWConstraint:
          $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
        parentEBFREBWConstraint:
          $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
        parentEBBWConstraintList:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
          description: A list of Virtual TPEs as BW constraint.
        parentEBFREBWConstraintList:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
          description: A list of Virtual TPEs as FRE constraint.
        stitchingTriggers:
          $ref: '#/components/schemas/StitchingTriggersRO'
        plannedEndpointRole:
          $ref: '#/components/schemas/PlannedEndpointRole'
        gneSubnetName:
          type: string
          description: The GNE Subnet Name of the TPE
        displayRate:
          type: string
          description: DisplayRate of TPE, for instance BITRATE of ODUTTP in case of ODUFLEX/ETHFLEX rate TPE
        referencedByAssociations:
          type: array
          items:
            $ref: '#/components/schemas/AssociationRO'
          description: A list of associations of fres that would refer to this tpe
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group .
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared SRLG of this TPE .
        externalFgiSpecsRefList:
          type: array
          items:
            type: string
          description: List of External Forwarding Group assignments.
        ethernetSegment:
          $ref: '#/components/schemas/EthernetSegmentRO'
        evpn:
          $ref: '#/components/schemas/EvpnRO'
    TpeExpectationDataRO:
      title: TpeExpectationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the tpe expectation
        type:
          $ref: '#/components/schemas/Type78'
        attributes:
          $ref: '#/components/schemas/TpeExpectationAttributesRO'
        relationships:
          $ref: '#/components/schemas/TpeExpectationRelationshipsRO'
    TpeExpectationListRO:
      title: TpeExpectationListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TpeExpectationDataRO'
          description: ''
    TpeExpectationRO:
      title: TpeExpectationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TpeExpectationDataRO'
    TpeExpectationRelationshipsRO:
      title: TpeExpectationRelationshipsRO
      type: object
      properties:
        serviceIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        intent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstructAssociation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipment:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        owningServerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        clientTpes:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        owningServerTpeList:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        owningPeerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        ownedPeerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partnerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        owningClientTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        controller:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        configurationAndSwitchControl:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    TpePatchOperationRO:
      title: TpePatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op9'
        srlgRelationships:
          $ref: '#/components/schemas/SrlgPatchDataRO'
        patchTpeExpectation:
          $ref: '#/components/schemas/TpeExpectationDataRO'
    TpePatchRO:
      title: TpePatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/TpePatchOperationRO'
          description: ''
    TpePlannedAttributesRO:
      title: TpePlannedAttributesRO
      type: object
      properties:
        structureType:
          $ref: '#/components/schemas/StructureType2'
        structureSubType:
          $ref: '#/components/schemas/StructureSubType'
        tpeSpec:
          type: string
          description: 'Name of TPESpec describing this TPE instance. FUTURE: enumerated value, part of TPESpec catalog.'
        tpeGroupSpecs:
          type: array
          items:
            type: string
          description: 'Names of TPEGSpec-s this TPE belongs to. FUTURE: enumerated value, part of TPEGSpec catalog.'
        nativeName:
          type: string
          description: The name of the TPE that is native to the network element
        userLabel:
          type: string
          description: The label given to the TPE by an user
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
        layerTerminations:
          type: array
          items:
            $ref: '#/components/schemas/LayerTerminationRO'
          description: ''
        stackDirection:
          $ref: '#/components/schemas/StackDirection'
        displayAlias:
          type: string
          description: The displayAlias of the TPE
        dynamicFgiSpecificationRefList:
          type: array
          items:
            type: string
          description: A list of dynamic Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.  E.g 'May_Comment:1.0.0:1234'
        fgiSpecificationRefList:
          type: array
          items:
            type: string
          description: A list of Forwarding Group assignments.  Each assignment costs of the fGNane, FGVersion, and FGInstance.  E.g 'May_Comment:1.0.0:1234'
        totalCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        availableCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedCapacity:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        capacityReservations:
          type: array
          items:
            $ref: '#/components/schemas/CapacityReservationRO'
          description: ''
        cardType:
          type: string
        category:
          $ref: '#/components/schemas/Category4'
        roadmLine:
          type: string
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/SyncScopeRO'
          description: The sync scope for the TPE
        modelType:
          $ref: '#/components/schemas/ModelType'
        active:
          type: boolean
          description: An indicator to flag when a TPE is active, or simply a potential.
          default: false
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        lifeCycleOwner:
          type: string
          description: Specifies who owns the lifecycle of a TPE
        provisioningAttributes:
          type: object
        capabilitySpecification:
          $ref: '#/components/schemas/CapabilitySpecRO'
        cardMode:
          $ref: '#/components/schemas/CardMode'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the associated NE belongs to.
        customerCode:
          type: string
          description: Customer code
        owningServerTpeListType:
          $ref: '#/components/schemas/OwningServerTpeListType'
        resiliencyHandlingPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyHandlingPackageRO'
          description: triggers stitcher building resiliency view and NSI updating layerRate in resiliency view
        resiliencyPackage:
          $ref: '#/components/schemas/TpeResiliencyPackageRO'
        parentEBBWConstraint:
          $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
        parentEBFREBWConstraint:
          $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
        parentEBBWConstraintList:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
          description: A list of Virtual TPEs as BW constraint.
        parentEBFREBWConstraintList:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTpeBWConstraintsRO'
          description: A list of Virtual TPEs as FRE constraint.
        stitchingTriggers:
          $ref: '#/components/schemas/StitchingTriggersRO'
        plannedEndpointRole:
          $ref: '#/components/schemas/PlannedEndpointRole'
        gneSubnetName:
          type: string
          description: The GNE Subnet Name of the TPE
        displayRate:
          type: string
          description: DisplayRate of TPE, for instance BITRATE of ODUTTP in case of ODUFLEX/ETHFLEX rate TPE
        referencedByAssociations:
          type: array
          items:
            $ref: '#/components/schemas/AssociationRO'
          description: A list of associations of fres that would refer to this tpe
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group .
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared SRLG of this TPE .
        externalFgiSpecsRefList:
          type: array
          items:
            type: string
          description: List of External Forwarding Group assignments.
        ethernetSegment:
          $ref: '#/components/schemas/EthernetSegmentRO'
        evpn:
          $ref: '#/components/schemas/EvpnRO'
    TpePlannedDataRO:
      title: TpePlannedDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the planned tpe
        type:
          $ref: '#/components/schemas/Type79'
        attributes:
          $ref: '#/components/schemas/TpePlannedAttributesRO'
        relationships:
          $ref: '#/components/schemas/TpePlannedRelationshipsRO'
    TpePlannedRO:
      title: TpePlannedRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TpePlannedDataRO'
    TpePlannedRelationshipsRO:
      title: TpePlannedRelationshipsRO
      type: object
      properties:
        serviceIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        manualSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicAutoSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicInheritedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicPropagatedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        manualShareSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        networkConstructAssociation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipment:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        owningServerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        clientTpes:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        owningServerTpeList:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        owningPeerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        ownedPeerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partnerTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        owningClientTpe:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        controller:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        configurationAndSwitchControl:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    TpeRO:
      title: TpeRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        data:
          $ref: '#/components/schemas/TpeDataRO'
        included:
          type: array
          items:
            type: object
          description: Referenced sub-resources
    TpeTtiDataRO:
      title: TpeTtiDataRO
      type: object
      properties:
        resourceId:
          type: string
          description: The unique identifier for the TPE resource
        resourceObject:
          $ref: '#/components/schemas/ResourceObjectRO'
        trailTraceType:
          type: string
          description: trailTraceType
    TpeTtiPostDataRO:
      title: TpeTtiPostDataRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TpeTtiDataRO'
    TpeTtiSnapshotRO:
      title: TpeTtiSnapshotRO
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AttributesRO'
    ProblemPatch:
      title: ProblemPatch
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: ''
    ProblemRequest:
      title: ProblemRequest
      type: object
      properties:
        search:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: ''
          readOnly: true
        selection:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: ''
          readOnly: true
        metaDataFields:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
          readOnly: true
        metaDataOnly:
          type: boolean
          default: false
          readOnly: true
        limit:
          type: integer
          format: int32
          readOnly: true
    ProjectArchivedStatus:
      title: ProjectArchivedStatus
      enum:
      - 0
      - 1
      - 2
      type: integer
    ErrorSource:
      title: ErrorSource
      type: object
      properties:
        pointer:
          type: string
        parameter:
          type: string
    ProjectState:
      title: ProjectState
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
    ProjectType:
      title: ProjectType
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
    PlanningProject:
      title: PlanningProject
      required:
      - Name
      - CompletionDate
      type: object
      properties:
        Id:
          type: string
          format: uuid
        Name:
          type: string
        CompletionDate:
          type: string
          format: date-time
        ExpirationDate:
          type: string
          format: date-time
        State:
          $ref: '#/components/schemas/ProjectState'
        Description:
          type: string
        StatusMessage:
          type: string
        IntentId:
          type: string
        ProjectListId:
          type: string
          format: uuid
        ProjectType:
          $ref: '#/components/schemas/ProjectType'
        IsArchived:
          type: boolean
        CommittedDate:
          type: string
          format: date-time
        DeployedEquipment:
          type: integer
          format: int32
        TotalEquipment:
          type: integer
          format: int32
    ProjectsArchivedStatusUpdateRequest:
      title: ProjectsArchivedStatusUpdateRequest
      required:
      - projectIds
      - archivedStatus
      type: object
      properties:
        projectIds:
          type: array
          items:
            type: string
            format: uuid
          description: List of Ids of projects.
        archivedStatus:
          type: boolean
          description: archived status true/false
      description: Projects Archived Status Update Request
    Identifier:
      title: Identifier
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    ProjectListFailure:
      title: ProjectListFailure
      type: object
      properties:
        project:
          $ref: '#/components/schemas/Identifier'
        failureReasons:
          type: array
          items:
            type: string
          description: ''
    ProjectListState:
      title: ProjectListState
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      type: integer
    ProjectListSyncState:
      title: ProjectListSyncState
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
    ProjectList:
      title: ProjectList
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        validatedDate:
          type: string
          format: date-time
        committedDate:
          type: string
          format: date-time
        projects:
          type: array
          items:
            $ref: '#/components/schemas/Identifier'
          description: ''
        failureReasons:
          type: array
          items:
            $ref: '#/components/schemas/ProjectListFailure'
          description: ''
        state:
          $ref: '#/components/schemas/ProjectListState'
        syncState:
          $ref: '#/components/schemas/ProjectListSyncState'
    ErrorList:
      title: ErrorList
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: ''
    AddProjectRequest:
      title: AddProjectRequest
      type: object
      properties:
        projectId:
          type: string
          format: uuid
        projectName:
          type: string
    ProjectListV1:
      title: ProjectListV1
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        validatedDate:
          type: string
          format: date-time
        committedDate:
          type: string
          format: date-time
        projects:
          type: array
          items:
            type: string
            format: uuid
          description: ''
        failureReasons:
          type: object
          additionalProperties:
            type: string
        state:
          $ref: '#/components/schemas/ProjectListState'
        syncState:
          $ref: '#/components/schemas/ProjectListSyncState'
    AllReportMetaDataModelRO:
      title: AllReportMetaDataModelRO
      type: object
      properties:
        reportType:
          type: string
        reportMetaData:
          type: array
          items:
            $ref: '#/components/schemas/ReportMetaDataModel'
          description: ''
    CreateAndUpdateReportScheduleModelV1:
      title: CreateAndUpdateReportScheduleModelV1
      type: object
      properties:
        StartTime:
          type: string
        reportType:
          type: string
    CreateAndUpdateReportScheduleModelV2:
      title: CreateAndUpdateReportScheduleModelV2
      type: object
      properties:
        cronExpression:
          type: string
        cronExpressionFormat:
          type: string
        reportType:
          type: string
    CreateReportTypeResponseModel:
      title: CreateReportTypeResponseModel
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        name:
          type: string
        creationTime:
          type: string
    OnDemandReportMetaDataResponseModelV2:
      title: OnDemandReportMetaDataResponseModelV2
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OnDemandResponseModelV2'
          description: ''
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/MetaData'
    OnDemandReportRequestModel:
      title: OnDemandReportRequestModel
      type: object
      properties:
        reportType:
          type: string
    OnDemandReportRequestModelV2:
      title: OnDemandReportRequestModelV2
      type: object
      properties:
        reportType:
          type: string
    OnDemandReportRequestPayloadV2:
      title: OnDemandReportRequestPayloadV2
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OnDemandRequestModelV2'
    OnDemandRequestModelV2:
      title: OnDemandRequestModelV2
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type80'
        attributes:
          $ref: '#/components/schemas/OnDemandReportRequestModelV2'
    OnDemandResponseModelV2:
      title: OnDemandResponseModelV2
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ReportMetaDataModelV2'
    OneTouchOnDemandRequestModelV2:
      title: OneTouchOnDemandRequestModelV2
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type80'
        attributes:
          $ref: '#/components/schemas/OneTouchReportRequestModel'
        utcOffset:
          type: string
    OneTouchReportRequestModel:
      title: OneTouchReportRequestModel
      type: object
      properties:
        reportFormat:
          type: string
        reportType:
          type: string
    OneTouchReportRequestPayloadV2:
      title: OneTouchReportRequestPayloadV2
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OneTouchOnDemandRequestModelV2'
    QueryAllReportsScheduleROV1:
      title: QueryAllReportsScheduleROV1
      type: object
      properties:
        reportType:
          type: string
        scheduleMetaData:
          type: array
          items:
            $ref: '#/components/schemas/QueryReportScheduleROV1'
          description: ''
    QueryAllReportsScheduleROV2:
      title: QueryAllReportsScheduleROV2
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/QueryReportScheduleROV2'
          description: ''
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/MetaData'
    QueryReportScheduleROV1:
      title: QueryReportScheduleROV1
      type: object
      properties:
        resourceId:
          type: string
        reportType:
          type: string
        startDateTime:
          type: string
    QueryReportScheduleROV2:
      title: QueryReportScheduleROV2
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ReportScheduleAttributes'
    QueryReportsScheduleROV2:
      title: QueryReportsScheduleROV2
      type: object
      properties:
        data:
          $ref: '#/components/schemas/QueryReportScheduleROV2'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/MetaData'
    ReportMetaDataModel:
      title: ReportMetaDataModel
      type: object
      properties:
        resourceId:
          type: string
        reportType:
          type: string
        reportGenerationTime:
          type: string
        reportStatus:
          type: string
        reportContentType:
          type: string
        reportGenerationMode:
          type: string
    ReportMetaDataModelV2:
      title: ReportMetaDataModelV2
      type: object
      properties:
        resourceId:
          type: string
        reportType:
          type: string
        reportGenerationTime:
          type: string
        reportStatus:
          type: string
        reportContentType:
          type: string
        reportGenerationMode:
          type: string
    ReportMetaDataResponseModelV2:
      title: ReportMetaDataResponseModelV2
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OnDemandResponseModelV2'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/MetaData'
    ReportScheduleAttributes:
      title: ReportScheduleAttributes
      type: object
      properties:
        resourceId:
          type: string
        reportType:
          type: string
        cronExpression:
          type: string
        cronExpressionFormat:
          type: string
        cronDescription:
          type: string
    ReportScheduleRequestDataModelV2:
      title: ReportScheduleRequestDataModelV2
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type82'
        attributes:
          $ref: '#/components/schemas/CreateAndUpdateReportScheduleModelV2'
    ReportsScheduleRequestPayloadV2:
      title: ReportsScheduleRequestPayloadV2
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReportScheduleRequestDataModelV2'
    SupportedReportTypeModelV2:
      title: SupportedReportTypeModelV2
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/SupportedReportTypeV2'
    SupportedReportTypeV2:
      title: SupportedReportTypeV2
      type: object
      properties:
        id:
          type: string
        reportType:
          type: string
        displayName:
          type: string
        description:
          type: string
    SupportedReportTypesV2:
      title: SupportedReportTypesV2
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SupportedReportTypeModelV2'
          description: ''
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/MetaData'
    ControllerAttributesRO:
      title: ControllerAttributesRO
      type: object
      properties:
        identifiers:
          type: array
          items:
            type: object
          description: ''
        resourceState:
          $ref: '#/components/schemas/ResourceState'
        displayData:
          $ref: '#/components/schemas/FreDisplayDataRO'
        controllerDataPackage:
          $ref: '#/components/schemas/ControllerDataPackageRO'
        recoveryCharacteristics:
          $ref: '#/components/schemas/RecoveryCharacteristicsRO'
        modelType:
          $ref: '#/components/schemas/ModelType'
        resiliencyFlowsPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyFlowsPackageRO'
          description: Resiliency flow
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the NE belongs to.
    ControllerDataPackageRO:
      title: ControllerDataPackageRO
      type: object
      properties:
        controllerType:
          $ref: '#/components/schemas/ControllerType'
        protectionScheme:
          $ref: '#/components/schemas/ProtectionScheme'
        protectionSchemeQualifier:
          $ref: '#/components/schemas/ProtectionSchemeQualifier'
        switchRule:
          $ref: '#/components/schemas/SwitchRule'
        profile:
          $ref: '#/components/schemas/Profile'
        isFrozen:
          type: boolean
          description: Temporarily prevents any switch action to be taken and, as such, freezes the current state
          default: false
        isCoordinatingBothEnds:
          type: boolean
          description: if TRUE, the Controller is operating such that switching at both ends of each flow across the FC is coordinated at both ingress and egress ends
          default: false
        nativeName:
          type: string
          description: Native name of the controller
        transponderTriggeredOps:
          type: string
          description: If Yes, the transponder triggered OPS feature is on. No means it's off.
        lossPower:
          type: string
          description: If Yes, there is power loss. No means there is no power loss.
    ControllerDataRO:
      title: ControllerDataRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResourceMetaDataRO'
        id:
          type: string
          description: The unique identifier for the Controller resource
        type:
          $ref: '#/components/schemas/Type83'
        attributes:
          $ref: '#/components/schemas/ControllerAttributesRO'
        relationships:
          $ref: '#/components/schemas/ControllerRelationshipsRO'
    ControllerExpectationAttributesRO:
      title: ControllerExpectationAttributesRO
      type: object
      properties:
        validateParameters:
          $ref: '#/components/schemas/ValidateParametersRO'
        controllerDataPackage:
          $ref: '#/components/schemas/ControllerDataPackageRO'
        recoveryCharacteristics:
          $ref: '#/components/schemas/RecoveryCharacteristicsRO'
        modelType:
          $ref: '#/components/schemas/ModelType'
        resiliencyFlowsPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyFlowsPackageRO'
          description: Resiliency flow
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the NE belongs to.
    ControllerExpectationDataRO:
      title: ControllerExpectationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the controller expectation
        type:
          $ref: '#/components/schemas/Type84'
        attributes:
          $ref: '#/components/schemas/ControllerExpectationAttributesRO'
        relationships:
          $ref: '#/components/schemas/ControllerExpectationRelationshipsRO'
    ControllerExpectationRO:
      title: ControllerExpectationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ControllerExpectationDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to a Controller, such as ControllerData, TPEData, FreData, SwitchData, ControllerExpectationData
    ControllerExpectationRelationshipsRO:
      title: ControllerExpectationRelationshipsRO
      type: object
      properties:
        subordinateSwitches:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        selectableTPEs:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    ControllerListRO:
      title: ControllerListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ControllerDataRO'
          description: ''
        included:
          type: array
          items:
            type: object
          description: Resources related to a Controller, such as ControllerData, TPEData, FreData, SwitchData, ControllerExpectationData
    ControllerPlannedAttributesRO:
      title: ControllerPlannedAttributesRO
      type: object
      properties:
        controllerDataPackage:
          $ref: '#/components/schemas/ControllerDataPackageRO'
        recoveryCharacteristics:
          $ref: '#/components/schemas/RecoveryCharacteristicsRO'
        modelType:
          $ref: '#/components/schemas/ModelType'
        resiliencyFlowsPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyFlowsPackageRO'
          description: Resiliency flow
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition the NE belongs to.
    ControllerPlannedDataRO:
      title: ControllerPlannedDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the planned controller
        type:
          $ref: '#/components/schemas/Type85'
        attributes:
          $ref: '#/components/schemas/ControllerPlannedAttributesRO'
        relationships:
          $ref: '#/components/schemas/ControllerPlannedRelationshipsRO'
    ControllerPlannedRelationshipsRO:
      title: ControllerPlannedRelationshipsRO
      type: object
      properties:
        subordinateSwitches:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        selectableTPEs:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    ControllerRO:
      title: ControllerRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          $ref: '#/components/schemas/ControllerDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to a Controller, such as ControllerData, TPEData, FreData, SwitchData, ControllerExpectationData
    ControllerRelationshipsRO:
      title: ControllerRelationshipsRO
      type: object
      properties:
        subordinateControllers:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        controllerExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        controllerDiscovered:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        controllerPlanned:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        subordinateSwitches:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        selectableTPEs:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    RecoveryCharacteristicsRO:
      title: RecoveryCharacteristicsRO
      type: object
      properties:
        autoReversionPossible:
          type: boolean
          description: Auto reversion enabled value.
          default: false
        autoReversionType:
          $ref: '#/components/schemas/AutoReversionType'
        waitToRevertDelay:
          type: integer
          description: The time delay for auto-reversion
          format: int32
        reversionTimeUnit:
          type: string
          description: Unit of delay time for revert, default is seconds
        waitToSwitchDelay:
          type: integer
          description: The time delay before switching off the active path when problem is detected
          format: int32
        switchTimeUnit:
          type: string
          description: Unit of delay time before switching, default is seconds
        onHome:
          type: boolean
          description: Flag indicating if currently on the home path
          default: false
        homeAvailable:
          type: boolean
          description: Flag indicating if home path is currently available
          default: false
        recoveryPriority:
          $ref: '#/components/schemas/RecoveryPriority'
        timerDetectionGuard:
          type: integer
          description: This timer is triggered when both members of a protection pair are in a clear state and one of the members detects a Signal Fail due to a likely upstream client side fault
          format: int32
        timerDetectionGuardTimeUnit:
          type: string
          description: Unit of detection guard time, default is seconds
        timerRecoveryGuard:
          type: integer
          description: This timer is triggered when both members of a protection pair are in an Signal Fail (SF) state due to a common upstream client side defect and one of them detects the clearing of the SF
          format: int32
        timerRecoveryGuardTimeUnit:
          type: string
          description: Unit of recovery guard time, default is seconds
        signalingType:
          $ref: '#/components/schemas/SignalingType1'
        todrTime:
          type: string
          description: Specifies the time of day to do reversion to the home path
        todrTimePeriod:
          type: integer
          description: Specifies the time period (in minutes) over which it is acceptable to do the TODR
          format: int32
        todrTimePeriodUnit:
          type: string
          description: Unit of time period
        todrHoldbackEnabled:
          type: boolean
          description: Specifies if time of day reversion holdback is enabled
          default: false
        todrHoldbackPeriod:
          type: string
          description: Specifies the time of day reversion holdback period
        holdbackThreshold:
          type: integer
          description: Holdback signal degrade threshold
          format: int32
        todrProfileList:
          type: string
          description: List of time of day reversion profiles that are associated with this PROTGRP
        dataPathFaultAction:
          type: string
          description: Indicates whether an ALARM will be raised or MR will be done on SNC Datapath Fault.Default is ALARM
        dataPathFaultAlarmTime:
          type: string
          description: Specifies in minutes how long to wait before raising the SNC datapath fault alarm.
        isArdEnabled:
          type: boolean
          description: Absolute route diversity
          default: false
        holdOffTime:
          type: integer
          description: Specifies the holdOffTime.
          format: int32
        holdOffTimeUnit:
          type: string
          description: Unit of hold off time
        timerGuard:
          type: integer
          description: Timer Guard is an evaluation guardtimer. It works both on the raising and clearing of a defect by inhibiting the evaluation of the conditions by the A/SNCP engine for the specified time.
          format: int32
        timerGuardTimeUnit:
          type: string
          description: Unit of timer guard.
        switchingProtocol:
          $ref: '#/components/schemas/SwitchingProtocol'
        displayLabels:
          type: object
    ResiliencyFlowsPackageRO:
      title: ResiliencyFlowsPackageRO
      type: object
      properties:
        flowType:
          $ref: '#/components/schemas/FlowType'
        flowSelection:
          $ref: '#/components/schemas/FlowSelection'
        selectionReason:
          $ref: '#/components/schemas/SelectionReason'
    RaCtrlListRO:
      title: RaCtrlListRO
      type: object
      properties:
        nextPageToken:
          type: string
        kind:
          type: string
        itemsAvailable:
          type: integer
          format: int32
        items:
          type: array
          items:
            type: object
          description: ''
    ProjectAttributesRO:
      title: ProjectAttributesRO
      type: object
      properties:
        summary:
          type: string
          description: Project top-level/overall summary status message
        lastUpdatedTime:
          type: string
          description: The last time the project was updated, represented in ISO-8601 date-time format
    ProjectDataRO:
      title: ProjectDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the SMO project
        type:
          $ref: '#/components/schemas/Type86'
        attributes:
          $ref: '#/components/schemas/ProjectAttributesRO'
        relationships:
          $ref: '#/components/schemas/ProjectRelationshipsRO'
    ProjectListRO:
      title: ProjectListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProjectDataRO'
          description: An array of SMO Projects
    ProjectRO:
      title: ProjectRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProjectDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to a SMO Project, such as ServiceData, etc.
    ProjectRelationshipsRO:
      title: ProjectRelationshipsRO
      type: object
      properties:
        srcFre:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        smoServices:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    ServiceAttributesRO:
      title: ServiceAttributesRO
      type: object
      properties:
        displayData:
          $ref: '#/components/schemas/ServiceDisplayDataRO'
        state:
          $ref: '#/components/schemas/State19'
        statusMessage:
          type: string
          description: Additional details pertaining to the move - information about the current step and/or any failure conditions
        statusSummary:
          type: string
          description: If set, will show the move progress stage e.g. `Step X of Y`
        onHomePath:
          type: boolean
          description: An indicator to flag when if the service is currently on its home path
          default: false
    ServiceDataRO:
      title: ServiceDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the SMO service
        type:
          $ref: '#/components/schemas/Type87'
        attributes:
          $ref: '#/components/schemas/ServiceAttributesRO'
        relationships:
          $ref: '#/components/schemas/ServiceRelationshipsRO'
    ServiceDisplayDataRO:
      title: ServiceDisplayDataRO
      type: object
      properties:
        displayState:
          type: string
          description: A UI-friendly consolidated version of data.attributes.state
    ServicePatchOperationRO:
      title: ServicePatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op10'
        path:
          type: string
          description: path of the object/attribute to be patched
        value:
          type: string
          description: new desired value for the attribute specified in the path.
        ids:
          type: array
          items:
            type: string
          description: Used to target specific services; if empty/unspecified, it's assumed all services are being targeted
    ServicePatchRO:
      title: ServicePatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/ServicePatchOperationRO'
          description: ''
    ServiceRO:
      title: ServiceRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ServiceDataRO'
        included:
          type: array
          items:
            type: object
          description: Resources related to an SMO Service, such as servicePaths, etc.
    ServiceRelationshipsRO:
      title: ServiceRelationshipsRO
      type: object
      properties:
        fre:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        servicePath:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    AfiSafiNextHopSelf:
      title: AfiSafiNextHopSelf
      type: object
      properties:
        configured:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
        excludeReflectedRoutes:
          type: boolean
          description: true/false depending on if nbr is added as route reflector client for afi and safi
          default: false
    AfiSafiOrf:
      title: AfiSafiOrf
      type: object
      properties:
        type:
          type: string
          description: Outbound Route Filtering type
        direction:
          $ref: '#/components/schemas/Direction2'
    AfiSafiPrefixList:
      title: AfiSafiPrefixList
      type: object
      properties:
        name:
          type: string
          description: Name to filter BGP advertisements.
        direction:
          $ref: '#/components/schemas/Direction1'
    ClassOfServices:
      title: ClassOfServices
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name1'
        bandwidthProfileName:
          type: string
          description: Name of the Bandwidth Profile
        bandwidthProfileIndex:
          type: string
          description: Index number of the Bandwidth Profile
    Constraints:
      title: Constraints
      type: object
      properties:
        includeRouteObjects:
          type: array
          items:
            $ref: '#/components/schemas/RouteObject'
          description: List of Route Objects to be included in the route calculation.
        excludeRouteObjects:
          type: array
          items:
            $ref: '#/components/schemas/RouteObject'
          description: List of Route Objects to be excluded from the route calculation.
        customerCode:
          $ref: '#/components/schemas/CustomerCodeObject'
        diverseObjects:
          $ref: '#/components/schemas/DiversityObject'
        coRoutedService:
          type: string
          description: Co-routes the service with an existing service.
    CustomerCodeObject:
      title: CustomerCodeObject
      type: object
      properties:
        codes:
          type: array
          items:
            type: string
          description: List of CustomerCode in decreasing order of priority
        unorderedList:
          type: boolean
          description: Attribute to specify that code list is unordered.
          default: false
    DeviceAlias:
      title: DeviceAlias
      type: object
      properties:
        aliasType:
          $ref: '#/components/schemas/AliasType'
        name:
          type: string
          description: The text representation of this device alias.
        patternFormat:
          type: string
          description: An optional regex pattern for custom alias.
    Diagnostic:
      title: Diagnostic
      type: object
      properties:
        diagnosticType:
          $ref: '#/components/schemas/DiagnosticType'
        pmType:
          $ref: '#/components/schemas/PmType'
        degradeThreshold:
          type: number
          description: (Optional) The pre-FEC BER lower threshold
        failThreshold:
          type: number
          description: (Optional) The pre-FEC BER higher threshold
    DiagnosticStatus:
      title: DiagnosticStatus
      type: object
      properties:
        diagnosticType:
          $ref: '#/components/schemas/DiagnosticType'
        pmType:
          $ref: '#/components/schemas/PmType'
        state:
          $ref: '#/components/schemas/State20'
    DiagnosticStatuses:
      title: DiagnosticStatuses
      type: object
      properties:
        diagnosticStatuses:
          type: array
          items:
            $ref: '#/components/schemas/DiagnosticStatus'
          description: A status list of performance monitoring (PM) and diagnostic tests
    Diagnostics:
      title: Diagnostics
      type: object
      properties:
        diagnostics:
          type: array
          items:
            $ref: '#/components/schemas/Diagnostic'
          description: A list of performance monitoring (PM) and diagnostic tests
    DiversityObject:
      title: DiversityObject
      type: object
      properties:
        srlgDiverse:
          type: boolean
          description: Attribute to specify SRLG diversity.
          default: false
        siteDiverse:
          type: boolean
          description: Attribute to specify site diversity.
          default: false
        nodeDiverse:
          type: boolean
          description: Attribute to specify node diversity.
          default: false
        existingService:
          type: array
          items:
            type: string
          description: The existing service user label list.
    Header:
      title: Header
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/HeaderElement'
          description: ''
        name:
          type: string
        value:
          type: string
    HeaderElement:
      title: HeaderElement
      type: object
      properties:
        name:
          type: string
        value:
          type: string
        parameterCount:
          type: integer
          format: int32
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/NameValuePair'
          description: ''
    HttpEntity:
      title: HttpEntity
      type: object
      properties:
        contentLength:
          type: integer
          format: int64
        contentType:
          $ref: '#/components/schemas/Header'
        contentEncoding:
          $ref: '#/components/schemas/Header'
        repeatable:
          type: boolean
          default: false
        chunked:
          type: boolean
          default: false
        streaming:
          type: boolean
          default: false
        content:
          type: object
    HttpResponse:
      title: HttpResponse
      type: object
      properties:
        locale:
          $ref: '#/components/schemas/Locale'
        statusLine:
          $ref: '#/components/schemas/StatusLine'
        entity:
          $ref: '#/components/schemas/HttpEntity'
        allHeaders:
          type: array
          items:
            $ref: '#/components/schemas/Header'
          description: ''
        protocolVersion:
          $ref: '#/components/schemas/ProtocolVersion'
        params:
          type: object
    Locale:
      title: Locale
      type: object
      properties:
        language:
          type: string
        script:
          type: string
        country:
          type: string
        variant:
          type: string
        extensionKeys:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        unicodeLocaleAttributes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        unicodeLocaleKeys:
          uniqueItems: true
          type: array
          items:
            type: string
          description: ''
        iso3Language:
          type: string
        iso3Country:
          type: string
        displayLanguage:
          type: string
        displayScript:
          type: string
        displayCountry:
          type: string
        displayVariant:
          type: string
        displayName:
          type: string
    LocationAddress:
      title: LocationAddress
      type: object
      properties:
        key:
          $ref: '#/components/schemas/Key'
        value:
          type: string
          description: int or character value as appropriate to the associated entity and field.
        pattern:
          type: string
          description: optional regex or delimiter value to parse multi-valued subslot string.
    MsgsLastError:
      title: MsgsLastError
      type: object
      properties:
        errorCode:
          type: string
          description: Error code for last error
        errorSubCode:
          type: string
          description: Sub error code for last error
    NameValuePair:
      title: NameValuePair
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    PreemptionBandwidth:
      title: PreemptionBandwidth
      type: object
      properties:
        extraTraffic:
          $ref: '#/components/schemas/PreemptionBandwidthData'
        preemptable:
          $ref: '#/components/schemas/PreemptionBandwidthData'
        nonPreemptable:
          $ref: '#/components/schemas/PreemptionBandwidthData'
    PreemptionBandwidthData:
      title: PreemptionBandwidthData
      type: object
      properties:
        ODU0:
          $ref: '#/components/schemas/Bw'
        ODU1:
          $ref: '#/components/schemas/Bw'
        ODU2:
          $ref: '#/components/schemas/Bw'
        ODU2E:
          $ref: '#/components/schemas/Bw'
        ODU3:
          $ref: '#/components/schemas/Bw'
        ODU4:
          $ref: '#/components/schemas/Bw'
        ODUFLEXRSZ:
          $ref: '#/components/schemas/Bw'
        ODUFLEXNRSZ:
          $ref: '#/components/schemas/Bw'
    ProtocolVersion:
      title: ProtocolVersion
      type: object
      properties:
        protocol:
          type: string
        major:
          type: integer
          format: int32
        minor:
          type: integer
          format: int32
    RouteObject:
      title: RouteObject
      type: object
      properties:
        routeObjectType:
          $ref: '#/components/schemas/RouteObjectType'
        terminationPointName:
          $ref: '#/components/schemas/TerminationPointName'
        roadmLineName:
          type: string
          description: The ROADM Line Name. The routeObjectType attribute must be set to ROADM_LINE_NAME.
        nodeName:
          type: string
          description: The Node/ROADM/Network Construct Name. The routeObjectType attribute must be set to NODE_NAME.
        siteName:
          type: string
          description: The Site Name. The routeObjectType attribute must be set to SITE_NAME.
        controlPlane:
          $ref: '#/components/schemas/ControlPlane'
        frequency:
          type: string
          description: L0 frequency. The routeObjectType attribute must be set to FREQUENCY.
        sncg:
          type: string
          description: SNCG id. The routeObjectType attribute must be set to SNCG.
        snc:
          type: string
          description: SNC id. The routeObjectType attribute must be set to SNC.
        sncgState:
          $ref: '#/components/schemas/SncgState'
    ServiceAlias:
      title: ServiceAlias
      type: object
      properties:
        aliasType:
          $ref: '#/components/schemas/AliasType1'
        name:
          type: string
          description: The free string name value associated with selected aliasType.
    ServiceIntentEndPoint:
      title: ServiceIntentEndPoint
      type: object
      properties:
        networkElement:
          $ref: '#/components/schemas/NetworkElement'
        shelf:
          type: string
          description: Optional node shelf location identifier.
        slot:
          type: string
          description: Optional node slot location identifier.
        port:
          type: string
          description: The node port location identifier.
        subport:
          type: string
          description: The node subport location identifier
        eqptGrp:
          type: string
          description: The node Equipment Group location identifier
        lspName:
          type: string
          description: The name of the label switch path ids(unique) of the service to be created and activated
        pseudoWireId:
          type: string
          description: The name of the pseudoWireId(unique) of the MPLS service to be created and activated
        tunnelRole:
          $ref: '#/components/schemas/TunnelRole3'
        protectionRole:
          $ref: '#/components/schemas/ProtectionRole1'
        layerTerminations:
          type: array
          items:
            $ref: '#/components/schemas/LayerTermination'
          description: Transmission parameters to be provisioned on TPE layer terminations.
        interfaceType:
          $ref: '#/components/schemas/InterfaceType'
    ServiceIntentRequest:
      title: ServiceIntentRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ServiceIntentRequestData'
    ServiceIntentRequestAttributes:
      title: ServiceIntentRequestAttributes
      type: object
      properties:
        turnUpDateTime:
          type: string
          description: The optional time when the service is to be activated. If omitted the service shall be activated immediately (now).
          format: date-time
        turnDownDateTime:
          type: string
          description: The optional time when the service is to be de-activated. If omitted the service shall remain activated until explicit deletion.
          format: date-time
        aliasNames:
          type: array
          items:
            $ref: '#/components/schemas/ServiceAlias'
          description: One or more alias names that identify the service to be created and activated.
        label:
          type: string
          description: The user label (not necessarily unique) of the service to be created and activated.
        directionality:
          $ref: '#/components/schemas/Directionality1'
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
        evcPortType:
          $ref: '#/components/schemas/EvcPortType'
        endPoints:
          type: array
          items:
            $ref: '#/components/schemas/ServiceIntentEndPoint'
          description: All the endpoints involved in the definition of the service. Two instances must always be defined based on supported service type.
        constraints:
          $ref: '#/components/schemas/Constraints'
        postActivationTests:
          $ref: '#/components/schemas/Diagnostics'
    ServiceIntentRequestData:
      title: ServiceIntentRequestData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ServiceIntentRequestAttributes'
    ServiceIntentResponse:
      title: ServiceIntentResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ServiceIntentResponseData'
    ServiceIntentResponseArray:
      title: ServiceIntentResponseArray
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ServiceIntentResponseData'
          description: Array containing all Service Intent Response Data obtained from the request.
    ServiceIntentResponseAttributes:
      title: ServiceIntentResponseAttributes
      type: object
      properties:
        creationTime:
          type: string
          description: The time at which the service intent was created.
          format: date-time
        intentState:
          type: string
          description: The current state of the service intent.
        supportingServices:
          type: array
          items:
            type: string
          description: ''
        request:
          $ref: '#/components/schemas/ServiceIntentRequestData'
        discovered:
          type: boolean
          description: True if the Service Intent was discovered/promoted from the network.
          default: false
        postActivationTestStatus:
          $ref: '#/components/schemas/DiagnosticStatuses'
    ServiceIntentResponseData:
      title: ServiceIntentResponseData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the service intent.
        type:
          type: string
          description: The type of the service intent.
        attributes:
          $ref: '#/components/schemas/ServiceIntentResponseAttributes'
    ServiceIntentRoute:
      title: ServiceIntentRoute
      type: object
      properties:
        aToZRoute:
          type: array
          items:
            $ref: '#/components/schemas/ServiceIntentRouteLink'
          description: ''
        zToARoute:
          type: array
          items:
            $ref: '#/components/schemas/ServiceIntentRouteLink'
          description: ''
        supportingRoadmLines:
          type: array
          items:
            type: string
          description: ''
        sharedRiskLinkGroupNames:
          type: array
          items:
            type: string
          description: ''
    ServiceIntentRouteAttributes:
      title: ServiceIntentRouteAttributes
      type: object
      properties:
        aToZRoute:
          type: array
          items:
            $ref: '#/components/schemas/ServiceIntentRouteLink'
          description: ''
        zToARoute:
          type: array
          items:
            $ref: '#/components/schemas/ServiceIntentRouteLink'
          description: ''
        supportingRoadmLines:
          type: array
          items:
            type: string
          description: ''
        sharedRiskLinkGroupNames:
          type: array
          items:
            type: string
          description: ''
    ServiceIntentRouteData:
      title: ServiceIntentRouteData
      type: object
      properties:
        id:
          type: string
          description: Service Intent ID.
        type:
          type: string
          description: 'The object type: serviceIntentRoute.'
        attributes:
          $ref: '#/components/schemas/ServiceIntentRouteAttributes'
    ServiceIntentRouteLink:
      title: ServiceIntentRouteLink
      type: object
      properties:
        aPoint:
          $ref: '#/components/schemas/ServiceIntentRouteLinkEndPoint'
        zPoint:
          $ref: '#/components/schemas/ServiceIntentRouteLinkEndPoint'
        directionality:
          $ref: '#/components/schemas/Directionality2'
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate'
    ServiceIntentRouteLinkEndPoint:
      title: ServiceIntentRouteLinkEndPoint
      type: object
      properties:
        networkElementName:
          type: string
          description: Identification of the node using its natural name from the NE NBI protocol (e.g. TID for TL1, sysName for SAOS).
        shelf:
          type: string
          description: Optional shelf location identifier.
        slot:
          type: string
          description: Optional slot location identifier.
        port:
          type: string
          description: The port location identifier.
        wavelength:
          type: string
          description: The wavelength location identifier.
    ServiceIntentRoutes:
      title: ServiceIntentRoutes
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ServiceIntentRoutesData'
    ServiceIntentRoutesAttributes:
      title: ServiceIntentRoutesAttributes
      type: object
      properties:
        routes:
          $ref: '#/components/schemas/ServiceIntentRoute'
    ServiceIntentRoutesData:
      title: ServiceIntentRoutesData
      type: object
      properties:
        id:
          type: string
          description: Service Intent ID.
        type:
          type: string
          description: 'The object type: serviceIntentRoutes.'
        attributes:
          $ref: '#/components/schemas/ServiceIntentRoutesAttributes'
    StatusLine:
      title: StatusLine
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        protocolVersion:
          $ref: '#/components/schemas/ProtocolVersion'
        reasonPhrase:
          type: string
    TerminationPointName:
      title: TerminationPointName
      type: object
      properties:
        deviceAlias:
          $ref: '#/components/schemas/DeviceAlias'
        location:
          type: object
    service-operationinput:
      title: service-operationinput
      type: object
      properties:
        bp-tenant-id:
          type: string
        service-intent-id:
          type: string
    tapi.ciena.EmbeddedEthernetAttributes:
      title: tapi.ciena.EmbeddedEthernetAttributes
      type: object
      properties:
        bit-rate:
          type: integer
          description: none
          format: int64
        trib-slots:
          type: integer
          description: none
          format: int32
        line-rate:
          type: string
          description: none
    tapi.ciena.alternativePhysicalRouteExt:
      title: tapi.ciena.alternativePhysicalRouteExt
      type: object
      properties:
        alternativePhysicalRoute:
          $ref: '#/components/schemas/tapi.ciena.alternativePhysicalRouteExt.PhysicalRoute'
    tapi.ciena.alternativePhysicalRouteExt.PhysicalRoute:
      title: tapi.ciena.alternativePhysicalRouteExt.PhysicalRoute
      type: object
      properties:
        routePurpose:
          type: string
        unidirectionalPhysicalRoute:
          type: array
          items:
            $ref: '#/components/schemas/tapi.ciena.alternativePhysicalRouteExt.UnidirectionalPhysicalRoute'
          description: ''
    tapi.ciena.alternativePhysicalRouteExt.UnidirectionalPhysicalRoute:
      title: tapi.ciena.alternativePhysicalRouteExt.UnidirectionalPhysicalRoute
      type: object
      properties:
        equipmentPortPair:
          type: array
          items:
            $ref: '#/components/schemas/tapi.ciena.alternativePhysicalRouteExt.EquipmentUsed'
          description: ''
        routeRole:
          type: string
        localId:
          type: string
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: ''
    tapi.ciena.alternativePhysicalRouteExt.EquipmentUsed:
      title: tapi.ciena.alternativePhysicalRouteExt.EquipmentUsed
      type: object
      properties:
        deviceName:
          type: string
        deviceUuid:
          type: string
        equipmentLocalAddress:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: ''
        equipmentUuid:
          type: string
        ingress:
          type: array
          items:
            $ref: '#/components/schemas/tapi.ciena.alternativePhysicalRouteExt.ConnectorPinDetails'
          description: ''
        egress:
          type: array
          items:
            $ref: '#/components/schemas/tapi.ciena.alternativePhysicalRouteExt.ConnectorPinDetails'
          description: ''
    tapi.ciena.alternativePhysicalRouteExt.ConnectorPinDetails:
      title: tapi.ciena.alternativePhysicalRouteExt.ConnectorPinDetails
      type: object
      properties:
        connectorIdentification:
          type: string
        pinIdentification:
          type: string
    tapi.ciena.AdjacencyPackage:
      title: tapi.ciena.AdjacencyPackage
      type: object
      properties:
        adjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage1'
    tapi.ciena.LLDPSnoop:
      title: tapi.ciena.LLDPSnoop
      type: object
      properties:
        lldpSnoop:
          $ref: '#/components/schemas/tapi.ciena.LLDPExtensions'
    tapi.ciena.LLDPExtensions:
      title: tapi.ciena.LLDPExtensions
      type: object
      properties:
        remotePortId:
          type: string
        remoteChassisId:
          type: string
        tagVersion:
          type: string
        systemDescription:
          type: string
        remoteIpAddress:
          type: string
        systemName:
          type: string
    deeppaging.connection.Response:
      title: deeppaging.connection.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.connection.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.connection.Data:
      title: deeppaging.connection.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.connectivity.Connection'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.connectivity-service.Response:
      title: deeppaging.connectivity-service.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.connectivity-service.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.connectivity-service.Data:
      title: deeppaging.connectivity-service.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.connectivity.ConnectivityService'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.service-interface-point.Response:
      title: deeppaging.service-interface-point.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.service-interface-point.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.service-interface-point.Data:
      title: deeppaging.service-interface-point.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.common.ServiceInterfacePoint'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.link.Response:
      title: deeppaging.link.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.link.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.link.Data:
      title: deeppaging.link.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.topology.Link'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.node.Response:
      title: deeppaging.node.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.node.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.node.Data:
      title: deeppaging.node.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.topology.topology.Node'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.node-edge-point.Response:
      title: deeppaging.node-edge-point.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.node-edge-point.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.node-edge-point.Data:
      title: deeppaging.node-edge-point.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.connection-end-point.Response:
      title: deeppaging.connection-end-point.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.connection-end-point.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.connection-end-point.Data:
      title: deeppaging.connection-end-point.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.connectivity.CepList'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.device.Response:
      title: deeppaging.device.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.device.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.device.Data:
      title: deeppaging.device.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.equipment.Device'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.equipment.Response:
      title: deeppaging.equipment.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.equipment.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.equipment.Data:
      title: deeppaging.equipment.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.equipment.Equipment'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    deeppaging.equipmentholder.Response:
      title: deeppaging.equipmentholder.Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/deeppaging.equipmentholder.Data'
          description: ''
        links:
          $ref: '#/components/schemas/Links4'
    deeppaging.equipmentholder.Data:
      title: deeppaging.equipmentholder.Data
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/EventType'
        object_data:
          $ref: '#/components/schemas/tapi.equipment.Holder'
        object_id:
          type: string
          description: TAPI UUID
        object_type:
          type: string
        version:
          type: string
          description: TAPI version
    tapi.ciena.LinkExtensions:
      title: tapi.ciena.LinkExtensions
      type: object
      properties:
        signalContentType:
          type: string
    tapi.ciena.ConnectionExtensions:
      title: tapi.ciena.ConnectionExtensions
      type: object
      properties:
        service-class:
          type: string
        signal-content-type:
          type: string
        layer-qualifier:
          type: string
        direct-server-connection:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionRef'
          description: >-
            A connection (x) may be supported by one or more server layer top level connections.
                          A sever layer top level connection (direct server connection) supports a link that provides the adjacency between the nodes that
                          support the connection (x).
                          A node supporting the connection (x) may support a lower-connection of connection (x) or it may simply support a CEP that
                          terminates the connection (x).
                          The combination of the direct-server-connection list and the lower-connection list provides a detailed description of the route
                          of connection (x).
                          Each top level connection listed in the direct-server-connection list may also provide a list of its direct-server-connections.
                          Recursing through direct-server-connection of direct-server-connections enables rapid layer navigation.
    tapi.ciena.ConnectionEndPointExtensions:
      title: tapi.ciena.ConnectionEndPointExtensions
      type: object
      properties:
        signalContentType:
          type: string
        interfaceType:
          type: string
        additionalAttributes:
          type: object
    tapi.ciena.NodeExtensions:
      title: tapi.ciena.NodeExtensions
      type: object
      properties:
        sync-state:
          $ref: '#/components/schemas/SyncState1'
    tapi.ciena.PhotonicConnectivityServiceEndpointExtensions:
      title: tapi.ciena.PhotonicConnectivityServiceEndpointExtensions
      type: object
      properties:
        photonic-interface-point:
          $ref: '#/components/schemas/tapi.common.ServiceInterfacePointRef'
        signal-conditioning:
          $ref: '#/components/schemas/SignalConditioning'
        ains:
          $ref: '#/components/schemas/Ains'
    tapi.ciena.ConnectivityServiceExtensions:
      title: tapi.ciena.ConnectivityServiceExtensions
      type: object
      properties:
        center-frequency:
          type: number
          description: Requested Center Frequency
        maximize-capacity:
          type: boolean
          description: Maximize capacity for single photonic service
        spectral-assign-option:
          $ref: '#/components/schemas/SpectralAssignOption'
        deployment-state:
          $ref: '#/components/schemas/DeploymentState1'
        osrp-enabled:
          type: boolean
          description: none
          default: false
        last-error-msg:
          type: string
          description: outcome of last provisioning or routing operation. Blank if no errors occured
        service-type-constraint:
          $ref: '#/components/schemas/ServiceTypeConstraint'
        restoration-path-diversity-exclusion:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionRef'
          description: none
        restoration-path-include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        restoration-path-exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-restoration-path-include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-restoration-path-exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
    tapi.common.AdminStatePac:
      title: tapi.common.AdminStatePac
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
    tapi.common.AdministrativeState:
      title: tapi.common.AdministrativeState
      enum:
      - LOCKED
      - UNLOCKED
      type: string
    tapi.common.Capacity:
      title: tapi.common.Capacity
      type: object
      properties:
        total-size:
          $ref: '#/components/schemas/tapi.common.CapacityValue'
        is-for-multiple-routes:
          type: boolean
          default: false
        baudRate:
          $ref: '#/components/schemas/BaudRate'
    tapi.common.CapacityPac:
      title: tapi.common.CapacityPac
      type: object
      properties:
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
    tapi.common.CapacityUnit:
      title: tapi.common.CapacityUnit
      enum:
      - TB
      - TBPS
      - GB
      - GBPS
      - MB
      - MBPS
      - KB
      - KBPS
      - GHz
      - MHz
      type: string
    tapi.common.CapacityValue:
      title: tapi.common.CapacityValue
      type: object
      properties:
        value:
          type: integer
          description: none
          format: int32
        unit:
          $ref: '#/components/schemas/tapi.common.CapacityUnit'
    tapi.common.Context:
      title: tapi.common.Context
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        connectivity-context:
          $ref: '#/components/schemas/tapi.connectivity.ConnectivityContext'
        topology-context:
          $ref: '#/components/schemas/tapi.topology.TopologyContext'
        service-interface-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.context.ServiceInterfacePoint'
          description: none
    tapi.common.DirectiveValue:
      title: tapi.common.DirectiveValue
      enum:
      - MINIMIZE
      - MAXIMIZE
      - ALLOW
      - DISALLOW
      - DONT_CARE
      type: string
    tapi.common.ForwardingDirection:
      title: tapi.common.ForwardingDirection
      enum:
      - BIDIRECTIONAL
      - UNIDIRECTIONAL
      - UNDEFINED_OR_UNKNOWN
      type: string
    tapi.common.GlobalClass:
      title: tapi.common.GlobalClass
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
    tapi.common.LayerProtocolName:
      title: tapi.common.LayerProtocolName
      enum:
      - ODU
      - ETH
      - DSR
      - PHOTONIC_MEDIA
      type: string
    tapi.common.LifecycleState:
      title: tapi.common.LifecycleState
      enum:
      - PLANNED
      - POTENTIAL_AVAILABLE
      - POTENTIAL_BUSY
      - INSTALLED
      - PENDING_REMOVAL
      type: string
    tapi.common.LocalClass:
      title: tapi.common.LocalClass
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        local-id:
          type: string
          description: none
    tapi.common.NameAndValue:
      title: tapi.common.NameAndValue
      type: object
      properties:
        value-name:
          type: string
          description: The name of the value. The value need not have a name.
        value:
          type: string
          description: The value
    tapi.common.OperationalState:
      title: tapi.common.OperationalState
      enum:
      - DISABLED
      - ENABLED
      type: string
    tapi.common.OperationalStatePac:
      title: tapi.common.OperationalStatePac
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
    tapi.common.PortDirection:
      title: tapi.common.PortDirection
      enum:
      - BIDIRECTIONAL
      - INPUT
      - OUTPUT
      - UNIDENTIFIED_OR_UNKNOWN
      type: string
    tapi.common.PortRole:
      title: tapi.common.PortRole
      enum:
      - SYMMETRIC
      - ROOT
      - LEAF
      - TRUNK
      - UNKNOWN
      type: string
    tapi.common.ServiceInterfacePoint:
      title: tapi.common.ServiceInterfacePoint
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        supported-layer-protocol-qualifier:
          type: array
          items:
            type: string
          description: none
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
    tapi.common.ServiceInterfacePointRef:
      title: tapi.common.ServiceInterfacePointRef
      type: object
      properties:
        service-interface-point-uuid:
          type: string
          description: none
    tapi.common.TerminationDirection:
      title: tapi.common.TerminationDirection
      enum:
      - BIDIRECTIONAL
      - SINK
      - SOURCE
      - UNDEFINED_OR_UNKNOWN
      type: string
    tapi.common.TerminationPac:
      title: tapi.common.TerminationPac
      type: object
      properties:
        termination-direction:
          $ref: '#/components/schemas/tapi.common.TerminationDirection'
        termination-state:
          $ref: '#/components/schemas/tapi.common.TerminationState'
    tapi.common.TerminationState:
      title: tapi.common.TerminationState
      enum:
      - LP_CAN_NEVER_TERMINATE
      - LT_NOT_TERMINATED
      - TERMINATED_SERVER_TO_CLIENT_FLOW
      - TERMINATED_CLIENT_TO_SERVER_FLOW
      - TERMINATED_BIDIRECTIONAL
      - LT_PERMENANTLY_TERMINATED
      - TERMINATION_STATE_UNKNOWN
      type: string
    tapi.common.TimeInterval:
      title: tapi.common.TimeInterval
      type: object
      properties:
        period:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.TimePeriod'
          description: none
    tapi.common.TimePeriod:
      title: tapi.common.TimePeriod
      type: object
      properties:
        value:
          type: integer
          description: none
          format: int32
        unit:
          $ref: '#/components/schemas/tapi.common.TimeUnit'
    tapi.common.TimeRange:
      title: tapi.common.TimeRange
      type: object
      properties:
        end-time:
          type: string
          description: none
        start-time:
          type: string
          description: none
    tapi.common.TimeUnit:
      title: tapi.common.TimeUnit
      enum:
      - YEARS
      - MONTHS
      - DAYS
      - HOURS
      - MINUTES
      - SECONDS
      - MILLISECONDS
      - MICROSECONDS
      - NANOSECONDS
      - PICOSECONDS
      type: string
    tapi.common.context.ServiceInterfacePoint:
      title: tapi.common.context.ServiceInterfacePoint
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        supported-layer-protocol-qualifier:
          type: array
          items:
            type: string
          description: none
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        media-channel-service-interface-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelServiceInterfacePointSpec'
        otsi-service-interface-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiServiceInterfacePointSpec'
    tapi.connectivity.Connection:
      title: tapi.connectivity.Connection
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        alternativePhysicalRoute:
          $ref: '#/components/schemas/tapi.ciena.alternativePhysicalRouteExt.PhysicalRoute'
        supported-client-link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LinkRef'
          description: none
        lower-connection:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionRef'
          description: "An Connection object supports a recursive aggregation relationship such that the internal construction of an Connection can be exposed as multiple lower level Connection objects (partitioning).\r\n                    Aggregation is used as for the Node/Topology  to allow changes in hierarchy. \r\n                    Connection aggregation reflects Node/Topology aggregation. \r\n                    The FC represents a Cross-Connection in an NE. The Cross-Connection in an NE is not necessarily the lowest level of FC partitioning."
        route:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.Route'
          description: none
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPointRef'
          description: none
        direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
    tapi.connectivity.CepList:
      title: tapi.connectivity.CepList
      type: object
      properties:
        connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPoint'
          description: none
    tapi.connectivity.ConnectionEndPoint:
      title: tapi.connectivity.ConnectionEndPoint
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        termination-direction:
          $ref: '#/components/schemas/tapi.common.TerminationDirection'
        termination-state:
          $ref: '#/components/schemas/tapi.common.TerminationState'
        client-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
        connection-port-role:
          $ref: '#/components/schemas/tapi.common.PortRole'
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        layer-protocol-qualifier:
          type: string
          description: none
        parent-node-edge-point:
          $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
        aggregated-connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPointRef'
          description: none
        connection-port-direction:
          $ref: '#/components/schemas/tapi.common.PortDirection'
    tapi.connectivity.ConnectionEndPointRef:
      title: tapi.connectivity.ConnectionEndPointRef
      type: object
      properties:
        topology-uuid:
          type: string
          description: none
        node-uuid:
          type: string
          description: none
        node-edge-point-uuid:
          type: string
          description: none
        connection-end-point-uuid:
          type: string
          description: none
    tapi.connectivity.ConnectionRef:
      title: tapi.connectivity.ConnectionRef
      type: object
      properties:
        connection-uuid:
          type: string
          description: none
    tapi.connectivity.ConnectivityConstraint:
      title: tapi.connectivity.ConnectivityConstraint
      type: object
      properties:
        service-layer:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        connectivity-direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
        requested-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        diversity-exclusion:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectivityServiceRef'
          description: none
        connection-inclusion:
          type: array
          items:
            type: string
          description: >-
            A ConnectivityService may use one or more existing Connections.

                            A common traditional strategy is to set up “stranded” connectivity in the core of the network as “express channels” (this is essentially a serial compound link, but can be treated as simple connections)

                            A connection inclusion capability allows for adoption of a discovered Connections.

                            A ConnectivityService is requested with a connection inclusion constraint that identifies a connection (or chain of connections) that is bounded by CEPs that each belong to a NEP that references a SIP that is referenced by a CSEP of the ConnectivityService such that all CSEPs are satisfied by CEPs of the existing Connection. will allow discovered Connections with no stated intent to be associated with an intent via the ConnectivityService.
        service-level:
          type: string
          description: An abstract value the meaning of which is mutually agreed � typically represents metrics such as - Class of service, priority, resiliency, availability
        service-type:
          $ref: '#/components/schemas/tapi.connectivity.ServiceType'
        coroute-inclusion:
          $ref: '#/components/schemas/tapi.connectivity.ConnectivityServiceRef'
    tapi.connectivity.ConnectivityContext:
      title: tapi.connectivity.ConnectivityContext
      type: object
      properties:
        connectivity-service:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectivityService'
          description: none
        connection:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.Connection'
          description: none
    tapi.connectivity.ConnectivityService:
      title: tapi.connectivity.ConnectivityService
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        service-layer:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        connectivity-direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
        requested-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        diversity-exclusion:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectivityServiceRef'
          description: none
        connection-inclusion:
          type: array
          items:
            type: string
          description: >-
            A ConnectivityService may use one or more existing Connections.

                            A common traditional strategy is to set up “stranded” connectivity in the core of the network as “express channels” (this is essentially a serial compound link, but can be treated as simple connections)

                            A connection inclusion capability allows for adoption of a discovered Connections.

                            A ConnectivityService is requested with a connection inclusion constraint that identifies a connection (or chain of connections) that is bounded by CEPs that each belong to a NEP that references a SIP that is referenced by a CSEP of the ConnectivityService such that all CSEPs are satisfied by CEPs of the existing Connection. will allow discovered Connections with no stated intent to be associated with an intent via the ConnectivityService.
        service-level:
          type: string
          description: An abstract value the meaning of which is mutually agreed � typically represents metrics such as - Class of service, priority, resiliency, availability
        service-type:
          $ref: '#/components/schemas/tapi.connectivity.ServiceType'
        coroute-inclusion:
          $ref: '#/components/schemas/tapi.connectivity.ConnectivityServiceRef'
        restoration-coordinate-type:
          $ref: '#/components/schemas/tapi.connectivity.CoordinateType'
        wait-to-revert-time:
          type: integer
          description: If the protection system is revertive, this attribute specifies the time, in minutes, to wait after a fault clears on a higher priority (preferred) resource before reverting to the preferred resource.
          format: int32
          default: 15
        resilience-type:
          $ref: '#/components/schemas/tapi.topology.ResilienceType'
        reversion-mode:
          $ref: '#/components/schemas/tapi.connectivity.ReversionMode'
        is-exclusive:
          type: boolean
          description: To distinguish if the resources are to be exclusive to the service
          default: true
        diversity-policy:
          $ref: '#/components/schemas/tapi.path.computation.DiversityPolicy'
        route-objective-function:
          $ref: '#/components/schemas/tapi.path.computation.RouteObjectiveFunction'
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        risk-diversity-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.RiskCharacteristic'
          description: ''
        route-direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
        include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        exclude-link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LinkRef'
          description: ''
        include-link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LinkRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: ''
        center-frequency:
          type: number
          description: Requested Center Frequency
        maximize-capacity:
          type: boolean
          description: Maximize capacity for single photonic service
        spectral-assign-option:
          $ref: '#/components/schemas/SpectralAssignOption'
        deployment-state:
          $ref: '#/components/schemas/DeploymentState1'
        osrp-enabled:
          type: boolean
          description: none
          default: false
        last-error-msg:
          type: string
          description: outcome of last provisioning or routing operation. Blank if no errors occured
        service-type-constraint:
          $ref: '#/components/schemas/ServiceTypeConstraint'
        restoration-path-diversity-exclusion:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionRef'
          description: none
        restoration-path-include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        restoration-path-exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-restoration-path-include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-restoration-path-exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        protecting-exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectivityServiceEndPoint'
          description: none
        connection:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionRef'
          description: none
    tapi.connectivity.ConnectivityServiceEndPoint:
      title: tapi.connectivity.ConnectivityServiceEndPoint
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        local-id:
          type: string
          description: none
        photonic-interface-point:
          $ref: '#/components/schemas/tapi.common.ServiceInterfacePointRef'
        signal-conditioning:
          $ref: '#/components/schemas/SignalConditioning'
        ains:
          $ref: '#/components/schemas/Ains'
        service-interface-point:
          $ref: '#/components/schemas/tapi.common.ServiceInterfacePointRef'
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        layer-protocol-qualifier:
          $ref: '#/components/schemas/LayerProtocolQualifier'
        connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPointRef'
          description: ''
        direction:
          $ref: '#/components/schemas/tapi.common.PortDirection'
        capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
    tapi.connectivity.ConnectivityServiceEndPointRef:
      title: tapi.connectivity.ConnectivityServiceEndPointRef
      type: object
      properties:
        connectivity-service-uuid:
          type: string
        connectivity-service-end-point-local-id:
          type: string
    tapi.connectivity.ConnectivityServiceRef:
      title: tapi.connectivity.ConnectivityServiceRef
      type: object
      properties:
        connectivity-service-uuid:
          type: string
    tapi.connectivity.ContextAugmentation4:
      title: tapi.connectivity.ContextAugmentation4
      type: object
      properties:
        connectivity-context:
          $ref: '#/components/schemas/tapi.connectivity.ConnectivityContext'
    tapi.connectivity.CoordinateType:
      title: tapi.connectivity.CoordinateType
      enum:
      - NO_COORDINATE
      - HOLD_OFF_TIME
      - WAIT_FOR_NOTIFICATION
      type: string
    tapi.connectivity.OwnedNodeEdgePointAugmentation2:
      title: tapi.connectivity.OwnedNodeEdgePointAugmentation2
      type: object
      properties:
        cep-list:
          $ref: '#/components/schemas/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList'
    tapi.connectivity.ProtectionRole:
      title: tapi.connectivity.ProtectionRole
      enum:
      - WORK
      - PROTECT
      - PROTECTED
      - NA
      - WORK_RESTORE
      - PROTECT_RESTORE
      type: string
    tapi.connectivity.ResilienceConstraint:
      title: tapi.connectivity.ResilienceConstraint
      type: object
      properties:
        restoration-coordinate-type:
          $ref: '#/components/schemas/tapi.connectivity.CoordinateType'
        wait-to-revert-time:
          type: integer
          description: If the protection system is revertive, this attribute specifies the time, in minutes, to wait after a fault clears on a higher priority (preferred) resource before reverting to the preferred resource.
          format: int32
          default: 15
        resilience-type:
          $ref: '#/components/schemas/tapi.topology.ResilienceType'
        reversion-mode:
          $ref: '#/components/schemas/tapi.connectivity.ReversionMode'
    tapi.connectivity.ReversionMode:
      title: tapi.connectivity.ReversionMode
      enum:
      - REVERTIVE
      - NON-REVERTIVE
      type: string
    tapi.connectivity.Route:
      title: tapi.connectivity.Route
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        local-id:
          type: string
          description: none
        connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPointRef'
          description: ''
    tapi.connectivity.RouteRef:
      title: tapi.connectivity.RouteRef
      type: object
      properties:
        connection-uuid:
          type: string
          description: none
        route-local-id:
          type: string
    tapi.connectivity.ServiceType:
      title: tapi.connectivity.ServiceType
      enum:
      - POINT_TO_POINT_CONNECTIVITY
      - POINT_TO_MULTIPOINT_CONNECTIVITY
      - MULTIPOINT_CONNECTIVITY
      - ROOTED_MULTIPOINT_CONNECTIVITY
      type: string
    tapi.connectivity.ceplist.ConnectionEndPoint:
      title: tapi.connectivity.ceplist.ConnectionEndPoint
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        termination-direction:
          $ref: '#/components/schemas/tapi.common.TerminationDirection'
        termination-state:
          $ref: '#/components/schemas/tapi.common.TerminationState'
        client-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
        connection-port-role:
          $ref: '#/components/schemas/tapi.common.PortRole'
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        layer-protocol-qualifier:
          type: string
          description: none
        parent-node-edge-point:
          $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
        aggregated-connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPointRef'
          description: none
        connection-port-direction:
          $ref: '#/components/schemas/tapi.common.PortDirection'
        otsi-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiConnectionEndPointSpec'
        ots-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsConnectionEndPointSpec'
        media-channel-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelConnectionEndPointSpec'
        otsi-assembly-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec'
        media-channel-assembly-spec:
          type: object
    tapi.connectivity.connectivitycontext.ConnectivityService:
      title: tapi.connectivity.connectivitycontext.ConnectivityService
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        service-layer:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        connectivity-direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
        requested-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        diversity-exclusion:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectivityServiceRef'
          description: none
        connection-inclusion:
          type: array
          items:
            type: string
          description: >-
            A ConnectivityService may use one or more existing Connections.

                            A common traditional strategy is to set up “stranded” connectivity in the core of the network as “express channels” (this is essentially a serial compound link, but can be treated as simple connections)

                            A connection inclusion capability allows for adoption of a discovered Connections.

                            A ConnectivityService is requested with a connection inclusion constraint that identifies a connection (or chain of connections) that is bounded by CEPs that each belong to a NEP that references a SIP that is referenced by a CSEP of the ConnectivityService such that all CSEPs are satisfied by CEPs of the existing Connection. will allow discovered Connections with no stated intent to be associated with an intent via the ConnectivityService.
        service-level:
          type: string
          description: An abstract value the meaning of which is mutually agreed � typically represents metrics such as - Class of service, priority, resiliency, availability
        service-type:
          $ref: '#/components/schemas/tapi.connectivity.ServiceType'
        coroute-inclusion:
          $ref: '#/components/schemas/tapi.connectivity.ConnectivityServiceRef'
        restoration-coordinate-type:
          $ref: '#/components/schemas/tapi.connectivity.CoordinateType'
        wait-to-revert-time:
          type: integer
          description: If the protection system is revertive, this attribute specifies the time, in minutes, to wait after a fault clears on a higher priority (preferred) resource before reverting to the preferred resource.
          format: int32
          default: 15
        resilience-type:
          $ref: '#/components/schemas/tapi.topology.ResilienceType'
        reversion-mode:
          $ref: '#/components/schemas/tapi.connectivity.ReversionMode'
        is-exclusive:
          type: boolean
          description: To distinguish if the resources are to be exclusive to the service
          default: true
        diversity-policy:
          $ref: '#/components/schemas/tapi.path.computation.DiversityPolicy'
        route-objective-function:
          $ref: '#/components/schemas/tapi.path.computation.RouteObjectiveFunction'
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        risk-diversity-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.RiskCharacteristic'
          description: ''
        route-direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
        include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        exclude-link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LinkRef'
          description: ''
        include-link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LinkRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: ''
        bit-rate:
          type: integer
          description: none
          format: int64
        trib-slots:
          type: integer
          description: none
          format: int32
        line-rate:
          type: string
          description: none
        end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.connectivityservice.EndPoint1'
          description: ''
        connection:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionRef'
          description: ''
    tapi.connectivity.connectivityservice.EndPoint1:
      title: tapi.connectivity.connectivityservice.EndPoint1
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        local-id:
          type: string
          description: none
        photonic-interface-point:
          $ref: '#/components/schemas/tapi.common.ServiceInterfacePointRef'
        signal-conditioning:
          $ref: '#/components/schemas/SignalConditioning'
        ains:
          $ref: '#/components/schemas/Ains'
        service-interface-point:
          $ref: '#/components/schemas/tapi.common.ServiceInterfacePointRef'
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        layer-protocol-qualifier:
          $ref: '#/components/schemas/LayerProtocolQualifier'
        connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPointRef'
          description: ''
        direction:
          $ref: '#/components/schemas/tapi.common.PortDirection'
        capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        media-channel-service-interface-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelServiceInterfacePointSpec'
        otsi-connectivity-service-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec'
    tapi.path.computation.DiversityPolicy:
      title: tapi.path.computation.DiversityPolicy
      enum:
      - SRLG
      - SRNG
      - SNG
      - NODE
      - LINK
      type: string
    tapi.path.computation.PathObjectiveFunction:
      title: tapi.path.computation.PathObjectiveFunction
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        local-id:
          type: string
          description: none
        link-utilization:
          $ref: '#/components/schemas/tapi.common.DirectiveValue'
        bandwidth-optimization:
          $ref: '#/components/schemas/tapi.common.DirectiveValue'
        cost-optimization:
          $ref: '#/components/schemas/tapi.common.DirectiveValue'
        resource-sharing:
          $ref: '#/components/schemas/tapi.common.DirectiveValue'
        concurrent-paths:
          $ref: '#/components/schemas/tapi.common.DirectiveValue'
    tapi.path.computation.PathOptimizationConstraint:
      title: tapi.path.computation.PathOptimizationConstraint
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        local-id:
          type: string
          description: none
        traffic-interruption:
          $ref: '#/components/schemas/tapi.common.DirectiveValue'
    tapi.path.computation.PathRef:
      title: tapi.path.computation.PathRef
      type: object
      properties:
        path-uuid:
          type: string
    tapi.path.computation.RouteObjectiveFunction:
      title: tapi.path.computation.RouteObjectiveFunction
      enum:
      - MIN_WORK_ROUTE_HOP
      - MIN_WORK_ROUTE_COST
      - MIN_WORK_ROUTE_LATENCY
      - MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_HOP
      - MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_COST
      - MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_LATENCY
      - LOAD_BALANCE_MAX_UNUSED_CAPACITY
      type: string
    tapi.path.computation.RoutingConstraint:
      title: tapi.path.computation.RoutingConstraint
      type: object
      properties:
        is-exclusive:
          type: boolean
          description: To distinguish if the resources are to be exclusive to the service
          default: true
        diversity-policy:
          $ref: '#/components/schemas/tapi.path.computation.DiversityPolicy'
        route-objective-function:
          $ref: '#/components/schemas/tapi.path.computation.RouteObjectiveFunction'
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        risk-diversity-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.RiskCharacteristic'
          description: ''
        route-direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
    tapi.path.computation.TopologyConstraint:
      title: tapi.path.computation.TopologyConstraint
      type: object
      properties:
        include-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        exclude-link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LinkRef'
          description: ''
        include-link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LinkRef'
          description: This is a loose constraint - that is it is unordered and could be a partial list
        exclude-node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRef'
          description: ''
    tapi.photonic.media.AdjustmentGranularity:
      title: tapi.photonic.media.AdjustmentGranularity
      enum:
      - G_100GHZ
      - G_50GHZ
      - G_25GHZ
      - G_12_5GHZ
      - G_6_25GHZ
      - G_3_125GHZ
      - UNCONSTRAINED
      type: string
    tapi.photonic.media.ApplicationIdentifier:
      title: tapi.photonic.media.ApplicationIdentifier
      type: object
      properties:
        application-identifier-type:
          $ref: '#/components/schemas/tapi.photonic.media.ApplicationIdentifierType'
        application-code:
          type: string
    tapi.photonic.media.ApplicationIdentifierType:
      title: tapi.photonic.media.ApplicationIdentifierType
      enum:
      - PROPRIETARY
      - ITUT_G959_1
      - ITUT_G698_1
      - ITUT_G698_2
      - ITUT_G696_1
      - ITUT_G695
      type: string
    tapi.photonic.media.CentralFrequency:
      title: tapi.photonic.media.CentralFrequency
      type: object
      properties:
        central-frequency:
          type: integer
          description: The central frequency of the laser specified in MHz. It is the oscillation frequency of the corresponding electromagnetic wave.
          format: int32
        frequency-constraint:
          $ref: '#/components/schemas/tapi.photonic.media.FrequencyConstraint'
    tapi.photonic.media.ConnectionEndPointAugmentation2:
      title: tapi.photonic.media.ConnectionEndPointAugmentation2
      type: object
      properties:
        otsi-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiConnectionEndPointSpec'
    tapi.photonic.media.ConnectionEndPointAugmentation3:
      title: tapi.photonic.media.ConnectionEndPointAugmentation3
      type: object
      properties:
        ots-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsConnectionEndPointSpec'
    tapi.photonic.media.ConnectionEndPointAugmentation4:
      title: tapi.photonic.media.ConnectionEndPointAugmentation4
      type: object
      properties:
        media-channel-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelConnectionEndPointSpec'
    tapi.photonic.media.ConnectionEndPointAugmentation5:
      title: tapi.photonic.media.ConnectionEndPointAugmentation5
      type: object
      properties:
        otsi-assembly-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec'
    tapi.photonic.media.ConnectionEndPointAugmentation6:
      title: tapi.photonic.media.ConnectionEndPointAugmentation6
      type: object
      properties:
        media-channel-assembly-spec:
          type: object
    tapi.photonic.media.EndPointAugmentation1:
      title: tapi.photonic.media.EndPointAugmentation1
      type: object
      properties:
        media-channel-service-interface-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelServiceInterfacePointSpec'
    tapi.photonic.media.EndPointAugmentation2:
      title: tapi.photonic.media.EndPointAugmentation2
      type: object
      properties:
        otsi-connectivity-service-end-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec'
    tapi.photonic.media.FecPropertiesPac:
      title: tapi.photonic.media.FecPropertiesPac
      type: object
      properties:
        uncorrectable-bytes:
          type: integer
          description: Bytes that could not be corrected by FEC
          format: int32
        corrected-bits:
          type: integer
          description: Bits corrected between those that were received corrupted
          format: int32
        pre-fec-ber:
          type: integer
          description: 'counter: bit error rate before correction by FEC'
          format: int32
        uncorrectable-bits:
          type: integer
          description: Bits that could not be corrected by FEC
          format: int32
        corrected-bytes:
          type: integer
          description: Bytes corrected between those that were received corrupted
          format: int32
        post-fec-ber:
          type: integer
          description: 'counter: bit error rate after correction by FEC'
          format: int32
    tapi.photonic.media.FrequencyConstraint:
      title: tapi.photonic.media.FrequencyConstraint
      type: object
      properties:
        adjustment-granularity:
          $ref: '#/components/schemas/tapi.photonic.media.AdjustmentGranularity'
        grid-type:
          $ref: '#/components/schemas/tapi.photonic.media.GridType'
    tapi.photonic.media.GridType:
      title: tapi.photonic.media.GridType
      enum:
      - DWDM
      - CWDM
      - FLEX
      - GRIDLESS
      - UNSPECIFIED
      type: string
    tapi.photonic.media.LaserControlStatusType:
      title: tapi.photonic.media.LaserControlStatusType
      enum:
      - ON
      - OFF
      - PULSING
      - UNDEFINED
      type: string
    tapi.photonic.media.LaserControlType:
      title: tapi.photonic.media.LaserControlType
      enum:
      - FORCED-ON
      - FORCED-OFF
      - AUTOMATIC-LASER-SHUTDOWN
      - UNDEFINED
      type: string
    tapi.photonic.media.LaserPropertiesPac:
      title: tapi.photonic.media.LaserPropertiesPac
      type: object
      properties:
        laser-application-type:
          $ref: '#/components/schemas/tapi.photonic.media.LaserType'
        laser-bias-current:
          type: string
          description: The Bias current of the laser that is the medium polarization current of the laser.
        laser-temperature:
          type: string
          description: The temperature of the laser
        laser-status:
          $ref: '#/components/schemas/tapi.photonic.media.LaserControlStatusType'
    tapi.photonic.media.LaserType:
      title: tapi.photonic.media.LaserType
      enum:
      - PUMP
      - MODULATED
      - PULSE
      type: string
    tapi.photonic.media.MediaChannelConnectionEndPointSpec:
      title: tapi.photonic.media.MediaChannelConnectionEndPointSpec
      type: object
      properties:
        media-channel:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelPropertiesPac'
    tapi.photonic.media.MediaChannelNodeEdgePointSpec:
      title: tapi.photonic.media.MediaChannelNodeEdgePointSpec
      type: object
      properties:
        mc-pool:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelPoolCapabilityPac'
    tapi.photonic.media.MediaChannelPoolCapabilityPac:
      title: tapi.photonic.media.MediaChannelPoolCapabilityPac
      type: object
      properties:
        available-spectrum:
          type: array
          items:
            $ref: '#/components/schemas/tapi.photonic.media.SpectrumBand'
          description: ''
        supportable-spectrum:
          type: array
          items:
            $ref: '#/components/schemas/tapi.photonic.media.SpectrumBand'
          description: ''
        occupied-spectrum:
          type: array
          items:
            $ref: '#/components/schemas/tapi.photonic.media.SpectrumBand'
          description: ''
    tapi.photonic.media.MediaChannelPropertiesPac:
      title: tapi.photonic.media.MediaChannelPropertiesPac
      type: object
      properties:
        occupied-spectrum:
          $ref: '#/components/schemas/tapi.photonic.media.SpectrumBand'
        measured-power-egress:
          $ref: '#/components/schemas/tapi.photonic.media.PowerPropertiesPac'
        measured-power-ingress:
          $ref: '#/components/schemas/tapi.photonic.media.PowerPropertiesPac'
    tapi.photonic.media.MediaChannelServiceInterfacePointSpec:
      title: tapi.photonic.media.MediaChannelServiceInterfacePointSpec
      type: object
      properties:
        mc-pool:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelPoolCapabilityPac'
    tapi.photonic.media.ModulationTechnique:
      title: tapi.photonic.media.ModulationTechnique
      enum:
      - RZ
      - NRZ
      - BPSK
      - DPSK
      - QPSK
      - 8QAM
      - 16QAM
      - PAM4
      - PAM8
      - UNDEFINED
      type: string
    tapi.photonic.media.OtsConnectionEndPointSpec:
      title: tapi.photonic.media.OtsConnectionEndPointSpec
      type: object
      properties:
        ots-media-channel:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelPropertiesPac'
    tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec:
      title: tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec
      type: object
      properties:
        otsi-adapter:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiGserverAdaptationPac'
        fec-parameters:
          $ref: '#/components/schemas/tapi.photonic.media.FecPropertiesPac'
    tapi.photonic.media.OtsiCapabilityPac:
      title: tapi.photonic.media.OtsiCapabilityPac
      type: object
      properties:
        supportable-lower-central-frequency:
          type: array
          items:
            $ref: '#/components/schemas/tapi.photonic.media.CentralFrequency'
          description: The lower frequency of the channel spectrum
        supportable-application-identifier:
          type: array
          items:
            $ref: '#/components/schemas/tapi.photonic.media.ApplicationIdentifier'
          description: The list of supportable ApplicationIdentifiers.
        supportable-modulation:
          type: array
          items:
            $ref: '#/components/schemas/tapi.photonic.media.ModulationTechnique'
          description: This parameter defines the modulation used at the source
        total-power-warn-threshold:
          $ref: '#/components/schemas/tapi.photonic.media.TotalPowerThresholdPac'
        supportable-upper-central-frequency:
          type: array
          items:
            $ref: '#/components/schemas/tapi.photonic.media.CentralFrequency'
          description: The Upper frequency of the channel spectrum
    tapi.photonic.media.OtsiConnectionEndPointSpec:
      title: tapi.photonic.media.OtsiConnectionEndPointSpec
      type: object
      properties:
        otsi-termination:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiTerminationPac'
    tapi.photonic.media.OtsiConnectivityServiceEndPointSpec:
      title: tapi.photonic.media.OtsiConnectivityServiceEndPointSpec
      type: object
      properties:
        otsi-config:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiTerminationConfigPac'
    tapi.photonic.media.OtsiGserverAdaptationPac:
      title: tapi.photonic.media.OtsiGserverAdaptationPac
      type: object
      properties:
        number-of-otsi:
          type: integer
          format: int32
    tapi.photonic.media.OtsiServiceInterfacePointSpec:
      title: tapi.photonic.media.OtsiServiceInterfacePointSpec
      type: object
      properties:
        otsi-capability:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiCapabilityPac'
    tapi.photonic.media.OtsiTerminationConfigPac:
      title: tapi.photonic.media.OtsiTerminationConfigPac
      type: object
      properties:
        application-identifier:
          $ref: '#/components/schemas/tapi.photonic.media.ApplicationIdentifier'
        central-frequency:
          $ref: '#/components/schemas/tapi.photonic.media.CentralFrequency'
        modulation:
          $ref: '#/components/schemas/tapi.photonic.media.ModulationTechnique'
        spectrum:
          $ref: '#/components/schemas/tapi.photonic.media.SpectrumBand'
        laser-control:
          $ref: '#/components/schemas/tapi.photonic.media.LaserControlType'
        total-power-warn-threshold-lower:
          type: string
          description: Allows to configure the Lowerpower threshold which is expected to be different from Default, but within the Min and Max values specified as OTSi SIP capability.
        total-power-warn-threshold-upper:
          type: string
          description: Allows to configure the Upper power threshold which is expected to be different from Default, but within the Min and Max values specified as OTSi SIP capability.
        transmit-power:
          $ref: '#/components/schemas/tapi.photonic.media.PowerPropertiesPac'
    tapi.photonic.media.OtsiTerminationPac:
      title: tapi.photonic.media.OtsiTerminationPac
      type: object
      properties:
        selected-application-identifier:
          $ref: '#/components/schemas/tapi.photonic.media.ApplicationIdentifier'
        received-power:
          $ref: '#/components/schemas/tapi.photonic.media.PowerPropertiesPac'
        selected-central-frequency:
          $ref: '#/components/schemas/tapi.photonic.media.CentralFrequency'
        transmited-power:
          $ref: '#/components/schemas/tapi.photonic.media.PowerPropertiesPac'
        selected-modulation:
          $ref: '#/components/schemas/tapi.photonic.media.SelectedModulation'
        laser-properties:
          $ref: '#/components/schemas/tapi.photonic.media.LaserPropertiesPac'
        selected-spectrum:
          $ref: '#/components/schemas/tapi.photonic.media.SpectrumBand'
    tapi.photonic.media.OwnedNodeEdgePointAugmentation1:
      title: tapi.photonic.media.OwnedNodeEdgePointAugmentation1
      type: object
      properties:
        media-channel-node-edge-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelNodeEdgePointSpec'
    tapi.photonic.media.PowerPropertiesPac:
      title: tapi.photonic.media.PowerPropertiesPac
      type: object
      properties:
        power-spectral-density:
          type: string
          description: This describes how power of a signal  is distributed over frequency specified in nW/MHz
        total-power:
          type: string
          description: The total power at any point in a channel specified in dBm.
    tapi.photonic.media.SelectedModulation:
      title: tapi.photonic.media.SelectedModulation
      enum:
      - RZ
      - NRZ
      - BPSK
      - DPSK
      - QPSK
      - 8QAM
      - 16QAM
      - PAM4
      - PAM8
      - UNDEFINED
      type: string
    tapi.photonic.media.ServiceInterfacePointAugmentation1:
      title: tapi.photonic.media.ServiceInterfacePointAugmentation1
      type: object
      properties:
        media-channel-service-interface-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelServiceInterfacePointSpec'
    tapi.photonic.media.ServiceInterfacePointAugmentation2:
      title: tapi.photonic.media.ServiceInterfacePointAugmentation2
      type: object
      properties:
        otsi-service-interface-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.OtsiServiceInterfacePointSpec'
    tapi.photonic.media.SpectrumBand:
      title: tapi.photonic.media.SpectrumBand
      type: object
      properties:
        lower-frequency:
          type: integer
          description: The lower frequency bound of the media channel spectrum specified in MHz
          format: int32
        upper-frequency:
          type: integer
          description: The upper frequency bound of the media channel spectrum specified in MHz
          format: int32
        frequency-constraint:
          $ref: '#/components/schemas/tapi.photonic.media.FrequencyConstraint'
    tapi.photonic.media.TotalPowerThresholdPac:
      title: tapi.photonic.media.TotalPowerThresholdPac
      type: object
      properties:
        total-power-upper-warn-threshold-default:
          type: string
          description: Can read the value of the default  threshold that was set
        total-power-lower-warn-threshold-min:
          type: string
          description: Can read the value of the lower threshold that was set
        total-power-upper-warn-threshold-min:
          type: string
          description: Can read the value of the lower threshold that was set
        total-power-upper-warn-threshold-max:
          type: string
          description: Can  read the value of the upper threshold that was set
        total-power-lower-warn-threshold-max:
          type: string
          description: Can  read the value of the upper threshold that was set
        total-power-lower-warn-threshold-default:
          type: string
          description: Can read the value of the default  threshold that was set
    tapi.topology.ContextAugmentation5:
      title: tapi.topology.ContextAugmentation5
      type: object
      properties:
        topology-context:
          $ref: '#/components/schemas/tapi.topology.TopologyContext'
    tapi.topology.CostCharacteristic:
      title: tapi.topology.CostCharacteristic
      type: object
      properties:
        cost-value:
          type: string
          description: The specific cost.
        cost-algorithm:
          type: string
          description: The cost may vary based upon some properties of the TopologicalEntity. The rules for the variation are conveyed by the costAlgorithm.
        cost-name:
          type: string
          description: The cost characteristic will related to some aspect of the TopologicalEntity (e.g. $ cost, routing weight). This aspect will be conveyed by the costName.
    tapi.topology.ForwardingRule:
      title: tapi.topology.ForwardingRule
      enum:
      - MAY_FORWARD_ACROSS_GROUP
      - MUST_FORWARD_ACROSS_GROUP
      - CANNOT_FORWARD_ACROSS_GROUP
      - NO_STATEMENT_ON_FORWARDING
      type: string
    tapi.topology.InterRuleGroup:
      title: tapi.topology.InterRuleGroup
      type: object
      properties:
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        risk-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.RiskCharacteristic'
          description: A list of risk characteristics for consideration in an analysis of shared risk. Each element of the list represents a specific risk consideration.
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        associated-node-rule-group:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef'
          description: none
        rule:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.Rule'
          description: none
    tapi.topology.LatencyCharacteristic:
      title: tapi.topology.LatencyCharacteristic
      type: object
      properties:
        traffic-property-name:
          type: string
          description: The identifier of the specific traffic property to which the queuing latency applies.
        jitter-characteristic:
          type: string
          description: >-
            High frequency deviation from true periodicity of a signal and therefore a small high rate of change of transfer latency.

                                Applies to TDM systems (and not packet).
        fixed-latency-characteristic:
          type: string
          description: A TopologicalEntity suffers delay caused by the realization of the servers (e.g. distance related; FEC encoding etc.) along with some client specific processing. This is the total average latency effect of the TopologicalEntity
        wander-characteristic:
          type: string
          description: >-
            Low frequency deviation from true periodicity of a signal and therefore a small low rate of change of transfer latency.

                                Applies to TDM systems (and not packet).
        queing-latency-characteristic:
          type: string
          description: The specific queuing latency for the traffic property.
    tapi.topology.LayerProtocolTransitionPac:
      title: tapi.topology.LayerProtocolTransitionPac
      type: object
      properties:
        transitioned-layer-protocol-name:
          type: array
          items:
            type: string
          description: Provides the ordered structure of layer protocol transitions encapsulated in the TopologicalEntity. The ordering relates to the LinkPort role.
    tapi.topology.Link:
      title: tapi.topology.Link
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        transitioned-layer-protocol-name:
          type: array
          items:
            type: string
          description: Provides the ordered structure of layer protocol transitions encapsulated in the TopologicalEntity. The ordering relates to the LinkPort role.
        risk-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.RiskCharacteristic'
          description: A list of risk characteristics for consideration in an analysis of shared risk. Each element of the list represents a specific risk consideration.
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        error-characteristic:
          type: string
          description: "Describes the degree to which the signal propagated can be errored. \r\n                    Applies to TDM systems as the errored signal will be propagated and not packet as errored packets will be discarded."
        unavailable-time-characteristic:
          type: string
          description: Describes the duration for which there may be no valid signal propagated.
        server-integrity-process-characteristic:
          type: string
          description: Describes the effect of any server integrity enhancement process on the characteristics of the TopologicalEntity.
        delivery-order-characteristic:
          type: string
          description: >-
            Describes the degree to which packets will be delivered out of sequence.

                                Does not apply to TDM as the TDM protocols maintain strict order.
        repeat-delivery-characteristic:
          type: string
          description: "Primarily applies to packet systems where a packet may be delivered more than once (in fault recovery for example). \r\n                    It can also apply to TDM where several frames may be received twice due to switching in a system with a large differential propagation delay."
        loss-characteristic:
          type: string
          description: >-
            Describes the acceptable characteristic of lost packets where loss may result from discard due to errors or overflow.

                                Applies to packet systems and not TDM (as for TDM errored signals are propagated unless grossly errored and overflow/underflow turns into timing slips).
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        validation-mechanism:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.ValidationMechanism'
          description: Provides details of the specific validation mechanism(s) used to confirm the presence of an intended topologicalEntity.
        layer-protocol-name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.LayerProtocolName'
          description: none
        resilience-type:
          $ref: '#/components/schemas/tapi.topology.ResilienceType'
        node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
        direction:
          $ref: '#/components/schemas/tapi.common.ForwardingDirection'
    tapi.topology.LinkRef:
      title: tapi.topology.LinkRef
      type: object
      properties:
        topology-uuid:
          type: string
          description: none
        link-uuid:
          type: string
          description: none
    tapi.topology.NetworkTopologyService:
      title: tapi.topology.NetworkTopologyService
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        topology:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.TopologyRef'
          description: none
    tapi.topology.Node:
      title: tapi.topology.Node
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        error-characteristic:
          type: string
          description: "Describes the degree to which the signal propagated can be errored. \r\n                    Applies to TDM systems as the errored signal will be propagated and not packet as errored packets will be discarded."
        unavailable-time-characteristic:
          type: string
          description: Describes the duration for which there may be no valid signal propagated.
        server-integrity-process-characteristic:
          type: string
          description: Describes the effect of any server integrity enhancement process on the characteristics of the TopologicalEntity.
        delivery-order-characteristic:
          type: string
          description: >-
            Describes the degree to which packets will be delivered out of sequence.

                                Does not apply to TDM as the TDM protocols maintain strict order.
        repeat-delivery-characteristic:
          type: string
          description: "Primarily applies to packet systems where a packet may be delivered more than once (in fault recovery for example). \r\n                    It can also apply to TDM where several frames may be received twice due to switching in a system with a large differential propagation delay."
        loss-characteristic:
          type: string
          description: >-
            Describes the acceptable characteristic of lost packets where loss may result from discard due to errors or overflow.

                                Applies to packet systems and not TDM (as for TDM errored signals are propagated unless grossly errored and overflow/underflow turns into timing slips).
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        layer-protocol-name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.LayerProtocolName'
          description: none
        encap-topology:
          $ref: '#/components/schemas/tapi.topology.TopologyRef'
        owned-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePoint'
          description: none
        node-rule-group:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRuleGroup'
          description: none
        aggregated-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
    tapi.topology.NodeEdgePoint:
      title: tapi.topology.NodeEdgePoint
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        termination-direction:
          $ref: '#/components/schemas/tapi.common.TerminationDirection'
        termination-state:
          $ref: '#/components/schemas/tapi.common.TerminationState'
        lldpSnoop:
          $ref: '#/components/schemas/tapi.ciena.LLDPExtensions'
        adjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage1'
        link-port-role:
          $ref: '#/components/schemas/tapi.common.PortRole'
        mapped-service-interface-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.ServiceInterfacePointRef'
          description: NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing) or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience) should be considered experimental
        aggregated-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        link-port-direction:
          $ref: '#/components/schemas/tapi.common.PortDirection'
        supported-cep-layer-protocol-qualifier:
          type: array
          items:
            type: string
          description: none
    tapi.topology.NodeEdgePointRef:
      title: tapi.topology.NodeEdgePointRef
      type: object
      properties:
        topology-uuid:
          type: string
          description: none
        node-uuid:
          type: string
          description: none
        node-edge-point-uuid:
          type: string
          description: none
    tapi.topology.NodeRef:
      title: tapi.topology.NodeRef
      type: object
      properties:
        topology-uuid:
          type: string
          description: none
        node-uuid:
          type: string
          description: none
    tapi.topology.NodeRuleGroup:
      title: tapi.topology.NodeRuleGroup
      type: object
      properties:
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        risk-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.RiskCharacteristic'
          description: A list of risk characteristics for consideration in an analysis of shared risk. Each element of the list represents a specific risk consideration.
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        inter-rule-group:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.InterRuleGroup'
          description: none
        rule:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.Rule'
          description: none
        composed-rule-group:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef'
          description: none
        node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
    tapi.topology.NodeRuleGroupRef:
      title: tapi.topology.NodeRuleGroupRef
      type: object
      properties:
        topology-uuid:
          type: string
          description: none
        node-uuid:
          type: string
          description: none
        node-rule-group-uuid:
          type: string
          description: none
    tapi.topology.ProtectionType:
      title: tapi.topology.ProtectionType
      enum:
      - NO_PROTECTON
      - ONE_PLUS_ONE_PROTECTION
      - ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION
      - DYNAMIC_RESTORATION
      type: string
    tapi.topology.ResilienceType:
      title: tapi.topology.ResilienceType
      type: object
      properties:
        restoration-policy:
          $ref: '#/components/schemas/tapi.topology.RestorationPolicy'
        protection-type:
          $ref: '#/components/schemas/tapi.topology.ProtectionType'
    tapi.topology.RestorationPolicy:
      title: tapi.topology.RestorationPolicy
      enum:
      - END_TO_END_RESTORATION
      - NA
      type: string
    tapi.topology.RiskCharacteristic:
      title: tapi.topology.RiskCharacteristic
      type: object
      properties:
        risk-characteristic-name:
          type: string
          description: "The name of the risk characteristic. The characteristic may be related to a specific degree of closeness. \r\n                    For example a particular characteristic may apply to failures that are localized (e.g. to one side of a road) where as another characteristic may relate to failures that have a broader impact (e.g. both sides of a road that crosses a bridge).\r\n                    Depending upon the importance of the traffic being routed different risk characteristics will be evaluated."
        risk-identifier-list:
          type: array
          items:
            type: string
          description: A list of the identifiers of each physical/geographic unit (with the specific risk characteristic) that is related to a segment of the TopologicalEntity.
    tapi.topology.RiskParameterPac:
      title: tapi.topology.RiskParameterPac
      type: object
      properties:
        risk-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.RiskCharacteristic'
          description: A list of risk characteristics for consideration in an analysis of shared risk. Each element of the list represents a specific risk consideration.
    tapi.topology.Rule:
      title: tapi.topology.Rule
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        local-id:
          type: string
          description: none
        override-priority:
          type: integer
          description: none
          format: int32
        forwarding-rule:
          $ref: '#/components/schemas/tapi.topology.ForwardingRule'
        rule-type:
          $ref: '#/components/schemas/tapi.topology.RuleType'
    tapi.topology.RuleType:
      title: tapi.topology.RuleType
      enum:
      - FORWARDING
      - CAPACITY
      - COST
      - TIMING
      - RISK
      - GROUPING
      type: string
    tapi.topology.Topology:
      title: tapi.topology.Topology
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        layer-protocol-name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.LayerProtocolName'
          description: none
        link:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.Link'
          description: none
        node:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.Node'
          description: none
    tapi.topology.topologycontext.TopologyWrapper:
      title: tapi.topology.topologycontext.TopologyWrapper
      type: object
      properties:
        topology:
          $ref: '#/components/schemas/tapi.topology.Topology'
    tapi.topology.TopologyInfo:
      title: tapi.topology.TopologyInfo
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/Meta3'
        data:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.Topology'
          description: ''
        links:
          $ref: '#/components/schemas/Links14'
    tapi.topology.TopologyContext:
      title: tapi.topology.TopologyContext
      type: object
      properties:
        nw-topology-service:
          $ref: '#/components/schemas/tapi.topology.NetworkTopologyService'
        topology:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.Topology'
          description: none
    tapi.topology.TopologyRef:
      title: tapi.topology.TopologyRef
      type: object
      properties:
        topology-uuid:
          type: string
          description: none
    tapi.topology.TransferCostPac:
      title: tapi.topology.TransferCostPac
      type: object
      properties:
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
    tapi.topology.TransferIntegrityPac:
      title: tapi.topology.TransferIntegrityPac
      type: object
      properties:
        error-characteristic:
          type: string
          description: "Describes the degree to which the signal propagated can be errored. \r\n                    Applies to TDM systems as the errored signal will be propagated and not packet as errored packets will be discarded."
        unavailable-time-characteristic:
          type: string
          description: Describes the duration for which there may be no valid signal propagated.
        server-integrity-process-characteristic:
          type: string
          description: Describes the effect of any server integrity enhancement process on the characteristics of the TopologicalEntity.
        delivery-order-characteristic:
          type: string
          description: >-
            Describes the degree to which packets will be delivered out of sequence.

                                Does not apply to TDM as the TDM protocols maintain strict order.
        repeat-delivery-characteristic:
          type: string
          description: "Primarily applies to packet systems where a packet may be delivered more than once (in fault recovery for example). \r\n                    It can also apply to TDM where several frames may be received twice due to switching in a system with a large differential propagation delay."
        loss-characteristic:
          type: string
          description: >-
            Describes the acceptable characteristic of lost packets where loss may result from discard due to errors or overflow.

                                Applies to packet systems and not TDM (as for TDM errored signals are propagated unless grossly errored and overflow/underflow turns into timing slips).
    tapi.topology.TransferTimingPac:
      title: tapi.topology.TransferTimingPac
      type: object
      properties:
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
    tapi.topology.ValidationMechanism:
      title: tapi.topology.ValidationMechanism
      type: object
      properties:
        layer-protocol-adjacency-validated:
          type: string
          description: State of validatiion
        validation-mechanism:
          type: string
          description: Name of mechanism used to validate adjacency
        validation-robustness:
          type: string
          description: Quality of validation (i.e. how likely is the stated validation to be invalid)
    tapi.topology.ValidationPac:
      title: tapi.topology.ValidationPac
      type: object
      properties:
        validation-mechanism:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.ValidationMechanism'
          description: Provides details of the specific validation mechanism(s) used to confirm the presence of an intended topologicalEntity.
    tapi.topology.node.OwnedNodeEdgePoint:
      title: tapi.topology.node.OwnedNodeEdgePoint
      type: object
      properties:
        cep-list:
          $ref: '#/components/schemas/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList'
        media-channel-node-edge-point-spec:
          $ref: '#/components/schemas/tapi.photonic.media.MediaChannelNodeEdgePointSpec'
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        termination-direction:
          $ref: '#/components/schemas/tapi.common.TerminationDirection'
        termination-state:
          $ref: '#/components/schemas/tapi.common.TerminationState'
        lldpSnoop:
          $ref: '#/components/schemas/tapi.ciena.LLDPExtensions'
        adjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage1'
        link-port-role:
          $ref: '#/components/schemas/tapi.common.PortRole'
        mapped-service-interface-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.ServiceInterfacePointRef'
          description: NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing) or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience) should be considered experimental
        aggregated-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
        layer-protocol-name:
          $ref: '#/components/schemas/tapi.common.LayerProtocolName'
        link-port-direction:
          $ref: '#/components/schemas/tapi.common.PortDirection'
        supported-cep-layer-protocol-qualifier:
          type: array
          items:
            type: string
          description: none
    tapi.topology.topology.Node:
      title: tapi.topology.topology.Node
      type: object
      properties:
        operational-state:
          $ref: '#/components/schemas/tapi.common.OperationalState'
        lifecycle-state:
          $ref: '#/components/schemas/tapi.common.LifecycleState'
        administrative-state:
          $ref: '#/components/schemas/tapi.common.AdministrativeState'
        available-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        total-potential-capacity:
          $ref: '#/components/schemas/tapi.common.Capacity'
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        cost-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
        error-characteristic:
          type: string
          description: "Describes the degree to which the signal propagated can be errored. \r\n                    Applies to TDM systems as the errored signal will be propagated and not packet as errored packets will be discarded."
        unavailable-time-characteristic:
          type: string
          description: Describes the duration for which there may be no valid signal propagated.
        server-integrity-process-characteristic:
          type: string
          description: Describes the effect of any server integrity enhancement process on the characteristics of the TopologicalEntity.
        delivery-order-characteristic:
          type: string
          description: >-
            Describes the degree to which packets will be delivered out of sequence.

                                Does not apply to TDM as the TDM protocols maintain strict order.
        repeat-delivery-characteristic:
          type: string
          description: "Primarily applies to packet systems where a packet may be delivered more than once (in fault recovery for example). \r\n                    It can also apply to TDM where several frames may be received twice due to switching in a system with a large differential propagation delay."
        loss-characteristic:
          type: string
          description: >-
            Describes the acceptable characteristic of lost packets where loss may result from discard due to errors or overflow.

                                Applies to packet systems and not TDM (as for TDM errored signals are propagated unless grossly errored and overflow/underflow turns into timing slips).
        latency-characteristic:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
          description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
        layer-protocol-name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.LayerProtocolName'
          description: none
        encap-topology:
          $ref: '#/components/schemas/tapi.topology.TopologyRef'
        owned-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.node.OwnedNodeEdgePoint'
          description: none
        node-rule-group:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeRuleGroup'
          description: none
        aggregated-node-edge-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.topology.NodeEdgePointRef'
          description: none
    tapi.equipment.ActualEquipment:
      title: tapi.equipment.ActualEquipment
      type: object
      properties:
        common-actual-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonActualProperties'
        actual-non-field-replaceable-module:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.ActualNonFieldReplaceableModule'
          description: none
        common-equipment-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonEquipmentProperties'
    tapi.equipment.ActualHolder:
      title: tapi.equipment.ActualHolder
      type: object
      properties:
        common-holder-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonHolderProperties'
    tapi.equipment.ActualNonFieldReplaceableModule:
      title: tapi.equipment.ActualNonFieldReplaceableModule
      type: object
      properties:
        common-actual-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonActualProperties'
        common-equipment-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonEquipmentProperties'
    tapi.equipment.CommonActualProperties:
      title: tapi.equipment.CommonActualProperties
      type: object
      properties:
        temperature:
          type: string
          description: The measured temperature of the Equipment.
        manufacture-date:
          type: string
          description: This attribute represents the date on which this instance is manufactured.
        is-powered:
          type: boolean
          description: "The state of the power being supplied to the equipment.\r\n                Note that this attribute summarizes the power state. \r\n                Full details on the actual power system would be provided from a number of PC instances representing the relevant parts of the Power function (e.g. different voltage supplies)."
          default: false
        serial-number:
          type: string
          description: This attribute represents the serial number of this instance.
        asset-instance-identifier:
          type: string
          description: This attribute represents the asset identifier of this instance from the manufacturer's perspective.
    tapi.equipment.CommonEquipmentProperties:
      title: tapi.equipment.CommonEquipmentProperties
      type: object
      properties:
        equipment-type-version:
          type: string
          description: This attribute identifies the version of the equipment.
        manufacturer-name:
          type: string
          description: The formal name of the manufacturer of the Equipment.
        equipment-type-description:
          type: string
          description: Text describing the type of Equipment.
        manufacturer-identifier:
          type: string
          description: The formal unique identifier of the manufacturer.
        equipment-type-name:
          type: string
          description: This attribute identifies the type of the equipment.
        equipment-type-identifier:
          type: string
          description: This attribute identifies the part type of the equipment.
        asset-type-identifier:
          type: string
          description: Represents the invariant properties of the equipment asset allocated by the operator that define and characterize the type.
    tapi.equipment.CommonHolderProperties:
      title: tapi.equipment.CommonHolderProperties
      type: object
      properties:
        holder-location:
          type: string
          description: The relative position of the holder in the context of its containing equipment along with the position of that containing Equipment (and further recursion).
        is-guided:
          type: boolean
          description: This attribute indicates whether the holder has guides that constrain the position of the equipment in the holder or not.
          default: false
        holder-category:
          type: string
          description: The type of holder.
    tapi.equipment.ConnectorPinAddress:
      title: tapi.equipment.ConnectorPinAddress
      type: object
      properties:
        connector-identification:
          type: string
          description: Identification of the Connector in the conetxt of the referenced Equipment.
        equipment-uuid:
          type: string
          description: Reference to the Equipment that is fitted with the Connector/Pin.
        pin-identification:
          type: string
          description: >-
            Where relevant, identification of the Pin in the contect of the connector.

                            Where the whole connector is used, then individual Pins need not be identified.
    tapi.equipment.ContextAugmentation2:
      title: tapi.equipment.ContextAugmentation2
      type: object
      properties:
        physical-context:
          $ref: '#/components/schemas/tapi.equipment.PhysicalContext'
    tapi.equipment.Device:
      title: tapi.equipment.Device
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.Equipment'
          description: none
    tapi.equipment.PhysicalSpan:
      title: tapi.equipment.PhysicalSpan
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        equipment:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.TapiEquipmentAccessPortRef'
          description: A logical grouping of TapiEquipmentAccessPortRef that contain the device uuid and the access port uuid.
    tapi.equipment.TapiEquipmentAccessPortRef:
      title: tapi.equipment.TapiEquipmentAccessPortRef
      type: object
      properties:
        device-uuid:
          type: string
          description: The uuid of the device.
        access-port-uuid:
          type: string
          description: The access port id.
    tapi.equipment.DeviceRef:
      title: tapi.equipment.DeviceRef
      type: object
      properties:
        device-uuid:
          type: string
          description: none
    tapi.equipment.Equipment:
      title: tapi.equipment.Equipment
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        contained-holder:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.Holder'
          description: >-
            References the Holder in an Equipment that is available to take other Equipments.

                            For example:

                            - Slot in a sub-rack

                            - Slot in a Field Replaceable Unit that can take a small form-factor pluggable.
        actual-equipment:
          $ref: '#/components/schemas/tapi.equipment.ActualEquipment'
        is-expected-actual-mismatch:
          type: boolean
          description: none
          default: false
        geographical-location:
          type: string
          description: none
        expected-equipment:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.ExpectedEquipment'
          description: none
        equipment-location:
          type: string
          description: none
        category:
          type: string
          description: This attribute provides the identifier for the form of equipments regarded as having particular shared characteristics.
    tapi.equipment.EquipmentRef:
      title: tapi.equipment.EquipmentRef
      type: object
      properties:
        device-uuid:
          type: string
          description: none
        equipment-uuid:
          type: string
          description: none
    tapi.equipment.ExpectedEquipment:
      title: tapi.equipment.ExpectedEquipment
      type: object
      properties:
        expected-holder:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.ExpectedHolder'
          description: none
        expected-non-field-replaceable-module:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.ExpectedNonFieldReplaceableModule'
          description: none
        common-equipment-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonEquipmentProperties'
    tapi.equipment.ExpectedHolder:
      title: tapi.equipment.ExpectedHolder
      type: object
      properties:
        common-holder-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonHolderProperties'
    tapi.equipment.ExpectedNonFieldReplaceableModule:
      title: tapi.equipment.ExpectedNonFieldReplaceableModule
      type: object
      properties:
        common-equipment-properties:
          $ref: '#/components/schemas/tapi.equipment.CommonEquipmentProperties'
    tapi.equipment.Holder:
      title: tapi.equipment.Holder
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        expected-holder:
          $ref: '#/components/schemas/tapi.equipment.ExpectedHolder'
        actual-holder:
          $ref: '#/components/schemas/tapi.equipment.ActualHolder'
        occupying-fru:
          $ref: '#/components/schemas/tapi.equipment.EquipmentRef'
    tapi.equipment.PhysicalContext:
      title: tapi.equipment.PhysicalContext
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        device:
          type: array
          items:
            $ref: '#/components/schemas/tapi.equipment.Device'
          description: none
    tapi.eth.BandwidthReport:
      title: tapi.eth.BandwidthReport
      type: object
      properties:
        port-id:
          type: integer
          description: This attribute returns the far end port identifier.
          format: int32
        source-mac-address:
          type: string
          description: The sourceMacAddress is the address from the far end.
        current-bandwidth:
          type: integer
          description: This attribute returns the current bandwidth.
          format: int32
        nominal-bandwidth:
          type: integer
          description: This attribute returns the configured bandwidth
          format: int32
    tapi.eth.ColourMode:
      title: tapi.eth.ColourMode
      enum:
      - COLOUR_BLIND
      - COLOUR_AWARE
      type: string
    tapi.eth.ConnectionEndPointAugmentation2:
      title: tapi.eth.ConnectionEndPointAugmentation2
      type: object
      properties:
        eth-connection-end-point-spec:
          $ref: '#/components/schemas/tapi.eth.EthConnectionEndPointSpec'
    tapi.eth.ConnectivityServiceAugmentation1:
      title: tapi.eth.ConnectivityServiceAugmentation1
      type: object
      properties:
        eth-connectivity-service:
          type: object
    tapi.eth.ControlFrameFilter:
      title: tapi.eth.ControlFrameFilter
      type: object
      properties:
        c-2-00-00-2-a:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-0-c:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-0-b:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-2-c:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-0-e:
          type: boolean
          description: This attribute identifies the Individual LAN Scope group address, Nearest Bridge group address (LLDP protocol).
          default: false
        c-2-00-00-2-b:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-0-d:
          type: boolean
          description: This attribute identifies the Provider Bridge MVRP address.
          default: false
        c-2-00-00-2-e:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-2-d:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-0-f:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-2-f:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-10:
          type: boolean
          description: This attribute identifies the 'All LANs Bridge Management Group Address'.
          default: false
        c-2-00-00-09:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-29:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-07:
          type: boolean
          description: This attribute identifies the Metro Ethernet Forum E-LMI protocol group address.
          default: false
        c-2-00-00-08:
          type: boolean
          description: This attribute identifies the Provider Bridge Group address.
          default: false
        c-2-00-00-27:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-05:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-28:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-06:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-25:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-03:
          type: boolean
          description: This attribute identifies the Nearest non-TPMR Bridge group address (Port Authentication protocol).
          default: false
        c-2-00-00-26:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-04:
          type: boolean
          description: This attribute identifies the IEEE MAC-specific Control Protocols group address.
          default: false
        c-2-00-00-23:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-01:
          type: boolean
          description: This attribute identifies the IEEE MAC-specific Control Protocols group address (PAUSE protocol).
          default: false
        c-2-00-00-24:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-02:
          type: boolean
          description: This attribute identifies the IEEE 802.3 Slow_Protocols_Multicast address (LACP/LAMP or Link OAM protocols).
          default: false
        c-2-00-00-21:
          type: boolean
          description: This attribute identifies the Customer Bridge MVRP address.
          default: false
        c-2-00-00-22:
          type: boolean
          description: Reserved for future standardization.
          default: false
        c-2-00-00-00:
          type: boolean
          description: This attribute identifies the STP/RSTP/MSTP protocol address.
          default: false
        c-2-00-00-20:
          type: boolean
          description: This attribute identifies the Customer and Provider Bridge MMRP address.
          default: false
        c-2-00-00-0-a:
          type: boolean
          description: Reserved for future standardization.
          default: false
    tapi.eth.CsfConfig:
      title: tapi.eth.CsfConfig
      enum:
      - DISABLED
      - ENABLED
      - ENABLED_WITH_RDI_FDI
      - ENABLED_WITH_RDI_FDI_DCI
      - ENABLED_WITH_DCI
      type: string
    tapi.eth.CurrentDataAugmentation1:
      title: tapi.eth.CurrentDataAugmentation1
      type: object
      properties:
        eth-pro-active-1-lm-source-performance-data:
          type: object
    tapi.eth.CurrentDataAugmentation10:
      title: tapi.eth.CurrentDataAugmentation10
      type: object
      properties:
        eth-on-demand-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandLmPerformanceData'
    tapi.eth.CurrentDataAugmentation11:
      title: tapi.eth.CurrentDataAugmentation11
      type: object
      properties:
        eth-link-trace-result-data:
          $ref: '#/components/schemas/tapi.eth.EthLinkTraceResultData'
    tapi.eth.CurrentDataAugmentation12:
      title: tapi.eth.CurrentDataAugmentation12
      type: object
      properties:
        eth-pro-active-1-dm-source-performance-data:
          type: object
    tapi.eth.CurrentDataAugmentation13:
      title: tapi.eth.CurrentDataAugmentation13
      type: object
      properties:
        eth-test-result-data:
          $ref: '#/components/schemas/tapi.eth.EthTestResultData'
    tapi.eth.CurrentDataAugmentation14:
      title: tapi.eth.CurrentDataAugmentation14
      type: object
      properties:
        eth-pro-active-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActiveDmPerformanceData'
    tapi.eth.CurrentDataAugmentation15:
      title: tapi.eth.CurrentDataAugmentation15
      type: object
      properties:
        eth-pro-active-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActiveLmPerformanceData'
    tapi.eth.CurrentDataAugmentation2:
      title: tapi.eth.CurrentDataAugmentation2
      type: object
      properties:
        eth-on-demand-1-lm-source-performance-data:
          type: object
    tapi.eth.CurrentDataAugmentation3:
      title: tapi.eth.CurrentDataAugmentation3
      type: object
      properties:
        eth-on-demand-1-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemand1LmPerformanceData'
    tapi.eth.CurrentDataAugmentation4:
      title: tapi.eth.CurrentDataAugmentation4
      type: object
      properties:
        eth-on-demand-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandDmPerformanceData'
    tapi.eth.CurrentDataAugmentation5:
      title: tapi.eth.CurrentDataAugmentation5
      type: object
      properties:
        eth-on-demand-1-dm-source-performance-data:
          type: object
    tapi.eth.CurrentDataAugmentation6:
      title: tapi.eth.CurrentDataAugmentation6
      type: object
      properties:
        eth-on-demand-1-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemand1DmPerformanceData'
    tapi.eth.CurrentDataAugmentation7:
      title: tapi.eth.CurrentDataAugmentation7
      type: object
      properties:
        eth-pro-active-1-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActive1LmPerformanceData'
    tapi.eth.CurrentDataAugmentation8:
      title: tapi.eth.CurrentDataAugmentation8
      type: object
      properties:
        eth-pro-active-1-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActive1DmPerformanceData'
    tapi.eth.CurrentDataAugmentation9:
      title: tapi.eth.CurrentDataAugmentation9
      type: object
      properties:
        eth-loopback-result-data:
          $ref: '#/components/schemas/tapi.eth.EthLoopbackResultData'
    tapi.eth.EndPointAugmentation1:
      title: tapi.eth.EndPointAugmentation1
      type: object
      properties:
        eth-connectivity-service-end-point-spec:
          $ref: '#/components/schemas/tapi.eth.EthConnectivityServiceEndPointSpec'
    tapi.eth.EthCfmLinkTracePac:
      title: tapi.eth.EthCfmLinkTracePac
      type: object
      properties:
        period:
          $ref: '#/components/schemas/tapi.eth.OamPeriod'
        target-mep-id:
          type: integer
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            An indication of a destination MEP, the MEPID of a MEP.

                            Alternative to destination MAC address.
          format: int32
        drop-eligibility:
          type: boolean
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            Drop eligible bit value to be used in the VLAN tag, if present in the transmitted frame.
          default: false
        ltm-flags:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            The flags field for the LTMs transmitted by the MEP.
    tapi.eth.EthCfmLinkTraceResultData:
      title: tapi.eth.EthCfmLinkTraceResultData
      type: object
      properties:
        egress-action-field:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            An enumerated value indicating the value returned in the Egress Action field.

                            IEEE P802.1Qcx/D0.3:

                            The value EGRESS-NO-TLV indicates that no Reply Egress TLV was returned in the LTM.
        receive-order:
          type: integer
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            type uint32 range '1..4294967295'

                            An index to distinguish among multiple LTRs with the same LTR Transaction Identifier field value.

                            Assigned sequentially from 1, in the order that the Linktrace Initiator received the LTRs.
          format: int32
        seq-number:
          type: integer
          description: >-
            IEEE P802.1Qcx/D0.3:

                            type uint32 range '0..4294967295'

                            Transaction identifier returned by a previous transmit linktrace message command, indicating which LTMs response is going to be returned.

                            MEF 38:

                            The LTM Transaction Identifier to which the LTR entries will be attached.
          format: int32
        ingress-port-id:
          $ref: '#/components/schemas/tapi.eth.LldpPortIdSubtype'
        organization-specific-tlv:
          type: string
          description: >-
            String length '0 | 4..1500';

                            All Organization specific TLVs returned in the LTR, if any. Includes all octets including and following the TLV Length field of each TLV, concatenated together.
        ingress-action-field:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            The value returned in the Ingress Action Field of the LTM.

                            IEEE P802.1Qcx/D0.3:

                            The value INGRESS-NO-TLV indicates that no Reply Ingress TLV was returned in the LTM.
        chassis-id:
          $ref: '#/components/schemas/tapi.eth.LldpChassisIdSubtype'
        forwarded:
          type: boolean
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            Indicates if a LTM was forwarded by the responding MP, as returned in the FwdYes flag of the flags field.
          default: false
        terminal-mep:
          type: boolean
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            A Boolean value stating whether the forwarded LTM reached a MEP enclosing its MA, as returned in the Terminal MEP flag of the Flags field.
          default: false
        ingress-mac:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            MAC address returned in the ingress MAC address field.

                            IEEE P802.1Qcx/D0.3:

                            If the ingressActionField attribute contains the value INGRESS-NO-TLV, then the contents of this attribute is meaningless.
        egress-port-id:
          $ref: '#/components/schemas/tapi.eth.LldpPortIdSubtype'
        egress-mac:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            MAC address returned in the egress MAC address field.

                            IEEE P802.1Qcx/D0.3:

                            If the egressActionField contains the value EGRESS-NO-TLV, then the contents of this attribute are meaningless.
        next-egress-identifier:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            String length '8'

                            An octet field holding the Next Egress Identifier returned in the LTR Egress Identifier TLV of the LTR.

                            The Next Egress Identifier Identifies the Linktrace Responder that transmitted this LTR, and can forward the LTM to the next hop.

                            This is the same value as the Egress Identifier TLV of the forwarded LTM, if any.

                            If the FwdYes bit of the Flags field is false, the contents of this field are undefined, i.e., any value can be transmitted, and the field is ignored by the receiver.
        last-egress-identifier:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            String length '8'

                            An octet field holding the Last Egress Identifier returned in the LTR Egress Identifier TLV of the LTR.

                            The Last Egress Identifier identifies the MEP Linktrace Initiator that originated, or the Linktrace Responder that forwarded, the LTM to which this LTR is the response.

                            This is the same value as the Egress Identifier TLV of that LTM.
        relay-action-field:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            An enumerated value indicating the value returned in the Relay Action field.
        reply-ttl:
          type: integer
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            TTL field value for a returned LTR.

                            Range '0..255'
          format: int32
    tapi.eth.EthCfmMaintenanceAssociation:
      title: tapi.eth.EthCfmMaintenanceAssociation
      type: object
      properties:
        maintenance-association-name:
          $ref: '#/components/schemas/tapi.eth.MaintenanceAssociationName'
        id-permission:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            This parameter indicates what, if anything, is to be included in the Sender ID TLV transmitted by Maintenance Points configured in this MA.

                            A value of 'defer' means that the contents of the Sender ID TLV are determined by the enclosing Maintenance Domain instance.
    tapi.eth.EthCfmMaintenanceDomain:
      title: tapi.eth.EthCfmMaintenanceDomain
      type: object
      properties:
        maintenance-domain-name:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            A reference to the maintenance domain that this maintenance group is associated with.
        maintenance-domain-name-type:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            The Maintenance Domain name format choice.
    tapi.eth.EthConnectionEndPointSpec:
      title: tapi.eth.EthConnectionEndPointSpec
      type: object
      properties:
        eth-term:
          $ref: '#/components/schemas/tapi.eth.EthTerminationPac'
        ety-term:
          $ref: '#/components/schemas/tapi.eth.EtyTerminationPac'
        eth-ctp:
          $ref: '#/components/schemas/tapi.eth.EthCtpPac'
    tapi.eth.EthConnectivityServiceEndPointSpec:
      title: tapi.eth.EthConnectivityServiceEndPointSpec
      type: object
      properties:
        eth-ctp-common-pac:
          $ref: '#/components/schemas/tapi.eth.EthCtpCommonPac'
        eth-termination-common-pac:
          $ref: '#/components/schemas/tapi.eth.EthTerminationCommonPac'
        ety-termination-common-pac:
          $ref: '#/components/schemas/tapi.eth.EtyTerminationCommonPac'
    tapi.eth.EthCtpCommonPac:
      title: tapi.eth.EthCtpCommonPac
      type: object
      properties:
        vlan-config:
          type: integer
          description: >-
            This attribute models the ETHx/ETH-m_A_So_MI_Vlan_Config information defined in G.8021.

                            range of type : -1, 0, 1..4094
          format: int32
        csf-rdi-fdi-enable:
          type: boolean
          description: This attribute models the MI_CSFrdifdiEnable information defined in G.8021.
          default: false
        filter-config:
          $ref: '#/components/schemas/tapi.eth.ControlFrameFilter'
        traffic-shaping-pac:
          $ref: '#/components/schemas/tapi.eth.TrafficShapingPac'
        mac-length:
          type: integer
          description: >-
            This attribute models the MAC_Lenght MI defined in 8.6/G.8021 for the MAC Length Check process. It indicates the allowed maximum frame length in bytes.

                            range of type : 1518, 1522, 2000
          format: int32
          default: 2000
        csf-report:
          type: boolean
          description: >-
            This attribute models the MI_CSF_Reported information defined in G.8021.

                            range of type : true, false
          default: false
        filter-config-snk:
          type: array
          items:
            type: string
          description: "This attribute models the FilteConfig MI defined in 8.3/G.8021. It indicates the configured filter action for each of the 33 group MAC addresses for control frames. The 33 MAC addresses are:\r\n                01-80-C2-00-00-10, \r\n                01-80-C2-00-00-00 to 01-80-C2-00-00-0F, and \r\n                01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n                The filter action is Pass or Block. \r\n                If the destination address of the incoming ETH_CI_D matches one of the above addresses, the filter process shall perform the corresponding configured filter action. \r\n                If none of the above addresses match, the ETH_CI_D is passed."
        pll-thr:
          type: integer
          description: >-
            This attribute provisions the threshold for the number of active ports. If the number of active ports is more than zero but less than the provisioned threshold, a cPLL (Partial Link Loss) is raised. See section 9.7.1.2 of G.8021.

                            range of type : 0..number of ports
          format: int32
        csf-config:
          $ref: '#/components/schemas/tapi.eth.CsfConfig'
        is-ssf-reported:
          type: boolean
          description: >-
            This attribute provisions whether the SSF defect should be reported as fault cause or not.

                            It models the ETH-LAG_FT_Sk_MI_SSF_Reported defined in G.8021.
          default: false
        collector-max-delay:
          type: integer
          description: >-
            See 802.1AX:

                            The value of this attribute defines the maximum delay, in tens of microseconds, that may be imposed by the Frame Collector between receiving a frame from an Aggregator Parser, and either delivering the frame to its MAC Client or discarding the frame (see IEEE 802.1AX clause 5.2.3.1.1).

                            range of type : 16-bit
          format: int32
        auxiliary-function-position-sequence:
          type: array
          items:
            type: integer
            format: int32
          description: This attribute indicates the positions (i.e., the relative order) of all the MEP, MIP, and TCS objects which are associated with the CTP.
        traffic-conditioning-pac:
          $ref: '#/components/schemas/tapi.eth.TrafficConditioningPac'
    tapi.eth.EthCtpPac:
      title: tapi.eth.EthCtpPac
      type: object
      properties:
        eth-ctp-common-pac:
          $ref: '#/components/schemas/tapi.eth.EthCtpCommonPac'
        partner-system-priority:
          type: integer
          description: >-
            See 802.1AX:

                            Indicates the priority associated with the Partners System ID. If the aggregation is manually configured, this System Priority value will be a value assigned by the local System.

                            range of type : 2-octet
          format: int32
        partner-oper-key:
          type: integer
          description: >-
            See 802.1AX:

                            The current operational value of the Key for the Aggregators current protocol Partner. If the aggregation is manually configured, this Key value will be a value assigned by the local System.

                            range of type : 16-bit
          format: int32
        actor-system-priority:
          type: integer
          description: >-
            See 802.1AX:

                            Indicating the priority associated with the Actors System ID.

                            range of type : 2-octet
          format: int32
        actor-oper-key:
          type: integer
          description: >-
            See 802.1AX:

                            The current operational value of the Key for the Aggregator. The administrative Key value may differ from the operational Key value for the reasons discussed in 5.6.2.

                            The meaning of particular Key values is of local significance.

                            range of type : 16 bit
          format: int32
        data-rate:
          type: integer
          description: >-
            See 802.1AX:

                            The current data rate, in bits per second, of the aggregate link. The value is calculated as N times the data rate of a single link in the aggregation, where N is the number of active links.
          format: int32
        actor-system-id:
          type: string
          description: >-
            See 802.1AX:

                            A MAC address used as a unique identifier for the System that contains this Aggregator.
        partner-system-id:
          type: string
          description: >-
            See 802.1AX:

                            A MAC address consisting of the unique identifier for the current protocol Partner of this Aggregator. A value of zero indicates that there is no known Partner. If the aggregation is manually configured, this System ID value will be a value assigned by the local System.
    tapi.eth.EthLinkTraceJob:
      title: tapi.eth.EthLinkTraceJob
      type: object
      properties:
        time-to-live:
          type: integer
          description: >-
            G.8052: This parameter provides the Time To Live (TTL) parameter of the Link Track protocol.

                            The TTL parameter allows the receiver (MIP or MEP) of the LTM frame to determine if the frame can be terminated. TTL is decremented every time the LTM frame is relayed. LTM frame with TTL<=1 is terminated and not relayed.

                            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            An initial value for the LTM TTL field.
          format: int32
        eth-cfm-link-trace-pac:
          $ref: '#/components/schemas/tapi.eth.EthCfmLinkTracePac'
        destination-address:
          type: string
          description: 'G.8052: This parameter provides the destination address, i.e., the MAC Address of the target MEP or MIP.'
        priority:
          type: integer
          description: >-
            G.8052: This parameter provides the priority to be used in the LBM frame.

                            G.8052: This parameter provides the priority to be used in the TST frame.
          format: int32
          default: 7
    tapi.eth.EthLinkTraceResultData:
      title: tapi.eth.EthLinkTraceResultData
      type: object
      properties:
        result-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.LinkTraceResult'
          description: >-
            G.8052: This parameter returns the results of the LT process. It contains a list of the result received from the individual LTR frames.

                            The result from the individual LTR frame include the Source Mac Address, the TTL, and TLV.
        eth-cfm-link-trace-result-data:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.EthCfmLinkTraceResultData'
          description: none
    tapi.eth.EthLoopbackJob:
      title: tapi.eth.EthLoopbackJob
      type: object
      properties:
        number:
          type: integer
          description: 'G.8052: This parameter specifies how many LB messages to be sent for the LB_Series process.'
          format: int32
        eth-oam-test-loopback-common-pac:
          $ref: '#/components/schemas/tapi.eth.EthOamTestLoopbackCommonPac'
        lbm-data-tlv:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            String length '1..1480'

                            The loopback message Data TLV type.

                            MEF 38:

                            An arbitrary amount of data to be included in a Data TLV.
    tapi.eth.EthLoopbackResultData:
      title: tapi.eth.EthLoopbackResultData
      type: object
      properties:
        ber-lbr-frames:
          type: integer
          description: 'G.8052: This parameter returns the number of LBR frames where there was a bit error in the pattern.'
          format: int32
        crc-lbr-frames:
          type: integer
          description: 'G.8052: This parameter returns the number of LBR frames where the CRC in the pattern failed.'
          format: int32
        detected-peer-mep:
          type: array
          items:
            type: string
          description: 'G.8052: This parameter returns the MAC addresses of the discovered peer MEPs of the subject MEP.'
        sent-lbm-frames:
          type: integer
          description: 'G.8052: This parameter returns the total number of sent LBM frames.'
          format: int32
        out-of-order-lbr-frames:
          type: integer
          description: 'G.8052: This parameter returns the number of LBR traffic unites (messages) that were received out of order (OO).'
          format: int32
        rec-lbr-frames:
          type: integer
          description: 'G.8052: This parameter returns the total number of received LBR messages, including the out of order LBR frames.'
          format: int32
    tapi.eth.EthMeasurementJobControlCommon:
      title: tapi.eth.EthMeasurementJobControlCommon
      type: object
      properties:
        flr-availability-delta-time:
          type: integer
          description: >-
            Time length over which each Availability Frame Loss Ratio value is calculated.

                            MEF 35.1:

                            [R78]/[CR58] [O8] A SOAM PM Implementation MUST support a configurable parameter for the length of time over which each Availability flr value is calculated, with a range of 1s � 300s.  This parameter is equivalent to delta-t as specified by MEF 10.3.

                            [R79]/[CR59] [O8] The length of time over which each Availability flr value is calculated (delta-t) MUST be an integer multiple of the interval between each SLM/1SL frame transmission.

                            [D31]/[CD16] [O8] The default length of time over which each Availability flr value is calculated SHOULD be 1s.
          format: int32
          default: 1
        time-of-the-day-alignment:
          type: boolean
          description: >-
            MEF 35.1:

                            [D7] A SOAM PM Implementation SHOULD allow for no alignment to the time-of-day clock.
          default: true
        test-identifier:
          type: integer
          description: >-
            This attribute is used to distinguish each measurement session if multiple measurement sessions are simultaneously activated towards a peer MEP including concurrent on-demand and proactive tests.

                            It must be unique at least within the context of any measurement type for the MEG and initiating MEP.

                            Note: The attribute is not used in case of 2-way loss measurement.

                            range of type : 0..(2^32) - 1
          format: int32
        repetition-period:
          $ref: '#/components/schemas/tapi.eth.RepetitionPeriod'
        offset-from-time-of-the-day:
          type: integer
          description: >-
            MEF 35.1:

                            [D8] A SOAM PM Implementation SHOULD support a configurable (in minutes) offset from ToD time for alignment of the start of Measurement Intervals other than the first Measurement Interval.
          format: int32
        flr-availability-threshold:
          type: string
          description: >-
            Frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each time interval (as specified by Availability Delta Time).

                            MEF 35.1:

                            [R81]/[CR61] A SOAM PM Implementation MUST support a configurable Availability frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each delta-t interval per MEF 10.3

                            [R82]/[CR62] The Availability frame loss ratio threshold range of 0.00 through 1.00 MUST be supported in increments of 0.01.

                            [D33]/[CD18] [O8] The default Availability frame loss ratio threshold SHOULD be 0.1.
          default: '0.1'
        priority:
          type: integer
          description: >-
            This attribute contains the priority value on which the MEP performs the measurement.

                            When the measurement is enabled, the MEP should use this value to encode the priority of generated measurement frames (OAM PDU frames.).

                            The EMF usese this value to assign the P parameter of the measurement operation.
          format: int32
          default: 7
        flr-availability-samples:
          type: integer
          description: >-
            Number of consecutive Availability Frame Loss Ratio measurements to be used to determine Available/Unavailable state transitions.

                            MEF 35.1:

                            [R80]/[CR60] [O8] The number range of 1 through 10 MUST be supported for the configurable number of consecutive Availability flr measurements to be used to determine Available/Unavailable state transitions.

                            This parameter is equivalent to the Availability parameter of n as specified by MEF 10.3.

                            [D32]/[CD17] [O8] The default number of n for Availability SHOULD be 10.
          format: int32
          default: 10
        message-period:
          type: integer
          description: >-
            This attribute indicates the period (frequency) of the measurement frame transmission.

                            Note that the value 0 means that only one OAM message per measurement interval is generated.

                            Unit is milliseconds.

                            range of type : 100ms, 1s, 10s
          format: int32
          default: 1000
        measurement-interval:
          type: integer
          description: >-
            This attribute contains the discrete non overlapping periods of time (in seconds) during which measurements are performed

                            (i.e., OAM messages are generated) and reports are gathered at the end of the measurement intervals.

                            Note that the value 0 means a degenerated measurement interval with a single OAM message and the report is sent as immediately as possible.
          format: int32
    tapi.eth.EthMegCommon:
      title: tapi.eth.EthMegCommon
      type: object
      properties:
        meg-identifier:
          type: string
          description: Optional in case 802.1Q maintenanceAssociationName is used.
        meg-level:
          type: integer
          description: none
          format: int32
        cc-period:
          $ref: '#/components/schemas/tapi.eth.OamPeriod'
        client-mel:
          type: integer
          description: none
          format: int32
        is-cc-enabled:
          type: boolean
          description: >-
            This attribute models the MI_CC_Enable signal defined in G.8021 and configured as specified in G8051.

                            ITU-T G.8013/Y.1731 (2015)/Amd.1 (11/2018): When ETH-CC transmission is enabled in a MEG,

                            all MEPs are enabled to periodically transmit frames with ETH-CC information to their peer MEPs in the MEG.
          default: false
    tapi.eth.EthMegSpec:
      title: tapi.eth.EthMegSpec
      type: object
      properties:
        eth-cfm-maintenance-association:
          $ref: '#/components/schemas/tapi.eth.EthCfmMaintenanceAssociation'
        eth-meg-common:
          $ref: '#/components/schemas/tapi.eth.EthMegCommon'
        eth-cfm-maintenance-domain:
          $ref: '#/components/schemas/tapi.eth.EthCfmMaintenanceDomain'
    tapi.eth.EthMepCommon:
      title: tapi.eth.EthMepCommon
      type: object
      properties:
        codirectional:
          type: boolean
          description: This attribute specifies the directionality of the Ethernet MEP with respect to the associated CEP. The value of TRUE means that the sink part of the MEP terminates the same signal direction as the sink part of the CEP. The Source part behaves similarly. This attribute is meaningful only when CEP is bidirectional.
          default: true
        lck-priority:
          type: integer
          description: This attribute models the MI_LCK_Pri signal defined in G.8021 and configured as specified in G8051. It is the priority at which the LCK messages should be sent.
          format: int32
          default: 7
        mep-identifier:
          type: integer
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            Integer that is unique among all the MEPs in the same Maintenance Association (MEG).

                            G.8052:

                            This attribute contains the identifier of the MEP.
          format: int32
        lck-period:
          $ref: '#/components/schemas/tapi.eth.OamPeriod'
        cc-priority:
          type: integer
          description: This attribute models the MI_CC_Pri signal defined in G.8021 and configured as specified in G8051. It is the priority at which the CCM message should be sent.
          format: int32
          default: 7
    tapi.eth.EthMepSink:
      title: tapi.eth.EthMepSink
      type: object
      properties:
        peer-mep-identifier:
          type: array
          items:
            type: integer
            format: int32
          description: >-
            G.8052:

                            This attribute models the MI_PeerMEP_ID[i] signal defined in G.8021 and configured as specified in G.8051. It provides the identifiers of the MEPs which are peer to the subject MEP.
        lm-m:
          type: integer
          description: This attribute defines the number of consecutive good seconds necessary for the clearing of 'degraded'. See also section 'Degraded signal defect (dDEG)' in G.8021.
          format: int32
          default: 10
        is-csf-reported:
          type: boolean
          description: This attribute models the MI_CSF_Reported signal defined in G.8021 and configured as specified in G8051. It configures whether the secondary failure CSF should be reported or not.
          default: true
        lm-deg-thr:
          type: integer
          description: This attribute defines the threshold for declaring a 'bad second'. See also section 'Degraded signal defect (dDEG)' in G.8021.
          format: int32
          default: 30
        bandwidth-report:
          $ref: '#/components/schemas/tapi.eth.BandwidthReport'
        lm-degm:
          type: integer
          description: This attribute defines the number of consecutive bad seconds necessary for the 'degraded' detection. See also section 'Degraded signal defect (dDEG)' in G.8021.
          format: int32
          default: 10
        is-csf-rdi-fdi-enabled:
          type: boolean
          description: >-
            This attribute models the MI_CSFrdifdiEnable signal defined in G.8021 and configured as specified in G8051.

                            aSSFrdi ? dCSF-RDI and MI_CSFrdifdiEnable

                            aSSFfdi ? dCSF-FDI and MI_CSFrdifdiEnable
          default: true
        ais-period:
          $ref: '#/components/schemas/tapi.eth.OamPeriod'
        ais-priority:
          type: integer
          description: This attribute models the MI_AIS_Pri signal defined in G.8021 and configured as specified in G8051. It is the priority at which the AIS messages should be sent.
          format: int32
          default: 7
        unexpected-ltr-received:
          type: integer
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            The total number of unexpected LTRs received.
          format: int32
        lm-tf-min:
          type: integer
          description: This attribute defines the necessary number of transmitted frames to enable the detection of 'bad seconds'. See also section 'Degraded signal defect (dDEG)' in G.8021.
          format: int32
    tapi.eth.EthMepSource:
      title: tapi.eth.EthMepSource
      type: object
      properties:
        csf-period:
          $ref: '#/components/schemas/tapi.eth.OamPeriod'
        csf-priority:
          type: integer
          description: This attribute models the MI_CSF_Pri signal defined in G.8021 and configured as specified in G8051. It is the priority at which the CSF messages should be sent
          format: int32
          default: 7
        csf-config:
          $ref: '#/components/schemas/tapi.eth.CsfConfig'
        aps-priority:
          type: integer
          description: >-
            This attribute specifies the priority of the APS messages.

                            See section 8.1.5    APS insert process in G.8021.
          format: int32
          default: 7
    tapi.eth.EthMepSpec:
      title: tapi.eth.EthMepSpec
      type: object
      properties:
        eth-mep-common:
          $ref: '#/components/schemas/tapi.eth.EthMepCommon'
        mep-mac:
          type: string
          description: This attribute contains the MAC Address of the MEP.
        eth-mep-source:
          $ref: '#/components/schemas/tapi.eth.EthMepSource'
        eth-mep-sink:
          $ref: '#/components/schemas/tapi.eth.EthMepSink'
    tapi.eth.EthMipCommon:
      title: tapi.eth.EthMipCommon
      type: object
      properties:
        is-full-mip:
          type: boolean
          description: This attribute indicates whether the MIP is a full MIP (true) or a down-half MIP (false). Up-half MIP is not foreseen by G.8052
          default: false
    tapi.eth.EthMipSpec:
      title: tapi.eth.EthMipSpec
      type: object
      properties:
        eth-mip-common:
          $ref: '#/components/schemas/tapi.eth.EthMipCommon'
        mip-mac:
          type: string
          description: This attribute contains the MAC address of the MIP instance.
    tapi.eth.EthOamMepServicePoint:
      title: tapi.eth.EthOamMepServicePoint
      type: object
      properties:
        eth-mep-common:
          $ref: '#/components/schemas/tapi.eth.EthMepCommon'
        eth-mep-source:
          $ref: '#/components/schemas/tapi.eth.EthMepSource'
        eth-mep-sink:
          $ref: '#/components/schemas/tapi.eth.EthMepSink'
    tapi.eth.EthOamMipServicePoint:
      title: tapi.eth.EthOamMipServicePoint
      type: object
      properties:
        eth-mip-common:
          $ref: '#/components/schemas/tapi.eth.EthMipCommon'
    tapi.eth.EthOamService:
      title: tapi.eth.EthOamService
      type: object
      properties:
        eth-cfm-maintenance-association:
          $ref: '#/components/schemas/tapi.eth.EthCfmMaintenanceAssociation'
        eth-meg-common:
          $ref: '#/components/schemas/tapi.eth.EthMegCommon'
        eth-cfm-maintenance-domain:
          $ref: '#/components/schemas/tapi.eth.EthCfmMaintenanceDomain'
    tapi.eth.EthOamTestLoopbackCommonPac:
      title: tapi.eth.EthOamTestLoopbackCommonPac
      type: object
      properties:
        data-tlv-length:
          type: integer
          description: 'G.8052: This parameter provides the length (in number of octet) of the optional Data TLV to be included in the TST frame.'
          format: int32
        period:
          $ref: '#/components/schemas/tapi.eth.OamPeriod'
        drop-eligibility:
          type: boolean
          description: >-
            G.8052: This parameter provides the eligibility of frames with unicast ETH-TST information to be discarded when congestion conditions are encountered.

                            G.8052: This parameter provides the eligibility of frames with unicast ETH-LB information to be discarded when congestion conditions are encountered.
          default: false
    tapi.eth.EthOnDemand1DmPerformanceData:
      title: tapi.eth.EthOnDemand1DmPerformanceData
      type: object
      properties:
        samples-near-end-1-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.SamplesDmPerformanceParameters'
        statistical-near-end-1-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
    tapi.eth.EthOnDemand1LmPerformanceData:
      title: tapi.eth.EthOnDemand1LmPerformanceData
      type: object
      properties:
        statistical-near-end-1-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalLmPerformanceParameters'
        total-counters-near-end-1-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.TotalCountersLmPerformanceParameters'
    tapi.eth.EthOnDemandDmPerformanceData:
      title: tapi.eth.EthOnDemandDmPerformanceData
      type: object
      properties:
        statistical-bi-dir-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
        samples-far-end-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.SamplesDmPerformanceParameters'
        statistical-far-end-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
        statistical-near-end-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
        samples-near-end-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.SamplesDmPerformanceParameters'
    tapi.eth.EthOnDemandDualEndedMeasurementJob:
      title: tapi.eth.EthOnDemandDualEndedMeasurementJob
      type: object
      properties:
        eth-on-demand-measurement-job-control-sink:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandMeasurementJobControlSink'
        eth-on-demand-measurement-job-control-source:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandMeasurementJobControlSource'
    tapi.eth.EthOnDemandLmPerformanceData:
      title: tapi.eth.EthOnDemandLmPerformanceData
      type: object
      properties:
        bidir-unavailable-intervals:
          type: integer
          description: >-
            A generalized (bidirectional) UAS.

                            MEF 35.1: A 32-bit counter reflecting the number of delta-t intervals evaluated as Unavailable (i.e., for which A<Controller, Responder>(delta-t) = 0).
          format: int32
        statistical-far-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalLmPerformanceParameters'
        statistical-near-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalLmPerformanceParameters'
        total-counters-near-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.TotalCountersLmPerformanceParameters'
        total-counters-far-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.TotalCountersLmPerformanceParameters'
    tapi.eth.EthOnDemandMeasurementJobControlSink:
      title: tapi.eth.EthOnDemandMeasurementJobControlSink
      type: object
      properties:
        flr-availability-delta-time:
          type: integer
          description: >-
            Time length over which each Availability Frame Loss Ratio value is calculated.

                            MEF 35.1:

                            [R78]/[CR58] [O8] A SOAM PM Implementation MUST support a configurable parameter for the length of time over which each Availability flr value is calculated, with a range of 1s � 300s.  This parameter is equivalent to delta-t as specified by MEF 10.3.

                            [R79]/[CR59] [O8] The length of time over which each Availability flr value is calculated (delta-t) MUST be an integer multiple of the interval between each SLM/1SL frame transmission.

                            [D31]/[CD16] [O8] The default length of time over which each Availability flr value is calculated SHOULD be 1s.
          format: int32
          default: 1
        time-of-the-day-alignment:
          type: boolean
          description: >-
            MEF 35.1:

                            [D7] A SOAM PM Implementation SHOULD allow for no alignment to the time-of-day clock.
          default: true
        test-identifier:
          type: integer
          description: >-
            This attribute is used to distinguish each measurement session if multiple measurement sessions are simultaneously activated towards a peer MEP including concurrent on-demand and proactive tests.

                            It must be unique at least within the context of any measurement type for the MEG and initiating MEP.

                            Note: The attribute is not used in case of 2-way loss measurement.

                            range of type : 0..(2^32) - 1
          format: int32
        repetition-period:
          $ref: '#/components/schemas/tapi.eth.RepetitionPeriod'
        offset-from-time-of-the-day:
          type: integer
          description: >-
            MEF 35.1:

                            [D8] A SOAM PM Implementation SHOULD support a configurable (in minutes) offset from ToD time for alignment of the start of Measurement Intervals other than the first Measurement Interval.
          format: int32
        flr-availability-threshold:
          type: string
          description: >-
            Frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each time interval (as specified by Availability Delta Time).

                            MEF 35.1:

                            [R81]/[CR61] A SOAM PM Implementation MUST support a configurable Availability frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each delta-t interval per MEF 10.3

                            [R82]/[CR62] The Availability frame loss ratio threshold range of 0.00 through 1.00 MUST be supported in increments of 0.01.

                            [D33]/[CD18] [O8] The default Availability frame loss ratio threshold SHOULD be 0.1.
          default: '0.1'
        priority:
          type: integer
          description: >-
            This attribute contains the priority value on which the MEP performs the measurement.

                            When the measurement is enabled, the MEP should use this value to encode the priority of generated measurement frames (OAM PDU frames.).

                            The EMF usese this value to assign the P parameter of the measurement operation.
          format: int32
          default: 7
        flr-availability-samples:
          type: integer
          description: >-
            Number of consecutive Availability Frame Loss Ratio measurements to be used to determine Available/Unavailable state transitions.

                            MEF 35.1:

                            [R80]/[CR60] [O8] The number range of 1 through 10 MUST be supported for the configurable number of consecutive Availability flr measurements to be used to determine Available/Unavailable state transitions.

                            This parameter is equivalent to the Availability parameter of n as specified by MEF 10.3.

                            [D32]/[CD17] [O8] The default number of n for Availability SHOULD be 10.
          format: int32
          default: 10
        message-period:
          type: integer
          description: >-
            This attribute indicates the period (frequency) of the measurement frame transmission.

                            Note that the value 0 means that only one OAM message per measurement interval is generated.

                            Unit is milliseconds.

                            range of type : 100ms, 1s, 10s
          format: int32
          default: 1000
        measurement-interval:
          type: integer
          description: >-
            This attribute contains the discrete non overlapping periods of time (in seconds) during which measurements are performed

                            (i.e., OAM messages are generated) and reports are gathered at the end of the measurement intervals.

                            Note that the value 0 means a degenerated measurement interval with a single OAM message and the report is sent as immediately as possible.
          format: int32
        sink-mep-id:
          type: integer
          description: none
          format: int32
        source-address:
          type: string
          description: This attribute contains the MAC address of the peer MEP. See G.8013 for details.
    tapi.eth.EthOnDemandMeasurementJobControlSource:
      title: tapi.eth.EthOnDemandMeasurementJobControlSource
      type: object
      properties:
        flr-availability-delta-time:
          type: integer
          description: >-
            Time length over which each Availability Frame Loss Ratio value is calculated.

                            MEF 35.1:

                            [R78]/[CR58] [O8] A SOAM PM Implementation MUST support a configurable parameter for the length of time over which each Availability flr value is calculated, with a range of 1s � 300s.  This parameter is equivalent to delta-t as specified by MEF 10.3.

                            [R79]/[CR59] [O8] The length of time over which each Availability flr value is calculated (delta-t) MUST be an integer multiple of the interval between each SLM/1SL frame transmission.

                            [D31]/[CD16] [O8] The default length of time over which each Availability flr value is calculated SHOULD be 1s.
          format: int32
          default: 1
        time-of-the-day-alignment:
          type: boolean
          description: >-
            MEF 35.1:

                            [D7] A SOAM PM Implementation SHOULD allow for no alignment to the time-of-day clock.
          default: true
        test-identifier:
          type: integer
          description: >-
            This attribute is used to distinguish each measurement session if multiple measurement sessions are simultaneously activated towards a peer MEP including concurrent on-demand and proactive tests.

                            It must be unique at least within the context of any measurement type for the MEG and initiating MEP.

                            Note: The attribute is not used in case of 2-way loss measurement.

                            range of type : 0..(2^32) - 1
          format: int32
        repetition-period:
          $ref: '#/components/schemas/tapi.eth.RepetitionPeriod'
        offset-from-time-of-the-day:
          type: integer
          description: >-
            MEF 35.1:

                            [D8] A SOAM PM Implementation SHOULD support a configurable (in minutes) offset from ToD time for alignment of the start of Measurement Intervals other than the first Measurement Interval.
          format: int32
        flr-availability-threshold:
          type: string
          description: >-
            Frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each time interval (as specified by Availability Delta Time).

                            MEF 35.1:

                            [R81]/[CR61] A SOAM PM Implementation MUST support a configurable Availability frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each delta-t interval per MEF 10.3

                            [R82]/[CR62] The Availability frame loss ratio threshold range of 0.00 through 1.00 MUST be supported in increments of 0.01.

                            [D33]/[CD18] [O8] The default Availability frame loss ratio threshold SHOULD be 0.1.
          default: '0.1'
        priority:
          type: integer
          description: >-
            This attribute contains the priority value on which the MEP performs the measurement.

                            When the measurement is enabled, the MEP should use this value to encode the priority of generated measurement frames (OAM PDU frames.).

                            The EMF usese this value to assign the P parameter of the measurement operation.
          format: int32
          default: 7
        flr-availability-samples:
          type: integer
          description: >-
            Number of consecutive Availability Frame Loss Ratio measurements to be used to determine Available/Unavailable state transitions.

                            MEF 35.1:

                            [R80]/[CR60] [O8] The number range of 1 through 10 MUST be supported for the configurable number of consecutive Availability flr measurements to be used to determine Available/Unavailable state transitions.

                            This parameter is equivalent to the Availability parameter of n as specified by MEF 10.3.

                            [D32]/[CD17] [O8] The default number of n for Availability SHOULD be 10.
          format: int32
          default: 10
        message-period:
          type: integer
          description: >-
            This attribute indicates the period (frequency) of the measurement frame transmission.

                            Note that the value 0 means that only one OAM message per measurement interval is generated.

                            Unit is milliseconds.

                            range of type : 100ms, 1s, 10s
          format: int32
          default: 1000
        measurement-interval:
          type: integer
          description: >-
            This attribute contains the discrete non overlapping periods of time (in seconds) during which measurements are performed

                            (i.e., OAM messages are generated) and reports are gathered at the end of the measurement intervals.

                            Note that the value 0 means a degenerated measurement interval with a single OAM message and the report is sent as immediately as possible.
          format: int32
        data-tlv-length:
          type: integer
          description: >-
            This parameter provides the size of the optional data TLV.

                            Non-negative integer represents the number of bytes for the length of the padding TLV.

                            Notes:

                            When configuring this parameter one should be aware of the maximum allowed total frame size limitation.

                            The attribute is not used in case of 2-way loss measurement.

                            range of type : Depends on the allowed MTU size.
          format: int32
        destination-address:
          type: string
          description: This attribute contains the MAC address of the peer MEP. See G.8013 for details.
        oam-pdu-generation-type:
          $ref: '#/components/schemas/tapi.eth.OamPduGenerationType'
        controller-mep-id:
          type: integer
          description: none
          format: int32
    tapi.eth.EthOnDemandSingleEndedMeasurementJob:
      title: tapi.eth.EthOnDemandSingleEndedMeasurementJob
      type: object
      properties:
        eth-on-demand-measurement-job-control-source:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandMeasurementJobControlSource'
    tapi.eth.EthProActive1DmPerformanceData:
      title: tapi.eth.EthProActive1DmPerformanceData
      type: object
      properties:
        statistical-near-end-1-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
    tapi.eth.EthProActive1LmPerformanceData:
      title: tapi.eth.EthProActive1LmPerformanceData
      type: object
      properties:
        statistical-near-end-1-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalLmPerformanceParameters'
        total-counters-near-end-1-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.TotalCountersLmPerformanceParameters'
    tapi.eth.EthProActiveDmPerformanceData:
      title: tapi.eth.EthProActiveDmPerformanceData
      type: object
      properties:
        statistical-bi-dir-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
        statistical-far-end-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
        statistical-near-end-dm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalDmPerformanceParameters'
    tapi.eth.EthProActiveDualEndedMeasurementJob:
      title: tapi.eth.EthProActiveDualEndedMeasurementJob
      type: object
      properties:
        eth-pro-active-measurement-job-control-source:
          $ref: '#/components/schemas/tapi.eth.EthProActiveMeasurementJobControlSource'
        eth-pro-active-measurement-job-control-sink:
          $ref: '#/components/schemas/tapi.eth.EthProActiveMeasurementJobControlSink'
    tapi.eth.EthProActiveLmPerformanceData:
      title: tapi.eth.EthProActiveLmPerformanceData
      type: object
      properties:
        bidir-unavailable-intervals:
          type: integer
          description: >-
            A generalized (bidirectional) UAS.

                            MEF 35.1: A 32-bit counter reflecting the number of delta-t intervals evaluated as Unavailable (i.e., for which A<Controller, Responder>(delta-t) = 0).
          format: int32
        statistical-far-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalLmPerformanceParameters'
        statistical-near-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.StatisticalLmPerformanceParameters'
        total-counters-near-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.TotalCountersLmPerformanceParameters'
        total-counters-far-end-lm-parameters:
          $ref: '#/components/schemas/tapi.eth.TotalCountersLmPerformanceParameters'
    tapi.eth.EthProActiveMeasurementJobControlSink:
      title: tapi.eth.EthProActiveMeasurementJobControlSink
      type: object
      properties:
        flr-availability-delta-time:
          type: integer
          description: >-
            Time length over which each Availability Frame Loss Ratio value is calculated.

                            MEF 35.1:

                            [R78]/[CR58] [O8] A SOAM PM Implementation MUST support a configurable parameter for the length of time over which each Availability flr value is calculated, with a range of 1s � 300s.  This parameter is equivalent to delta-t as specified by MEF 10.3.

                            [R79]/[CR59] [O8] The length of time over which each Availability flr value is calculated (delta-t) MUST be an integer multiple of the interval between each SLM/1SL frame transmission.

                            [D31]/[CD16] [O8] The default length of time over which each Availability flr value is calculated SHOULD be 1s.
          format: int32
          default: 1
        time-of-the-day-alignment:
          type: boolean
          description: >-
            MEF 35.1:

                            [D7] A SOAM PM Implementation SHOULD allow for no alignment to the time-of-day clock.
          default: true
        test-identifier:
          type: integer
          description: >-
            This attribute is used to distinguish each measurement session if multiple measurement sessions are simultaneously activated towards a peer MEP including concurrent on-demand and proactive tests.

                            It must be unique at least within the context of any measurement type for the MEG and initiating MEP.

                            Note: The attribute is not used in case of 2-way loss measurement.

                            range of type : 0..(2^32) - 1
          format: int32
        repetition-period:
          $ref: '#/components/schemas/tapi.eth.RepetitionPeriod'
        offset-from-time-of-the-day:
          type: integer
          description: >-
            MEF 35.1:

                            [D8] A SOAM PM Implementation SHOULD support a configurable (in minutes) offset from ToD time for alignment of the start of Measurement Intervals other than the first Measurement Interval.
          format: int32
        flr-availability-threshold:
          type: string
          description: >-
            Frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each time interval (as specified by Availability Delta Time).

                            MEF 35.1:

                            [R81]/[CR61] A SOAM PM Implementation MUST support a configurable Availability frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each delta-t interval per MEF 10.3

                            [R82]/[CR62] The Availability frame loss ratio threshold range of 0.00 through 1.00 MUST be supported in increments of 0.01.

                            [D33]/[CD18] [O8] The default Availability frame loss ratio threshold SHOULD be 0.1.
          default: '0.1'
        priority:
          type: integer
          description: >-
            This attribute contains the priority value on which the MEP performs the measurement.

                            When the measurement is enabled, the MEP should use this value to encode the priority of generated measurement frames (OAM PDU frames.).

                            The EMF usese this value to assign the P parameter of the measurement operation.
          format: int32
          default: 7
        flr-availability-samples:
          type: integer
          description: >-
            Number of consecutive Availability Frame Loss Ratio measurements to be used to determine Available/Unavailable state transitions.

                            MEF 35.1:

                            [R80]/[CR60] [O8] The number range of 1 through 10 MUST be supported for the configurable number of consecutive Availability flr measurements to be used to determine Available/Unavailable state transitions.

                            This parameter is equivalent to the Availability parameter of n as specified by MEF 10.3.

                            [D32]/[CD17] [O8] The default number of n for Availability SHOULD be 10.
          format: int32
          default: 10
        message-period:
          type: integer
          description: >-
            This attribute indicates the period (frequency) of the measurement frame transmission.

                            Note that the value 0 means that only one OAM message per measurement interval is generated.

                            Unit is milliseconds.

                            range of type : 100ms, 1s, 10s
          format: int32
          default: 1000
        measurement-interval:
          type: integer
          description: >-
            This attribute contains the discrete non overlapping periods of time (in seconds) during which measurements are performed

                            (i.e., OAM messages are generated) and reports are gathered at the end of the measurement intervals.

                            Note that the value 0 means a degenerated measurement interval with a single OAM message and the report is sent as immediately as possible.
          format: int32
        sink-mep-id:
          type: integer
          description: none
          format: int32
        source-address:
          type: string
          description: This attribute contains the MAC address of the peer MEP. See G.8013 for details.
        is-enabled:
          type: boolean
          description: This attribute identifies the state of the measurement job. If set to TRUE, the MEP performs proactive Performance Measurement.
          default: true
    tapi.eth.EthProActiveMeasurementJobControlSource:
      title: tapi.eth.EthProActiveMeasurementJobControlSource
      type: object
      properties:
        flr-availability-delta-time:
          type: integer
          description: >-
            Time length over which each Availability Frame Loss Ratio value is calculated.

                            MEF 35.1:

                            [R78]/[CR58] [O8] A SOAM PM Implementation MUST support a configurable parameter for the length of time over which each Availability flr value is calculated, with a range of 1s � 300s.  This parameter is equivalent to delta-t as specified by MEF 10.3.

                            [R79]/[CR59] [O8] The length of time over which each Availability flr value is calculated (delta-t) MUST be an integer multiple of the interval between each SLM/1SL frame transmission.

                            [D31]/[CD16] [O8] The default length of time over which each Availability flr value is calculated SHOULD be 1s.
          format: int32
          default: 1
        time-of-the-day-alignment:
          type: boolean
          description: >-
            MEF 35.1:

                            [D7] A SOAM PM Implementation SHOULD allow for no alignment to the time-of-day clock.
          default: true
        test-identifier:
          type: integer
          description: >-
            This attribute is used to distinguish each measurement session if multiple measurement sessions are simultaneously activated towards a peer MEP including concurrent on-demand and proactive tests.

                            It must be unique at least within the context of any measurement type for the MEG and initiating MEP.

                            Note: The attribute is not used in case of 2-way loss measurement.

                            range of type : 0..(2^32) - 1
          format: int32
        repetition-period:
          $ref: '#/components/schemas/tapi.eth.RepetitionPeriod'
        offset-from-time-of-the-day:
          type: integer
          description: >-
            MEF 35.1:

                            [D8] A SOAM PM Implementation SHOULD support a configurable (in minutes) offset from ToD time for alignment of the start of Measurement Intervals other than the first Measurement Interval.
          format: int32
        flr-availability-threshold:
          type: string
          description: >-
            Frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each time interval (as specified by Availability Delta Time).

                            MEF 35.1:

                            [R81]/[CR61] A SOAM PM Implementation MUST support a configurable Availability frame loss ratio threshold to be used in evaluating the Available/Unavailable state of each delta-t interval per MEF 10.3

                            [R82]/[CR62] The Availability frame loss ratio threshold range of 0.00 through 1.00 MUST be supported in increments of 0.01.

                            [D33]/[CD18] [O8] The default Availability frame loss ratio threshold SHOULD be 0.1.
          default: '0.1'
        priority:
          type: integer
          description: >-
            This attribute contains the priority value on which the MEP performs the measurement.

                            When the measurement is enabled, the MEP should use this value to encode the priority of generated measurement frames (OAM PDU frames.).

                            The EMF usese this value to assign the P parameter of the measurement operation.
          format: int32
          default: 7
        flr-availability-samples:
          type: integer
          description: >-
            Number of consecutive Availability Frame Loss Ratio measurements to be used to determine Available/Unavailable state transitions.

                            MEF 35.1:

                            [R80]/[CR60] [O8] The number range of 1 through 10 MUST be supported for the configurable number of consecutive Availability flr measurements to be used to determine Available/Unavailable state transitions.

                            This parameter is equivalent to the Availability parameter of n as specified by MEF 10.3.

                            [D32]/[CD17] [O8] The default number of n for Availability SHOULD be 10.
          format: int32
          default: 10
        message-period:
          type: integer
          description: >-
            This attribute indicates the period (frequency) of the measurement frame transmission.

                            Note that the value 0 means that only one OAM message per measurement interval is generated.

                            Unit is milliseconds.

                            range of type : 100ms, 1s, 10s
          format: int32
          default: 1000
        measurement-interval:
          type: integer
          description: >-
            This attribute contains the discrete non overlapping periods of time (in seconds) during which measurements are performed

                            (i.e., OAM messages are generated) and reports are gathered at the end of the measurement intervals.

                            Note that the value 0 means a degenerated measurement interval with a single OAM message and the report is sent as immediately as possible.
          format: int32
        data-tlv-length:
          type: integer
          description: >-
            This parameter provides the size of the optional data TLV.

                            Non-negative integer represents the number of bytes for the length of the padding TLV.

                            Notes:

                            When configuring this parameter one should be aware of the maximum allowed total frame size limitation.

                            The attribute is not used in case of 2-way loss measurement.

                            range of type : Depends on the allowed MTU size.
          format: int32
        destination-address:
          type: string
          description: This attribute provides the Unicast MAC address of the intented destination.
        controller-mep-id:
          type: integer
          description: none
          format: int32
        is-enabled:
          type: boolean
          description: This attribute identifies the state of the measurement job. If set to TRUE, the MEP performs proactive Performance Measurement.
          default: true
    tapi.eth.EthProActiveSingleEndedMeasurementJob:
      title: tapi.eth.EthProActiveSingleEndedMeasurementJob
      type: object
      properties:
        eth-pro-active-measurement-job-control-source:
          $ref: '#/components/schemas/tapi.eth.EthProActiveMeasurementJobControlSource'
    tapi.eth.EthServiceIntefacePointSpec:
      title: tapi.eth.EthServiceIntefacePointSpec
      type: object
      properties:
        phy-type:
          $ref: '#/components/schemas/tapi.eth.EtyPhyType'
        phy-type-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.EtyPhyType'
          description: This attribute identifies the possible PHY types that could be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3.
    tapi.eth.EthTerminationCommonPac:
      title: tapi.eth.EthTerminationCommonPac
      type: object
      properties:
        filter-config-1:
          type: array
          items:
            type: string
          description: "This attribute models the ETHx/ETH-m_A_Sk_MI_Filter_Config information defined in G.8021.\r\n                It indicates the configured filter action for each of the 33 group MAC addresses for control frames.\r\n                The 33 MAC addresses are:\r\n                01-80-C2-00-00-10, \r\n                01-80-C2-00-00-00 to 01-80-C2-00-00-0F, and \r\n                01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n                The filter action is Pass or Block. \r\n                If the destination address of the incoming ETH_CI_D matches one of the above addresses, the filter process shall perform the corresponding configured filter action. \r\n                If none of the above addresses match, the ETH_CI_D is passed."
        ether-type:
          $ref: '#/components/schemas/tapi.eth.VlanType'
        priority-code-point-config:
          $ref: '#/components/schemas/tapi.eth.PcpCoding'
        frametype-config:
          $ref: '#/components/schemas/tapi.eth.FrameType'
        port-vid:
          type: string
          description: This attribute models the ETHx/ETH-m _A_Sk_MI_PVID information defined in G.8021.
          default: '1'
        priority-regenerate:
          $ref: '#/components/schemas/tapi.eth.PriorityMapping'
    tapi.eth.EthTerminationPac:
      title: tapi.eth.EthTerminationPac
      type: object
      properties:
        eth-termination-common-pac:
          $ref: '#/components/schemas/tapi.eth.EthTerminationCommonPac'
    tapi.eth.EthTestJob:
      title: tapi.eth.EthTestJob
      type: object
      properties:
        number:
          type: integer
          description: This parameter specifies how many TST messages to be sent.
          format: int32
        destination-address:
          type: string
          description: 'G.8052: This parameter provides the destination address, i.e., the MAC Address of the target MEP or MIP.'
        test-pattern:
          type: string
          description: >-
            G.8052: This parameter provides the test pattern to be used in the optional Data TLV.

                            Examples of test patterns include pseudo-random bit sequence (PRBS) 2^31-1 as specified in clause 5.8 of [ITU-T O.150], all '0' pattern, etc.
        eth-test-job-sink-point:
          $ref: '#/components/schemas/tapi.eth.EthTestJobSinkPoint'
        eth-oam-test-loopback-common-pac:
          $ref: '#/components/schemas/tapi.eth.EthOamTestLoopbackCommonPac'
    tapi.eth.EthTestJobSinkPoint:
      title: tapi.eth.EthTestJobSinkPoint
      type: object
      properties:
        source-address:
          type: string
          description: This attribute contains the MAC address of the peer MEP.
    tapi.eth.EthTestResultData:
      title: tapi.eth.EthTestResultData
      type: object
      properties:
        sent-tst-frames:
          type: integer
          description: >-
            G.8052: This parameter returns the total number of sent TST frames.

                            Optional in case of sink only MEP.
          format: int32
        rec-tst-frames:
          type: integer
          description: Received TST frames. Optional in case of source only MEP.
          format: int32
    tapi.eth.EtyPac:
      title: tapi.eth.EtyPac
      type: object
      properties:
        phy-type:
          $ref: '#/components/schemas/tapi.eth.EtyPhyType'
        phy-type-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.EtyPhyType'
          description: This attribute identifies the possible PHY types that could be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3.
    tapi.eth.EtyPhyType:
      title: tapi.eth.EtyPhyType
      enum:
      - OTHER
      - UNKNOWN
      - NONE
      - 2BASE_TL
      - 10MBIT_S
      - 10PASS_TS
      - 100BASE_T4
      - 100BASE_X
      - 100BASE_T2
      - 1000BASE_X
      - 1000BASE_T
      - 10GBASE-X
      - 10GBASE_R
      - 10GBASE_W
      type: string
    tapi.eth.EtyTerminationCommonPac:
      title: tapi.eth.EtyTerminationCommonPac
      type: object
      properties:
        is-fts-enabled:
          type: boolean
          description: This attribute indicates whether Forced Transmitter Shutdown (FTS) is enabled or not. It models the ETYn_TT_So_MI_FTSEnable information.
          default: false
        is-tx-pause-enabled:
          type: boolean
          description: This attribute identifies whether the Transmit Pause process is enabled or not. It models the MI_TxPauseEnable defined in G.8021.
          default: false
    tapi.eth.EtyTerminationPac:
      title: tapi.eth.EtyTerminationPac
      type: object
      properties:
        phy-type:
          $ref: '#/components/schemas/tapi.eth.EtyPhyType'
        phy-type-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.EtyPhyType'
          description: This attribute identifies the possible PHY types that could be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3.
        ety-termination-common-pac:
          $ref: '#/components/schemas/tapi.eth.EtyTerminationCommonPac'
    tapi.eth.FrameType:
      title: tapi.eth.FrameType
      enum:
      - ADMIT_ONLY_VLAN_TAGGED_FRAMES
      - ADMIT_ONLY_UNTAGGED_AND_PRIORITY_TAGGED_FRAMES
      - ADMIT_ALL_FRAMES
      type: string
    tapi.eth.HistoryDataAugmentation1:
      title: tapi.eth.HistoryDataAugmentation1
      type: object
      properties:
        eth-on-demand-1-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemand1DmPerformanceData'
    tapi.eth.HistoryDataAugmentation10:
      title: tapi.eth.HistoryDataAugmentation10
      type: object
      properties:
        eth-pro-active-1-dm-source-performance-data:
          type: object
    tapi.eth.HistoryDataAugmentation11:
      title: tapi.eth.HistoryDataAugmentation11
      type: object
      properties:
        eth-on-demand-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandDmPerformanceData'
    tapi.eth.HistoryDataAugmentation12:
      title: tapi.eth.HistoryDataAugmentation12
      type: object
      properties:
        eth-pro-active-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActiveLmPerformanceData'
    tapi.eth.HistoryDataAugmentation2:
      title: tapi.eth.HistoryDataAugmentation2
      type: object
      properties:
        eth-on-demand-1-dm-source-performance-data:
          type: object
    tapi.eth.HistoryDataAugmentation3:
      title: tapi.eth.HistoryDataAugmentation3
      type: object
      properties:
        eth-on-demand-1-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemand1LmPerformanceData'
    tapi.eth.HistoryDataAugmentation4:
      title: tapi.eth.HistoryDataAugmentation4
      type: object
      properties:
        eth-pro-active-1-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActive1LmPerformanceData'
    tapi.eth.HistoryDataAugmentation5:
      title: tapi.eth.HistoryDataAugmentation5
      type: object
      properties:
        eth-pro-active-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActiveDmPerformanceData'
    tapi.eth.HistoryDataAugmentation6:
      title: tapi.eth.HistoryDataAugmentation6
      type: object
      properties:
        eth-pro-active-1-lm-source-performance-data:
          type: object
    tapi.eth.HistoryDataAugmentation7:
      title: tapi.eth.HistoryDataAugmentation7
      type: object
      properties:
        eth-on-demand-lm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandLmPerformanceData'
    tapi.eth.HistoryDataAugmentation8:
      title: tapi.eth.HistoryDataAugmentation8
      type: object
      properties:
        eth-on-demand-1-lm-source-performance-data:
          type: object
    tapi.eth.HistoryDataAugmentation9:
      title: tapi.eth.HistoryDataAugmentation9
      type: object
      properties:
        eth-pro-active-1-dm-performance-data:
          $ref: '#/components/schemas/tapi.eth.EthProActive1DmPerformanceData'
    tapi.eth.InputAugmentation1:
      title: tapi.eth.InputAugmentation1
      type: object
      properties:
        eth-link-trace-job:
          $ref: '#/components/schemas/tapi.eth.EthLinkTraceJob'
    tapi.eth.InputAugmentation2:
      title: tapi.eth.InputAugmentation2
      type: object
      properties:
        eth-loopback-job:
          $ref: '#/components/schemas/tapi.eth.EthLoopbackJob'
    tapi.eth.InputAugmentation3:
      title: tapi.eth.InputAugmentation3
      type: object
      properties:
        eth-test-job:
          $ref: '#/components/schemas/tapi.eth.EthTestJob'
    tapi.eth.InputAugmentation4:
      title: tapi.eth.InputAugmentation4
      type: object
      properties:
        eth-pro-active-single-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthProActiveSingleEndedMeasurementJob'
    tapi.eth.InputAugmentation5:
      title: tapi.eth.InputAugmentation5
      type: object
      properties:
        eth-on-demand-dual-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandDualEndedMeasurementJob'
    tapi.eth.InputAugmentation6:
      title: tapi.eth.InputAugmentation6
      type: object
      properties:
        eth-on-demand-single-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandSingleEndedMeasurementJob'
    tapi.eth.InputAugmentation7:
      title: tapi.eth.InputAugmentation7
      type: object
      properties:
        eth-pro-active-dual-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthProActiveDualEndedMeasurementJob'
    tapi.eth.LinkTraceResult:
      title: tapi.eth.LinkTraceResult
      type: object
      properties:
        data-tlv-length:
          type: integer
          description: 'G.8052: This attribute contains the length (in number of octets) of the Data TLV of an individual LTR frame result.'
          format: int32
        time-to-live:
          type: integer
          description: 'G.8052: This attribute contains the Time To Live (TTL) value of an individual LTR frame result.'
          format: int32
        source-address:
          type: string
          description: 'G.8052: This attribute contains the source MAC Address of an individual LTR frame result.'
    tapi.eth.LldpChassisIdSubtype:
      title: tapi.eth.LldpChassisIdSubtype
      type: object
      properties:
        mac-address:
          type: string
          description: Represents a chassis identifier based on the value of a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order), of a port on the containing chassis as defined in IEEE Std 802-2001.
        chassis-component:
          type: string
          description: >-
            String length '0..32'

                            Represents a chassis identifier based on the value of entPhysicalAlias object (defined in IETF RFC 2737) for a chassis component (i.e., an entPhysicalClass value of chassis(3)).
        interface-name:
          type: string
          description: Represents a chassis identifier based on the value of ifName object (defined in IETF RFC 2863) for an interface on the containing chassis.
        network-address:
          type: string
          description: >-
            Octet string that identifies a particular network address family and an associated network address that are encoded in network octet order.

                            An IP address, for example, would be encoded with the first octet containing the IANA Address Family Numbers enumeration value for the specific address type and octets 2 through n containing the address value.
        interface-alias:
          type: string
          description: >-
            String length '0..64'

                            Represents a chassis identifier based on the value of ifAlias object (defined in IETF RFC 2863) for an interface on the containing chassis.
        port-component:
          type: string
          description: >-
            String length '0..32'

                            Represents a chassis identifier based on the value of entPhysicalAlias object (defined in IETF RFC 2737) for a port or backplane component (i.e., entPhysicalClass value of port(10) or backplane(4)), within the containing chassis.
        local:
          type: string
          description: Represents a chassis identifier based on a locally defined value.
    tapi.eth.LldpPortIdSubtype:
      title: tapi.eth.LldpPortIdSubtype
      type: object
      properties:
        agent-circuit-id:
          type: string
          description: Represents a port identifier based on the agent-local identifier of the circuit (defined in RFC 3046), detected by the agent and associated with a particular port.
        mac-address:
          type: string
          description: Represents a port identifier based on a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order), which has been detected by the agent and associated with a particular port (IEEE Std 802-2001).
        interface-name:
          type: string
          description: >-
            String length '0..64'

                            Represents a port identifier based on the ifName MIB object, defined in IETF RFC 2863.
        network-address:
          type: string
          description: >-
            Represents a port identifier based on a network address, detected by the agent and associated with a particular port.

                            Octet string that identifies a particular network address family and an associated network address that are encoded in network octet order.

                            An IP address, for example, would be encoded with the first octet containing the IANA Address Family Numbers enumeration value for the specific address type and octets 2 through n containing the address value.
        interface-alias:
          type: string
          description: >-
            String length '0..64'

                            Represents a port identifier based on the ifAlias MIB object, defined in IETF RFC 2863.
        port-component:
          type: string
          description: >-
            String length '0..32'

                            Represents a port identifier based on the value of entPhysicalAlias (defined in IETF RFC 2737) for a port component (i.e., entPhysicalClass value of port(10)), within the containing chassis.
        local:
          type: string
          description: Represents a port identifier based on a value locally assigned.
    tapi.eth.MaintenanceAssociationName:
      title: tapi.eth.MaintenanceAssociationName
      type: object
      properties:
        char-string:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            RFC2579 DisplayString, except that the character codes 0-31 (decimal) are not used.

                            Length '1..45'
        ieee-reserved:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            Reserved for definition by IEEE 802.1. Recommend not to use zero unless absolutely needed.

                            Length '1..45'.
          default: '0'
        unsigned-int-16:
          type: integer
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            2-octet integer/big endian.
          format: int32
        icc-format:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            ICC-based format as specified in ITU-T Y.1731.

                            Length '1..45'
        primary-vlan-id:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            Primary VLAN ID. 12 bits represented in a 2-octet integer.
        rfc-2865-vpn-id:
          type: string
          description: >-
            IEEE P802.1Qcx/D0.3:

                            MEF 38:

                            RFC2685 VPN ID. 3 octet VPN authority Organizationally Unique Identifier followed by 4 octet VPN index identifying VPN according to the OUI.

                            Length '1..45';
    tapi.eth.MegAugmentation1:
      title: tapi.eth.MegAugmentation1
      type: object
      properties:
        eth-meg-spec:
          $ref: '#/components/schemas/tapi.eth.EthMegSpec'
    tapi.eth.MepAugmentation1:
      title: tapi.eth.MepAugmentation1
      type: object
      properties:
        eth-mep-spec:
          $ref: '#/components/schemas/tapi.eth.EthMepSpec'
    tapi.eth.MipAugmentation1:
      title: tapi.eth.MipAugmentation1
      type: object
      properties:
        eth-mip-spec:
          $ref: '#/components/schemas/tapi.eth.EthMipSpec'
    tapi.eth.OamJobAugmentation1:
      title: tapi.eth.OamJobAugmentation1
      type: object
      properties:
        eth-loopback-job:
          $ref: '#/components/schemas/tapi.eth.EthLoopbackJob'
    tapi.eth.OamJobAugmentation2:
      title: tapi.eth.OamJobAugmentation2
      type: object
      properties:
        eth-test-job:
          $ref: '#/components/schemas/tapi.eth.EthTestJob'
    tapi.eth.OamJobAugmentation3:
      title: tapi.eth.OamJobAugmentation3
      type: object
      properties:
        eth-link-trace-job:
          $ref: '#/components/schemas/tapi.eth.EthLinkTraceJob'
    tapi.eth.OamJobAugmentation4:
      title: tapi.eth.OamJobAugmentation4
      type: object
      properties:
        eth-on-demand-single-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandSingleEndedMeasurementJob'
    tapi.eth.OamJobAugmentation5:
      title: tapi.eth.OamJobAugmentation5
      type: object
      properties:
        eth-pro-active-single-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthProActiveSingleEndedMeasurementJob'
    tapi.eth.OamJobAugmentation6:
      title: tapi.eth.OamJobAugmentation6
      type: object
      properties:
        eth-pro-active-dual-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthProActiveDualEndedMeasurementJob'
    tapi.eth.OamJobAugmentation7:
      title: tapi.eth.OamJobAugmentation7
      type: object
      properties:
        eth-on-demand-dual-ended-measurement-job:
          $ref: '#/components/schemas/tapi.eth.EthOnDemandDualEndedMeasurementJob'
    tapi.eth.OamPduGenerationType:
      title: tapi.eth.OamPduGenerationType
      enum:
      - SINGLE_INSTANCE
      - REPETITIVE_INSTANCE
      - SINGLE_SERIES
      - REPETITIVE_SERIES
      type: string
    tapi.eth.OamPeriod:
      title: tapi.eth.OamPeriod
      enum:
      - 3_33MS
      - 10MS
      - 100MS
      - 1S
      - 10S
      - 1MIN
      - 10MIN
      type: string
    tapi.eth.OamServiceAugmentation1:
      title: tapi.eth.OamServiceAugmentation1
      type: object
      properties:
        eth-oam-service:
          $ref: '#/components/schemas/tapi.eth.EthOamService'
    tapi.eth.OamServicePointAugmentation1:
      title: tapi.eth.OamServicePointAugmentation1
      type: object
      properties:
        eth-oam-mip-service-point:
          $ref: '#/components/schemas/tapi.eth.EthOamMipServicePoint'
    tapi.eth.OamServicePointAugmentation2:
      title: tapi.eth.OamServicePointAugmentation2
      type: object
      properties:
        eth-oam-mep-service-point:
          $ref: '#/components/schemas/tapi.eth.EthOamMepServicePoint'
    tapi.eth.PcpCoding:
      title: tapi.eth.PcpCoding
      enum:
      - 8P0D
      - 7P1D
      - 6P2D
      - 5P3D
      - DEI
      type: string
    tapi.eth.PriorityConfiguration:
      title: tapi.eth.PriorityConfiguration
      type: object
      properties:
        priority:
          type: integer
          description: none
          format: int32
        queue-id:
          type: integer
          description: none
          format: int32
    tapi.eth.PriorityMapping:
      title: tapi.eth.PriorityMapping
      type: object
      properties:
        priority-0:
          type: integer
          description: This attribute defines the new priority value for the old priority value 0.
          format: int32
        priority-1:
          type: integer
          description: This attribute defines the new priority value for the old priority value 1.
          format: int32
          default: 1
        priority-2:
          type: integer
          description: This attribute defines the new priority value for the old priority value 2.
          format: int32
          default: 2
        priority-3:
          type: integer
          description: This attribute defines the new priority value for the old priority value 3.
          format: int32
          default: 3
        priority-4:
          type: integer
          description: This attribute defines the new priority value for the old priority value 4.
          format: int32
          default: 4
        priority-5:
          type: integer
          description: This attribute defines the new priority value for the old priority value 5.
          format: int32
          default: 5
        priority-6:
          type: integer
          description: This attribute defines the new priority value for the old priority value 6.
          format: int32
          default: 6
        priority-7:
          type: integer
          description: This attribute defines the new priority value for the old priority value 7.
          format: int32
          default: 7
    tapi.eth.QueueConfiguration:
      title: tapi.eth.QueueConfiguration
      type: object
      properties:
        queue-threshold:
          type: integer
          description: This attribute defines the threshold of the queue in bytes.
          format: int32
        queue-id:
          type: integer
          description: This attribute indicates the queue id.
          format: int32
        queue-depth:
          type: integer
          description: This attribute defines the depth of the queue in bytes.
          format: int32
    tapi.eth.RepetitionPeriod:
      title: tapi.eth.RepetitionPeriod
      enum:
      - 1MIN
      - 1S
      - 10S
      - '0'
      type: string
    tapi.eth.SamplesDmPerformanceParameters:
      title: tapi.eth.SamplesDmPerformanceParameters
      type: object
      properties:
        frame-delay-variation-list:
          type: array
          items:
            type: integer
            format: int32
          description: This attribute contains the frame delay variations measured in ns (nano second).  The multiplicity is defined by (numberOfSamples - 1, for numberOfSamples > 0).
        number-of-samples:
          type: integer
          description: >-
            This attribute contains the number of received DM frames (successful samples) used for this frame delay measurement.

                            range of type : non-negative
          format: int32
        frame-delay-list:
          type: array
          items:
            type: integer
            format: int32
          description: This attribute contains the frame delays measured in ns (nano second, 1x10e-9 seconds). The multiplicity is defined by the numberOfSamples attribute.
    tapi.eth.ServiceAugmentation1:
      title: tapi.eth.ServiceAugmentation1
      type: object
      properties:
        eth-connectivity-service:
          type: object
    tapi.eth.ServiceInterfacePointAugmentation1:
      title: tapi.eth.ServiceInterfacePointAugmentation1
      type: object
      properties:
        eth-service-inteface-point-spec:
          $ref: '#/components/schemas/tapi.eth.EthServiceIntefacePointSpec'
    tapi.eth.SipAugmentation1:
      title: tapi.eth.SipAugmentation1
      type: object
      properties:
        eth-service-inteface-point-spec:
          $ref: '#/components/schemas/tapi.eth.EthServiceIntefacePointSpec'
    tapi.eth.StatisticalDmPerformanceParameters:
      title: tapi.eth.StatisticalDmPerformanceParameters
      type: object
      properties:
        average-frame-delay:
          type: integer
          description: This attribute contains the average frame delay observed over the monitored period. It is measured in units of ns (nano second, 1x10e-9 seconds).
          format: int32
        maximum-frame-delay:
          type: integer
          description: This attribute contains the maximum frame delay observed over the monitored period. It is measured in units of ns (nano second, 1x10e-9 seconds).
          format: int32
        average-inter-frame-delay-variation:
          type: integer
          description: >-
            This attribute contains the average frame delay variation measured in units of ns (nano second, 1x10e-9 seconds).

                            G.8013/Y.1731:

                            Frame delay variation is a measure of the variations in the frame delay between a pair of service frames
          format: int32
        minimum-frame-delay:
          type: integer
          description: This attribute contains the minimum frame delay observed over the monitored period. It is measured in units of ns (nano second, 1x10e-9 seconds).
          format: int32
        maximum-frame-delay-variation:
          type: integer
          description: >-
            This attribute contains the maximum frame delay variation measured in units of ns (nano second, 1x10e-9 seconds).

                            Y.1563:

                            The 2-point frame delay variation (vk) for an Ethernet frame k between SRC and DST is the difference between the absolute Ethernet frame transfer delay (xk) of frame k and a defined reference Ethernet frame transfer delay, d1,2, between those same MPs:  vk = xk � d1,2.
          format: int32
        minimum-frame-delay-variation:
          type: integer
          description: >-
            This attribute contains the minimum frame delay variation measured in units of ns (nano second, 1x10e-9 seconds).

                            Y.1563:

                            The 2-point frame delay variation (vk) for an Ethernet frame k between SRC and DST is the difference between the absolute Ethernet frame transfer delay (xk) of frame k and a defined reference Ethernet frame transfer delay, d1,2, between those same MPs:  vk = xk � d1,2.
          format: int32
        minimum-inter-frame-delay-variation:
          type: integer
          description: >-
            This attribute contains the minimum frame delay variation measured in units of ns (nano second, 1x10e-9 seconds).

                            G.8013/Y.1731:

                            Frame delay variation is a measure of the variations in the frame delay between a pair of service frames
          format: int32
        maximum-inter-frame-delay-variation:
          type: integer
          description: >-
            This attribute contains the maximum frame delay variation measured in units of ns (nano second, 1x10e-9 seconds).

                            G.8013/Y.1731:

                            Frame delay variation is a measure of the variations in the frame delay between a pair of service frames
          format: int32
        average-frame-delay-variation:
          type: integer
          description: >-
            This attribute contains the average frame delay variation measured in units of ns (nano second, 1x10e-9 seconds).

                            Y.1563:

                            The 2-point frame delay variation (vk) for an Ethernet frame k between SRC and DST is the difference between the absolute Ethernet frame transfer delay (xk) of frame k and a defined reference Ethernet frame transfer delay, d1,2, between those same MPs:  vk = xk � d1,2.
          format: int32
    tapi.eth.StatisticalLmPerformanceParameters:
      title: tapi.eth.StatisticalLmPerformanceParameters
      type: object
      properties:
        average-frame-loss-ratio:
          type: string
          description: This attribute contains the average frame loss ratio calculated over a period of time.
        unavailable-intervals:
          type: integer
          description: >-
            A generalized UAS.

                            MEF 35.1: A 32-bit counter reflecting the number of delta-t intervals evaluated as Unavailable (i.e., for which A<Controller, Responder>(delta-t) = 0).

                            range of type : 0..900 for 15min interval or 0..86400 for 24 hr interval.
          format: int32
        hli-count:
          type: integer
          description: >-
            A generalized SES.

                            MEF 10.3: The Resiliency attributes are similar to the definitions of Severely Errored Seconds (SES) and Consecutive SES in section 9 and Annex B (respectively) of Y.1563 [6], when delta-t = 1 second.

                            MEF 35.1: Count of High Loss Intervals during the Measurement Interval.

                            range of type : 0..900 for 15min interval or 0..86400 for 24 hr interval.
          format: int32
        maximum-frame-loss-ratio:
          type: string
          description: This attribute contains the maximum frame loss ratio calculated over a period of time.
        minimum-frame-loss-ratio:
          type: string
          description: This attribute contains the minimum frame loss ratio calculated over a period of time.
    tapi.eth.TotalCountersLmPerformanceParameters:
      title: tapi.eth.TotalCountersLmPerformanceParameters
      type: object
      properties:
        total-transmitted-frames:
          type: integer
          description: This attribute contains the total number of frames transmitted.
          format: int32
        total-frame-loss-ratio:
          type: string
          description: >-
            This attribute contains the frame loss ratio (number of lost frames divided by the number of total frames (N_LF / N_TF)).

                            The accuracy of the value is for further study.
        total-lost-frames:
          type: integer
          description: This attribute contains the total number of frames lost.
          format: int32
    tapi.eth.TrafficConditioningConfiguration:
      title: tapi.eth.TrafficConditioningConfiguration
      type: object
      properties:
        queue-id:
          type: integer
          description: This attribute indicates the queue id.
          format: int32
        coupling-flag:
          type: boolean
          description: This attribute indicates the coupling flag.
          default: false
        cbs:
          type: integer
          description: This attribute indicates the Committed Burst Size in bytes.
          format: int32
        ebs:
          type: integer
          description: This attribute indicates the Excess Burst Size in bytes.
          format: int32
        colour-mode:
          $ref: '#/components/schemas/tapi.eth.ColourMode'
        cir:
          type: integer
          description: This attribute indicates the Committed Information Rate in bits/s.
          format: int32
        eir:
          type: integer
          description: This attribute indicates the Excess Information Rate in bits/s.
          format: int32
    tapi.eth.TrafficConditioningPac:
      title: tapi.eth.TrafficConditioningPac
      type: object
      properties:
        codirectional:
          type: boolean
          description: This attribute indicates the direction of the conditioner. The value of true means that the conditioner (modeled as a TCS Sink according to G.8021) is associated with the sink part of the containing CTP. The value of false means that the conditioner (modeled as a TCS Sink according to G.8021) is associated with the source part of the containing CTP.
          default: false
        prio-config-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.PriorityConfiguration'
          description: This attribute indicates the Priority Splitter function for the mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue.
        cond-config-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.TrafficConditioningConfiguration'
          description: >-
            This attribute indicates for the conditioner process the conditioning parameters:

                            - Queue ID: Indicates the Queue ID

                            - Committed Information Rate (CIR): number of bits per second

                            - Committed Burst Size (CBS): number of bytes

                            - Excess Information Rate (EIR): number of bits per second

                            - Excess Burst Size (EBS): number of bytes

                            - Coupling flag (CF): 0 or 1

                            - Color mode (CM): color-blind and color-aware.
    tapi.eth.TrafficShapingPac:
      title: tapi.eth.TrafficShapingPac
      type: object
      properties:
        codirectional:
          type: boolean
          description: This attribute indicates the direction of the shaping function. The value of true means that the shaping (modeled as a TCS Source according to G.8021) is associated with the source part of the containing CTP. The value of false means that the shaping (modeled as a TCS Source according to G.8021) is associated with the sink part of the containing CTP.
          default: false
        sched-config:
          type: string
          description: >-
            This attribute configures the scheduler process. The value of this attribute is for further study because it is for further study in G.8021.

                            Scheduler is a pointer to a Scheduler object, which is to be defined in the future (because in G.8021, this is FFS).

                            Note that the only significance of the GTCS function defined in G.8021 is the use of a common scheduler for shaping. Given that, G.8052 models the common scheduler feature by having a common value for this attribute.
        queue-config-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.QueueConfiguration'
          description: This attribute configures the Queue depth and Dropping threshold parameters of the Queue process. The Queue depth sets the maximum size of the queue in bytes. An incoming ETH_CI traffic unit is dropped if there is insufficient space in the queue to hold the whole unit. The Dropping threshold sets the threshold of the queue. If the queue is filled beyond this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE signal set are dropped.
        prio-config-list:
          type: array
          items:
            $ref: '#/components/schemas/tapi.eth.PriorityConfiguration'
          description: This attribute configures the Priority Splitter function for the mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue.
    tapi.eth.VlanType:
      title: tapi.eth.VlanType
      enum:
      - C_Tag
      - S_Tag
      - I_Tag
      type: string
    tapi.streaming.AvailableStream:
      title: tapi.streaming.AvailableStream
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        stream-state:
          type: string
          description: The state of the stream.
        connection-protocol:
          type: string
          description: >-
            Names the connection protocol for this particular available stream.

                            The connection protocol is chosen from the list of connection protocols identified in the referenced SupportedStreamType.
        supported-stream-type:
          $ref: '#/components/schemas/tapi.streaming.SupportedStreamTypeRef'
        connection-address:
          type: string
          description: "Provides the address for the connection. \r\n                The format of the address and attachment mechanism will depend on the connection protocol defined in another attribute of this class."
        stream-id:
          type: string
          description: The id of the stream.
    tapi.streaming.AvailableStreamRef:
      title: tapi.streaming.AvailableStreamRef
      type: object
      properties:
        available-stream-uuid:
          type: string
          description: none
    tapi.streaming.AvailableStreamRefWrapper:
      title: tapi.streaming.AvailableStreamRefWrapper
      type: object
      properties:
        available-stream:
          $ref: '#/components/schemas/tapi.streaming.AvailableStreamRef'
    tapi.streaming.AvailableStreamWrapper:
      title: tapi.streaming.AvailableStreamWrapper
      type: object
      properties:
        available-stream:
          $ref: '#/components/schemas/tapi.streaming.AvailableStream'
    tapi.streaming.CompactedLogDetails:
      title: tapi.streaming.CompactedLogDetails
      type: object
      properties:
        compaction-delay:
          type: string
          description: "Time in minutes. \r\n                The delay between logging the record and making the record available for compaction.\r\n                This provides an adjustment to the essential Compaction strategy such that there may be several distinct records for the same thing in the where those records are not older than the Compaction Delay.\r\n                Can be adjusted by an administrator (via a separate view) through the life of the stream."
        tombstone-retention:
          type: string
          description: "Time in minutes.\r\n                The time period for which a Tombstone record will be held in the log from when it was logged. \r\n                This provides an adjustment to the essential Compaction strategy such that after the tombstoneRetention period there will be no records about a particular thing that existed but no longer exists.\r\n                Tombstone retention overrides recordRetention for Tombstones.\r\n                Key word 'FOREVER' means that Tombstone records will never be removed from the log.\r\n                Can be adjusted by an administrator (via a separate view) through the life of the stream."
    tapi.streaming.CompactedLogDetailsWrapper:
      title: tapi.streaming.CompactedLogDetailsWrapper
      type: object
      properties:
        compacted-log-details:
          $ref: '#/components/schemas/tapi.streaming.CompactedLogDetails'
    tapi.streaming.ConnectionProtocolDetails:
      title: tapi.streaming.ConnectionProtocolDetails
      type: object
      properties:
        allowed-connection-protocols:
          type: array
          items:
            type: string
          description: Name of the allowed protocol.
    tapi.streaming.ConnectionProtocolDetailsWrapper:
      title: tapi.streaming.ConnectionProtocolDetailsWrapper
      type: object
      properties:
        connection-protocol-details:
          $ref: '#/components/schemas/tapi.streaming.ConnectionProtocolDetails'
    tapi.streaming.ContextAugmentation1:
      title: tapi.streaming.ContextAugmentation1
      type: object
      properties:
        stream-admin-context:
          $ref: '#/components/schemas/tapi.streaming.StreamAdminContext'
    tapi.streaming.ContextAugmentation2:
      title: tapi.streaming.ContextAugmentation2
      type: object
      properties:
        stream-context:
          allOf:
          - $ref: '#/components/schemas/tapi.streaming.context.StreamContext'
          - description: none
    tapi.streaming.GetAvailableStreamConnectionDetails:
      title: tapi.streaming.GetAvailableStreamConnectionDetails
      type: object
      properties:
        output:
          $ref: '#/components/schemas/tapi.streaming.getavailablestreamconnectiondetails.Output'
    tapi.streaming.GetSupportedStreamConnectionTypes:
      title: tapi.streaming.GetSupportedStreamConnectionTypes
      type: object
      properties:
        output:
          $ref: '#/components/schemas/tapi.streaming.getsupportedstreamconnectiontypes.Output'
    tapi.streaming.ObjectClassIdentifier:
      title: tapi.streaming.ObjectClassIdentifier
      enum:
      - NODE
      - CONNECTION
      - LINK
      - CONNECTION_END_POINT
      - CONNECTIVITY_SERVICE
      - INTER_RULE_GROUP
      - MAINTENANCE_ENTITY
      - MAINTENANCE_ENTITY_GROUP
      - MEG_END_POINT
      - MEG_INTERMEDIATE_POINT
      - NODE_EDGE_POINT
      - OAM_JOB
      - PATH
      - NODE_RULE_GROUP
      - PATH_COMPUTATION_SERVICE
      - ROUTE
      - RULE
      - SERVICE_INTERFACE_POINT
      - SWITCH
      - SWITCH_CONTROL
      - TOPOLOGY
      - VIRTUAL_NETWORK_SERVICE
      - OAM_PROFILE
      - OAM_SERVICE
      - CONNECTION_SPEC
      - ACCESS_PORT
      - DEVICE
      - PHYSICAL_SPAN
      - EQUIPMENT
      - HOLDER
      - CONDITION_DETECTOR
      - AVAILABLE_STREAM
      - STREAM_MONITOR
      - SUPPORTED_STREAM_TYPE
      - NETWORK_TOPOLOGY_SERVICE
      - TAPI_CONTEXT
      - OAM_SERVICE_END_POINT
      - PM_BIN_DATA
      - PM_CURRENT_DATA
      - PM_HISTORY_DATA
      - PM_THRESHOLD_DATA
      - CONNECTIVITY_SERVICE_END_POINT
      - ABSTRACT_STRAND
      - PATH_OBJECTIVE_FUNCTION
      - PATH_OPTIMIZATION_CONSTRAINT
      - PATH_SERVICE_END_POINT
      - VIRTUAL_NETWORK_CONSTRAINT
      - VIRTUAL_NETWORK_SERVICE_END_POINT
      - ANY_CLASS
      type: string
    tapi.streaming.StreamAdminContext:
      title: tapi.streaming.StreamAdminContext
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        stream-monitor:
          type: array
          items:
            $ref: '#/components/schemas/tapi.streaming.StreamMonitor'
          description: The list of available stream monitors.
    tapi.streaming.StreamAdminContextWrapper:
      title: tapi.streaming.StreamAdminContextWrapper
      type: object
      properties:
        tapi-streaming:stream-admin-context:
          $ref: '#/components/schemas/tapi.streaming.StreamAdminContext'
    tapi.streaming.StreamMonitor:
      title: tapi.streaming.StreamMonitor
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        last-updated:
          type: string
          description: The date/time when the values provided were recorded.
        client-address:
          type: string
          description: The address of the connected client that is being monitored.
        id-of-last-record-written-to-log:
          type: string
          description: "The id/key of the last record written to the log. \r\n                This is the same value for all clients of the stream."
        id-of-last-record-read-from-log:
          type: string
          description: >-
            The id/key of the last record read from the log by the client stream.

                            The analysis of this value needs to account for stream buffering in the comms layer.
        client-id:
          type: string
          description: The id of the connected client.
        available-stream:
          $ref: '#/components/schemas/tapi.streaming.AvailableStreamRef'
    tapi.streaming.StreamMonitorWrapper:
      title: tapi.streaming.StreamMonitorWrapper
      type: object
      properties:
        stream-monitor:
          $ref: '#/components/schemas/tapi.streaming.StreamMonitor'
    tapi.streaming.SupportedStreamType:
      title: tapi.streaming.SupportedStreamType
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        record-content:
          type: array
          items:
            $ref: '#/components/schemas/tapi.streaming.ObjectClassIdentifier'
          description: "Identifies the classes that are supported through the stream. \r\n                The list may be a subset of the classes within the context."
        log-storage-strategy:
          type: string
          description: Indicates the storage characteristics of the log supporting the stream.
        log-record-strategy:
          type: string
          description: Indicates the type of content of each log record.
        stream-type-name:
          type: string
          description: Name of the stream type.
        segment-size:
          type: string
          description: Size of sub-structuring of the log.
        record-retention:
          type: string
          description: >-
            Time in minutes.

                            Statement of retention time and/or retention capacity in bytes.

                            Key word 'FOREVER' means that records will never be removed from the log.

                            May be overridden for particular cases of specific LogStorageStrategy (via augment).
    tapi.streaming.SupportedStreamTypeAugmentation1:
      title: tapi.streaming.SupportedStreamTypeAugmentation1
      type: object
      properties:
        compacted-log-details:
          $ref: '#/components/schemas/tapi.streaming.CompactedLogDetails'
    tapi.streaming.SupportedStreamTypeAugmentation2:
      title: tapi.streaming.SupportedStreamTypeAugmentation2
      type: object
      properties:
        connection-protocol-details:
          $ref: '#/components/schemas/tapi.streaming.ConnectionProtocolDetails'
    tapi.streaming.SupportedStreamTypeRef:
      title: tapi.streaming.SupportedStreamTypeRef
      type: object
      properties:
        supported-stream-type-uuid:
          type: string
          description: none
    tapi.streaming.SupportedStreamTypeRefWrapper:
      title: tapi.streaming.SupportedStreamTypeRefWrapper
      type: object
      properties:
        supported-stream-type:
          $ref: '#/components/schemas/tapi.streaming.SupportedStreamTypeRef'
    tapi.streaming.connecttostream.Input:
      title: tapi.streaming.connecttostream.Input
      type: object
      properties:
        connection-address:
          type: string
          description: none
        start-from-token:
          type: string
          description: none
    tapi.streaming.context.StreamContextWrapper:
      title: tapi.streaming.context.StreamContextWrapper
      type: object
      properties:
        tapi-streaming:stream-context:
          allOf:
          - $ref: '#/components/schemas/tapi.streaming.context.StreamContext'
          - description: none
    tapi.streaming.getavailablestreamconnectiondetails.Output:
      title: tapi.streaming.getavailablestreamconnectiondetails.Output
      type: object
      properties:
        active-connections:
          type: array
          items:
            $ref: '#/components/schemas/tapi.streaming.AvailableStream'
          description: none
    tapi.streaming.getsupportedstreamconnectiontypes.Output:
      title: tapi.streaming.getsupportedstreamconnectiontypes.Output
      type: object
      properties:
        supported-stream-types:
          type: array
          items:
            $ref: '#/components/schemas/tapi.streaming.SupportedStreamType'
          description: none
    tapi.streaming.streamcontext.SupportedStreamType:
      title: tapi.streaming.streamcontext.SupportedStreamType
      type: object
      properties:
        name:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of names. A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.
        uuid:
          type: string
          description: "UUID: An identifier that is universally unique within an identifier space, where the identifier space is itself globally unique, and immutable. An UUID carries no semantics with respect to the purpose or state of the entity.\r\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
        record-content:
          type: array
          items:
            $ref: '#/components/schemas/tapi.streaming.ObjectClassIdentifier'
          description: "Identifies the classes that are supported through the stream. \r\n                The list may be a subset of the classes within the context."
        log-storage-strategy:
          type: string
          description: Indicates the storage characteristics of the log supporting the stream.
        log-record-strategy:
          type: string
          description: Indicates the type of content of each log record.
        stream-type-name:
          type: string
          description: Name of the stream type.
        segment-size:
          type: string
          description: Size of sub-structuring of the log.
        record-retention:
          type: string
          description: >-
            Time in minutes.

                            Statement of retention time and/or retention capacity in bytes.

                            Key word 'FOREVER' means that records will never be removed from the log.

                            May be overridden for particular cases of specific LogStorageStrategy (via augment).
        compacted-log-details:
          $ref: '#/components/schemas/tapi.streaming.CompactedLogDetails'
        connection-protocol-details:
          $ref: '#/components/schemas/tapi.streaming.ConnectionProtocolDetails'
    tapi.streaming.streamcontext.SupportedStreamTypeWrapper:
      title: tapi.streaming.streamcontext.SupportedStreamTypeWrapper
      type: object
      properties:
        supported-stream-type:
          $ref: '#/components/schemas/tapi.streaming.streamcontext.SupportedStreamType'
    tapi.restconf.capabilities.Response:
      title: tapi.restconf.capabilities.Response
      type: object
      properties:
        capabilities:
          $ref: '#/components/schemas/Capabilities'
    FreExpectationAttributesRO:
      title: FreExpectationAttributesRO
      type: object
      properties:
        validateParameters:
          $ref: '#/components/schemas/ValidateParametersRO'
        provisionPolicies:
          $ref: '#/components/schemas/ProvisionPoliciesRO'
        pathType:
          $ref: '#/components/schemas/PathType1'
        startDate:
          type: string
          description: The scheduled start date and time of the expectation, with RFC 3339 date-time format
        endDate:
          type: string
          description: The scheduled end date and time of the expectation, with RFC 3339 date-time format
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
        recurrenceRule:
          $ref: '#/components/schemas/RecurrenceRuleRO'
        policies:
          type: array
          items:
            type: object
          description: Policies to be applied to the entity.
        userLabel:
          type: string
          description: The label given to the FRE by an user
        mgmtName:
          type: string
          description: The name given to the FRE on the NE where applicable (e.g. VS name for SAOS based devices)
        nativeName:
          type: string
          description: The name of the FRE that is native to the network element
        awarenessTime:
          type: string
          description: The awareness time provided by Stitcher
        originEventTime:
          type: string
          description: The origin event time provided by RA for nodal FREs
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        layerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        supportedByLayerRatePackageList:
          type: array
          items:
            $ref: '#/components/schemas/SupportedByLayerRatePackageRO'
          description: Optional package. Indicates LayerRate and LayerRateQualifier
        serviceClassQualifier:
          $ref: '#/components/schemas/ServiceClassQualifier'
        multiHighestStackLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        internalStructure:
          $ref: '#/components/schemas/InternalStructure'
        networkRole:
          $ref: '#/components/schemas/NetworkRole'
        directionality:
          $ref: '#/components/schemas/Directionality'
        topologySources:
          type: array
          items:
            $ref: '#/components/schemas/TopologySource'
          description: Source of topology
        state:
          $ref: '#/components/schemas/State6'
        adminState:
          $ref: '#/components/schemas/AdminState6'
        controlActivityState:
          $ref: '#/components/schemas/ControlActivityState'
        signalContentType:
          type: string
          description: Represents whether the FRE is of VLAN/VCE type for L2 devices
        modelType:
          $ref: '#/components/schemas/ModelType'
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        photonicSpectrumPackage:
          $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
        photonicSpectrumPackageList:
          type: array
          items:
            $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
          description: ''
        cfmPackages:
          type: array
          items:
            $ref: '#/components/schemas/FreCfmPackageRO'
          description: Holds data related to CFM services configured on an Ethernet service
        segmentId:
          type: string
          description: The segment ID associated with this FRE.
        mplsPackage:
          $ref: '#/components/schemas/MplsPackageRO'
        freType:
          $ref: '#/components/schemas/FreType'
        routingConstraints:
          $ref: '#/components/schemas/RoutingConstraintsRO'
        maxReservableBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/PlannedBandwidthRO'
          description: ''
        nonPlannedUsedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/PlannedBandwidthRO'
          description: ''
        explicitRouteGroup:
          $ref: '#/components/schemas/ExplicitRouteGroupRO'
        active:
          type: boolean
          description: An indicator to flag when a FRE is active, or simply a potential.
          default: false
        controlPlanePackage:
          $ref: '#/components/schemas/ControlPlanePackageRO'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition this fre belongs to.
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/SyncScopeRO'
          description: The sync scope for the FRE
        provisioningAttributes:
          type: object
        stitchingFloorActive:
          type: boolean
          description: An indicator to flag when a FRE should not have stitched client FREs.
          default: false
        reliability:
          $ref: '#/components/schemas/Reliability'
        isInConflict:
          type: boolean
          description: An indicator to flag when a FRE is in conflict with other FREs.
          default: false
        isStandaloneFre:
          type: boolean
          description: An indicator that no fre is stitched over PHY layer.
          default: false
        description:
          type: string
          description: String to store description field on service
        resiliencyHandlingPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyHandlingPackageRO'
          description: triggers stitcher building resiliency view and NSI updating layerRate in resiliency view
        resiliencyPackage:
          $ref: '#/components/schemas/FreResiliencyPackageRO'
        adminWt:
          type: number
          description: Administrative weight which specifies the level of importance given to the OSRP link
        bundleIds:
          type: array
          items:
            type: string
          description: List of up to 20 protection bundles to which the OSRP link belongs
        latency:
          type: number
          description: Indicates the delay in microseconds.
        domainTypes:
          type: array
          items:
            type: string
          description: List of domains/protection scheme this FRE is included in.
        resilienceLevel:
          $ref: '#/components/schemas/ResilienceLevel'
        retainedMaxReservableBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared SRLGs of this FRE.
        resiliencyTopologyPackage:
          $ref: '#/components/schemas/ResiliencyTopologyPackageRO'
        bgpPackage:
          $ref: '#/components/schemas/FreBgpPackageRO'
        gneSubnetName:
          type: string
          description: The GNE Subnet Name of the FRE
        groupPackage:
          $ref: '#/components/schemas/GroupPackageRO'
        txInfo:
          type: array
          items:
            $ref: '#/components/schemas/TxInfoRO'
          description: TxInfo for FRE
        vrfPackage:
          $ref: '#/components/schemas/FreVrfPackageRO'
        remoteOSRPNodeName:
          type: string
          description: Destination OSRP node name
        serviceClass:
          $ref: '#/components/schemas/ServiceClass'
        utilizationData:
          $ref: '#/components/schemas/UtilizationDataRO'
        otdrPackage:
          $ref: '#/components/schemas/OtdrPackageRO'
        externalRoutePackage:
          $ref: '#/components/schemas/ExternalRoutePackageRO'
        evpn:
          $ref: '#/components/schemas/EvpnRO'
        srTePolicyPackage:
          $ref: '#/components/schemas/FreSrTePolicyPackageRO'
        vpnPackage:
          $ref: '#/components/schemas/VpnPackageRO'
        isSubmarineLink:
          type: boolean
          description: An indicator if the FRE is from submarine
          default: false
    FreExpectationDataRO:
      title: FreExpectationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the fre expectation
        type:
          $ref: '#/components/schemas/Type88'
        attributes:
          $ref: '#/components/schemas/FreExpectationAttributesRO'
        relationships:
          $ref: '#/components/schemas/FreExpectationRelationshipsRO'
    FreExpectationRO:
      title: FreExpectationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FreExpectationDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    FreExpectationRelationshipsRO:
      title: FreExpectationRelationshipsRO
      type: object
      properties:
        serviceIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        intent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partitioningFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        endPoints:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partitionFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        decomposedFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        freSwitch:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partitionFreAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        resiliencyController:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        encapsulatedResiliency:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        freSwitchList:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstructAssociation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        groups:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        configurationAndSwitchControl:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        composingFre:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        decomposedFreAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concreteAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        supportedByServices:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        abstractServices:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        utilization:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    FrePatchOperationRO:
      title: FrePatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op11'
        attributes:
          $ref: '#/components/schemas/FreAttributesRO'
        attribute:
          type: string
          description: name of an attribute to be deleted
        path:
          type: string
          description: path of the object/attribute to be patched
        keys:
          type: array
          items:
            type: string
          description: Used to target specific key(s) of the attribute to be deleted
        srlgRelationships:
          $ref: '#/components/schemas/SrlgPatchDataRO'
    FrePatchRO:
      title: FrePatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/FrePatchOperationRO'
          description: ''
    FrePlannedAttributesRO:
      title: FrePlannedAttributesRO
      type: object
      properties:
        userLabel:
          type: string
          description: The label given to the FRE by an user
        mgmtName:
          type: string
          description: The name given to the FRE on the NE where applicable (e.g. VS name for SAOS based devices)
        nativeName:
          type: string
          description: The name of the FRE that is native to the network element
        awarenessTime:
          type: string
          description: The awareness time provided by Stitcher
        originEventTime:
          type: string
          description: The origin event time provided by RA for nodal FREs
        layerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        layerRateQualifier:
          $ref: '#/components/schemas/AdaptsToLayerRateQualifier'
        supportedByLayerRatePackageList:
          type: array
          items:
            $ref: '#/components/schemas/SupportedByLayerRatePackageRO'
          description: Optional package. Indicates LayerRate and LayerRateQualifier
        serviceClassQualifier:
          $ref: '#/components/schemas/ServiceClassQualifier'
        multiHighestStackLayerRate:
          $ref: '#/components/schemas/AdaptsToLayerRate2'
        internalStructure:
          $ref: '#/components/schemas/InternalStructure'
        networkRole:
          $ref: '#/components/schemas/NetworkRole'
        directionality:
          $ref: '#/components/schemas/Directionality'
        topologySources:
          type: array
          items:
            $ref: '#/components/schemas/TopologySource'
          description: Source of topology
        state:
          $ref: '#/components/schemas/State6'
        adminState:
          $ref: '#/components/schemas/AdminState6'
        controlActivityState:
          $ref: '#/components/schemas/ControlActivityState'
        signalContentType:
          type: string
          description: Represents whether the FRE is of VLAN/VCE type for L2 devices
        modelType:
          $ref: '#/components/schemas/ModelType'
        lifeCycleRules:
          $ref: '#/components/schemas/LifeCycleRuleRO'
        photonicSpectrumPackage:
          $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
        photonicSpectrumPackageList:
          type: array
          items:
            $ref: '#/components/schemas/PhotonicSpectrumPackageRO'
          description: ''
        cfmPackages:
          type: array
          items:
            $ref: '#/components/schemas/FreCfmPackageRO'
          description: Holds data related to CFM services configured on an Ethernet service
        segmentId:
          type: string
          description: The segment ID associated with this FRE.
        mplsPackage:
          $ref: '#/components/schemas/MplsPackageRO'
        freType:
          $ref: '#/components/schemas/FreType'
        routingConstraints:
          $ref: '#/components/schemas/RoutingConstraintsRO'
        maxReservableBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        usedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        plannedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/PlannedBandwidthRO'
          description: ''
        nonPlannedUsedBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/PlannedBandwidthRO'
          description: ''
        explicitRouteGroup:
          $ref: '#/components/schemas/ExplicitRouteGroupRO'
        active:
          type: boolean
          description: An indicator to flag when a FRE is active, or simply a potential.
          default: false
        controlPlanePackage:
          $ref: '#/components/schemas/ControlPlanePackageRO'
        additionalAttributes:
          type: object
        resourcePartitionInfo:
          uniqueItems: true
          type: array
          items:
            type: string
          description: It represents which partition this fre belongs to.
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/SyncScopeRO'
          description: The sync scope for the FRE
        provisioningAttributes:
          type: object
        stitchingFloorActive:
          type: boolean
          description: An indicator to flag when a FRE should not have stitched client FREs.
          default: false
        reliability:
          $ref: '#/components/schemas/Reliability'
        isInConflict:
          type: boolean
          description: An indicator to flag when a FRE is in conflict with other FREs.
          default: false
        isStandaloneFre:
          type: boolean
          description: An indicator that no fre is stitched over PHY layer.
          default: false
        description:
          type: string
          description: String to store description field on service
        resiliencyHandlingPackage:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyHandlingPackageRO'
          description: triggers stitcher building resiliency view and NSI updating layerRate in resiliency view
        resiliencyPackage:
          $ref: '#/components/schemas/FreResiliencyPackageRO'
        adminWt:
          type: number
          description: Administrative weight which specifies the level of importance given to the OSRP link
        bundleIds:
          type: array
          items:
            type: string
          description: List of up to 20 protection bundles to which the OSRP link belongs
        latency:
          type: number
          description: Indicates the delay in microseconds.
        domainTypes:
          type: array
          items:
            type: string
          description: List of domains/protection scheme this FRE is included in.
        resilienceLevel:
          $ref: '#/components/schemas/ResilienceLevel'
        retainedMaxReservableBandwidth:
          type: array
          items:
            $ref: '#/components/schemas/CapacityRO'
          description: ''
        srlg:
          type: array
          items:
            type: string
          description: Shared risk link group is used by the path computation engine to ensure that the alternate links involved in a service do not share the same shared risk link group.
        shareSrlg:
          type: array
          items:
            type: string
          description: Shared SRLGs of this FRE.
        resiliencyTopologyPackage:
          $ref: '#/components/schemas/ResiliencyTopologyPackageRO'
        bgpPackage:
          $ref: '#/components/schemas/FreBgpPackageRO'
        gneSubnetName:
          type: string
          description: The GNE Subnet Name of the FRE
        groupPackage:
          $ref: '#/components/schemas/GroupPackageRO'
        txInfo:
          type: array
          items:
            $ref: '#/components/schemas/TxInfoRO'
          description: TxInfo for FRE
        vrfPackage:
          $ref: '#/components/schemas/FreVrfPackageRO'
        remoteOSRPNodeName:
          type: string
          description: Destination OSRP node name
        serviceClass:
          $ref: '#/components/schemas/ServiceClass'
        utilizationData:
          $ref: '#/components/schemas/UtilizationDataRO'
        otdrPackage:
          $ref: '#/components/schemas/OtdrPackageRO'
        externalRoutePackage:
          $ref: '#/components/schemas/ExternalRoutePackageRO'
        evpn:
          $ref: '#/components/schemas/EvpnRO'
        srTePolicyPackage:
          $ref: '#/components/schemas/FreSrTePolicyPackageRO'
        vpnPackage:
          $ref: '#/components/schemas/VpnPackageRO'
        isSubmarineLink:
          type: boolean
          description: An indicator if the FRE is from submarine
          default: false
    FrePlannedDataRO:
      title: FrePlannedDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the planned fre
        type:
          $ref: '#/components/schemas/Type89'
        attributes:
          $ref: '#/components/schemas/FrePlannedAttributesRO'
        relationships:
          $ref: '#/components/schemas/FrePlannedRelationshipsRO'
    FrePlannedRO:
      title: FrePlannedRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FrePlannedDataRO'
        included:
          type: array
          items:
            type: object
          description: Side loaded relationship resources
    FrePlannedRelationshipsRO:
      title: FrePlannedRelationshipsRO
      type: object
      properties:
        serviceIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentIntent:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        manualSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicAutoSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicInheritedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicPropagatedSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        manualShareSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        dynamicPropagatedShareSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        writableToNetworkSRLG:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        endPoints:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partitionFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        decomposedFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        freSwitch:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        partitionFreAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concrete:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        resiliencyController:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        encapsulatedResiliency:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        freSwitchList:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        networkConstructAssociation:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        srlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        shareSrlg:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        groups:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        configurationAndSwitchControl:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        partitioningFres:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        composingFre:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        decomposedFreAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        concreteAssociations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        supportedByServices:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        abstractServices:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        utilization:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
    FreProvisioningOperationAttributesRO:
      title: FreProvisioningOperationAttributesRO
      type: object
      properties:
        operation:
          $ref: '#/components/schemas/Operation1'
        state:
          $ref: '#/components/schemas/State23'
        inProvRealizations:
          type: array
          items:
            $ref: '#/components/schemas/FreProvisioningRealizationRO'
          description: The object to be provisioned in the device
    FreProvisioningOperationDataRO:
      title: FreProvisioningOperationDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the FreProvisioningOperation
        type:
          $ref: '#/components/schemas/Type90'
        attributes:
          $ref: '#/components/schemas/FreProvisioningOperationAttributesRO'
        relationships:
          $ref: '#/components/schemas/FreProvisioningRelationshipsRO'
    FreProvisioningOperationRO:
      title: FreProvisioningOperationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FreProvisioningOperationDataRO'
    FreProvisioningRealizationRO:
      title: FreProvisioningRealizationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op12'
        subOp:
          $ref: '#/components/schemas/SubOp'
        equipments:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentRO'
          description: ''
        tpes:
          type: array
          items:
            $ref: '#/components/schemas/TpeRO'
          description: ''
        fres:
          type: array
          items:
            $ref: '#/components/schemas/FreRO'
          description: ''
    FreProvisioningRelationshipsRO:
      title: FreProvisioningRelationshipsRO
      type: object
      properties:
        freExpectations:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    ProvisionPoliciesRO:
      title: ProvisionPoliciesRO
      type: object
      properties:
        endPointPolicy:
          $ref: '#/components/schemas/EndPointPolicy'
    CleanUp:
      title: CleanUp
      type: object
      properties:
        sizethreshold:
          type: number
          description: The size threshold in MB for cleanup of backup directory
    DiskSize:
      title: DiskSize
      type: object
      properties:
        level:
          $ref: '#/components/schemas/Level1'
    KafkaUp:
      title: KafkaUp
      type: object
      properties:
        level:
          $ref: '#/components/schemas/Level2'
    PithosUp:
      title: PithosUp
      type: object
      properties:
        level:
          $ref: '#/components/schemas/Level3'
    CoordinateNvp:
      title: CoordinateNvp
      type: object
      properties:
        x:
          type: number
        y:
          type: number
        z:
          type: number
    CoordinateRO:
      title: CoordinateRO
      type: object
      properties:
        coordinateNvp:
          $ref: '#/components/schemas/CoordinateNvp'
    DimensionNvp:
      title: DimensionNvp
      type: object
      properties:
        width:
          type: number
        height:
          type: number
        depth:
          type: number
        offsetX:
          type: number
    DimensionRO:
      title: DimensionRO
      type: object
      properties:
        dimensionNvp:
          $ref: '#/components/schemas/DimensionNvp'
    EquipmentGraphicAttributesRO:
      title: EquipmentGraphicAttributesRO
      type: object
      properties:
        eqpType:
          $ref: '#/components/schemas/EquipmentLayoutRO'
        layoutId:
          type: object
        cardType:
          type: object
        location:
          $ref: '#/components/schemas/LocationRO'
        isPluggable:
          type: boolean
          default: false
        neName:
          type: string
        slotWidth:
          type: number
        slotHeight:
          type: number
        nativeName:
          type: string
        inventoryEquipmentId:
          type: string
        displayNameFormat:
          type: string
        accessIdentifier:
          type: string
        alarmMatchableAID:
          type: string
        partNumber:
          type: string
        installedPartNumber:
          type: string
        provisionedPartNumber:
          type: string
        isMismatch:
          type: boolean
          default: false
        ncId:
          type: string
        epqId:
          type: string
        pattern:
          type: string
        physicalLocations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
        state:
          $ref: '#/components/schemas/State23'
        version:
          type: string
        availabilityState:
          $ref: '#/components/schemas/AvailabilityState3'
        serialNumber:
          type: string
        ledsInfo:
          type: array
          items:
            type: string
          description: ''
        subEquipmentGraphics:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentGraphicRO'
          description: ''
        planningStatus:
          type: string
        description:
          type: string
        siteId:
          type: string
        siteName:
          type: string
        groupId:
          type: string
        defaultPanel:
          type: string
        additionalAttributes:
          type: object
    EquipmentGraphicDataRO:
      title: EquipmentGraphicDataRO
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type92'
        attributes:
          $ref: '#/components/schemas/EquipmentGraphicAttributesRO'
        relationships:
          $ref: '#/components/schemas/EquipmentGraphicRelationshipsRO'
    EquipmentGraphicListRO:
      title: EquipmentGraphicListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentGraphicDataRO'
          description: ''
    EquipmentGraphicRO:
      title: EquipmentGraphicRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentGraphicDataRO'
    EquipmentGraphicRelationshipsRO:
      title: EquipmentGraphicRelationshipsRO
      type: object
      properties:
        equipmentLayout:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        subEquipmentGraphics:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    EquipmentLayoutAttributesRO:
      title: EquipmentLayoutAttributesRO
      type: object
      properties:
        labels:
          type: array
          items:
            $ref: '#/components/schemas/LabelRO'
          description: ''
        equipmentType:
          type: string
        isZoomSupported:
          type: boolean
          default: false
        newLayout:
          type: boolean
          default: false
        backViewGap:
          type: number
        useEquipmentAlarmIndicatorBox:
          type: boolean
          default: false
        locationType:
          $ref: '#/components/schemas/LocationType'
        equipmentSubtype:
          type: string
        dimensions:
          $ref: '#/components/schemas/DimensionRO'
        equipmentHolders:
          type: array
          items:
            $ref: '#/components/schemas/SlotLayoutRO'
          description: ''
        imageFile:
          type: string
        showPortBorders:
          type: boolean
          default: false
        fill:
          type: string
        ports:
          type: array
          items:
            $ref: '#/components/schemas/PortLayoutRO'
          description: ''
        leds:
          type: array
          items:
            $ref: '#/components/schemas/LEDLayoutRO'
          description: ''
    EquipmentLayoutDataRO:
      title: EquipmentLayoutDataRO
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type91'
        attributes:
          $ref: '#/components/schemas/EquipmentLayoutAttributesRO'
        relationships:
          type: object
    EquipmentLayoutListRO:
      title: EquipmentLayoutListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentLayoutDataRO'
          description: ''
    EquipmentLayoutRO:
      title: EquipmentLayoutRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EquipmentLayoutDataRO'
    LEDLayoutRO:
      title: LEDLayoutRO
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        location:
          $ref: '#/components/schemas/CoordinateRO'
        ledType:
          type: string
        ledShape:
          type: string
        dimensions:
          $ref: '#/components/schemas/DimensionRO'
        imageFile:
          type: string
    LabelRO:
      title: LabelRO
      type: object
      properties:
        dimensions:
          $ref: '#/components/schemas/DimensionRO'
        location:
          $ref: '#/components/schemas/CoordinateRO'
        text:
          type: string
        fontSize:
          type: number
        fontStyle:
          type: string
        fontWeight:
          type: string
        imageFile:
          type: string
        border:
          type: boolean
          default: false
        labelOffset:
          $ref: '#/components/schemas/CoordinateRO'
    PortLayoutRO:
      title: PortLayoutRO
      type: object
      properties:
        id:
          type: string
        fontSize:
          type: number
        fixedDescription:
          type: string
        fontStyle:
          type: string
        fontWeight:
          type: string
        pattern:
          type: string
        hideLabel:
          type: boolean
          default: false
        useRelatedPlugEquipmentPattern:
          type: boolean
          default: false
        label:
          type: string
        labelOffset:
          $ref: '#/components/schemas/CoordinateRO'
        connectorType:
          type: string
        isHoverable:
          type: boolean
          default: false
        isSelectable:
          type: boolean
          default: false
        dimensions:
          $ref: '#/components/schemas/DimensionRO'
        location:
          $ref: '#/components/schemas/CoordinateRO'
        imageFileFilled:
          type: string
        emptyImageFileFilled:
          type: string
        imageFileEmpty:
          type: string
    ShelfGraphicAttributesRO:
      title: ShelfGraphicAttributesRO
      type: object
      properties:
        neName:
          type: string
        accessIdentifier:
          type: string
        ipAddress:
          type: string
        layoutId:
          type: object
        combinedAlarmPatternOfMemberShelves:
          type: object
        inventoryEquipmentId:
          type: string
        partNumber:
          type: string
        ncId:
          type: string
        managementSessionNcId:
          type: string
        geoLocation:
          $ref: '#/components/schemas/GeoLocationRO'
        serialNumber:
          type: string
        state:
          $ref: '#/components/schemas/State23'
        equipmentGraphics:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentGraphicRO'
          description: ''
        resourceType:
          type: string
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
        planningStatus:
          type: string
        description:
          type: string
        contactStatus:
          type: string
        version:
          type: string
        siteId:
          type: string
        siteName:
          type: string
        pattern:
          type: string
        additionalAttributes:
          type: object
        physicalLocations:
          type: array
          items:
            $ref: '#/components/schemas/LocationRO'
          description: ''
    ShelfGraphicDataRO:
      title: ShelfGraphicDataRO
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type93'
        attributes:
          $ref: '#/components/schemas/ShelfGraphicAttributesRO'
        relationships:
          $ref: '#/components/schemas/ShelfGraphicRelationshipsRO'
    ShelfGraphicListRO:
      title: ShelfGraphicListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ShelfGraphicDataRO'
          description: ''
    ShelfGraphicRelationshipsRO:
      title: ShelfGraphicRelationshipsRO
      type: object
      properties:
        shelfLayout:
          $ref: '#/components/schemas/OneToOneRelationshipRO'
        equipmentGraphics:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    ShelfLayoutAttributesRO:
      title: ShelfLayoutAttributesRO
      type: object
      properties:
        label:
          type: string
        shelfType:
          type: string
        normalScale:
          type: number
        containsPatternDelimitter:
          type: string
        newLayout:
          type: boolean
          default: false
        isXCVRInfoSupported:
          type: boolean
          default: false
        backViewGap:
          type: number
        isZoomSupported:
          type: boolean
          default: false
        containsAlarmResourceId:
          type: boolean
          default: false
        showIndependentNames:
          type: boolean
          default: false
        defaultDimensions:
          $ref: '#/components/schemas/DimensionRO'
        dimensions:
          $ref: '#/components/schemas/DimensionRO'
        reardimensions:
          $ref: '#/components/schemas/DimensionRO'
        partNumber:
          type: string
        subshelves:
          type: array
          items:
            $ref: '#/components/schemas/SubshelfLayoutRO'
          description: ''
        rearSubshelves:
          type: array
          items:
            $ref: '#/components/schemas/SubshelfLayoutRO'
          description: ''
        equipmentHolders:
          type: array
          items:
            $ref: '#/components/schemas/SlotLayoutRO'
          description: ''
        imageFile:
          type: string
        ports:
          type: array
          items:
            $ref: '#/components/schemas/PortLayoutRO'
          description: ''
    ShelfLayoutDataRO:
      title: ShelfLayoutDataRO
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type94'
        attributes:
          $ref: '#/components/schemas/ShelfLayoutAttributesRO'
        relationships:
          type: object
    ShelfLayoutListRO:
      title: ShelfLayoutListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ShelfLayoutDataRO'
          description: ''
    SlotLayoutRO:
      title: SlotLayoutRO
      type: object
      properties:
        id:
          type: string
        nativeId:
          type: string
        labels:
          type: array
          items:
            $ref: '#/components/schemas/LabelRO'
          description: ''
        equipmentHolderType:
          type: string
        dimensions:
          $ref: '#/components/schemas/DimensionRO'
        location:
          $ref: '#/components/schemas/CoordinateRO'
        equipmentHolders:
          type: array
          items:
            $ref: '#/components/schemas/SlotLayoutRO'
          description: ''
        imageFile:
          type: string
        equipmentRotation:
          type: number
        layoutId:
          type: string
    SubshelfLayoutRO:
      title: SubshelfLayoutRO
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        subshelfType:
          type: string
        pattern:
          type: string
        subshelfStrokeWidth:
          type: number
        dimensions:
          $ref: '#/components/schemas/DimensionRO'
        location:
          $ref: '#/components/schemas/CoordinateRO'
        subshelves:
          type: array
          items:
            $ref: '#/components/schemas/SubshelfLayoutRO'
          description: ''
        equipmentHolders:
          type: array
          items:
            $ref: '#/components/schemas/SlotLayoutRO'
          description: ''
        fill:
          type: string
        imageFile:
          type: string
        ports:
          type: array
          items:
            $ref: '#/components/schemas/PortLayoutRO'
          description: ''
    AssociatedResourceData:
      title: AssociatedResourceData
      type: object
      properties:
        id:
          type: string
          description: An explanation about the purpose of this instance.
        type:
          type: string
          description: An explanation about the purpose of this instance.
        attributes:
          $ref: '#/components/schemas/AssociatedResourceDataAttributes'
    AssociatedResourceDataAttributes:
      title: AssociatedResourceDataAttributes
      type: object
      properties:
        resourceId:
          type: string
          description: An explanation about the purpose of this instance.
        resourceName:
          type: string
          description: An explanation about the purpose of this instance.
        resourceType:
          type: string
          description: An explanation about the purpose of this instance.
        resourceSubType:
          type: string
          description: An explanation about the purpose of this instance.
        resourceDisplaySubType:
          type: string
          description: An explanation about the purpose of this instance.
        owningNetworkConstruct:
          type: string
          description: An explanation about the purpose of this instance.
        layerRate:
          type: string
          description: An explanation about the purpose of this instance.
        layerRateQualifier:
          type: string
          description: An explanation about the purpose of this instance.
        directionality:
          type: string
          description: An explanation about the purpose of this instance.
        srlgSource:
          type: array
          items:
            type: string
          description: An explanation about the purpose of this instance.
        endPoints:
          type: array
          items:
            $ref: '#/components/schemas/ResourceEndpointAttributes'
          description: An explanation about the purpose of this instance.
    AssociatedSrlgData:
      title: AssociatedSrlgData
      type: object
      properties:
        id:
          type: string
          description: An explanation about the purpose of this instance.
        type:
          type: string
          description: An explanation about the purpose of this instance.
        attributes:
          $ref: '#/components/schemas/AssociatedSrlgDataAttributes'
    AssociatedSrlgDataAttributes:
      title: AssociatedSrlgDataAttributes
      type: object
      properties:
        srlgValue:
          type: string
          description: An explanation about the purpose of this instance.
        structuredSrlg:
          type: object
        srlgSource:
          type: array
          items:
            type: string
          description: An explanation about the purpose of this instance.
        writableToNetwork:
          type: string
          description: Indicates if this srlg value is going to be pushed on the network. Possible values are yes/no
        srlgMismatch:
          type: boolean
          description: Indicates if the srlg values is resultant in mismatch on planned and dicovered Srlg.
          default: false
        endPointSrlgSources:
          type: array
          items:
            $ref: '#/components/schemas/EndPointSrlgSource'
          description: An explanation about the purpose of this instance.
    AssociatedSrlgsResponse:
      title: AssociatedSrlgsResponse
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/AssociatedSrlgData'
          description: ''
    AuditReconcileAttributeV2:
      title: AuditReconcileAttributeV2
      type: object
      properties:
        attribute_name:
          type: string
          description: attribute name
        expectedValue:
          type: array
          items:
            type: string
          description: expected values
        actualValue:
          type: array
          items:
            type: string
          description: actual values
        isCorrected:
          type: boolean
          description: if reconciled
          default: false
    Bucket:
      title: Bucket
      type: object
      properties:
        bucketKey:
          type: string
          description: An explanation about the purpose of this instance.
        bucketValue:
          type: string
          description: An explanation about the purpose of this instance.
    EndPointSrlgDetails:
      title: EndPointSrlgDetails
      type: object
      properties:
        tpeId:
          type: string
        owningNetworkConstruct:
          type: string
        discoveredSrlgs:
          type: array
          items:
            type: string
          description: ''
    EndPointSrlgSource:
      title: EndPointSrlgSource
      type: object
      properties:
        tpeDetails:
          $ref: '#/components/schemas/TpeDetails'
        srlgSource:
          type: array
          items:
            type: string
          description: An explanation about the purpose of this instance.
    ExternalSrlg:
      title: ExternalSrlg
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExternalSrlgData'
    ExternalSrlgAttributes:
      title: ExternalSrlgAttributes
      type: object
      properties:
        label:
          type: string
          description: Label.
        srlg:
          type: string
          description: Srlg Value.
        srlgStructured:
          type: object
    ExternalSrlgData:
      title: ExternalSrlgData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of SRLG.
        type:
          type: string
          description: Operation type.
        attributes:
          $ref: '#/components/schemas/ExternalSrlgAttributes'
    ExternalSrlgLinks:
      title: ExternalSrlgLinks
      type: object
      properties:
        next:
          type: string
          description: Next Page of Data
        current:
          type: string
          description: Current Page of Data
    ExternalSrlgList:
      title: ExternalSrlgList
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ExternalSrlgMetaData'
        links:
          $ref: '#/components/schemas/ExternalSrlgLinks'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExternalSrlgData'
          description: An array of SRLG Data
    ExternalSrlgMetaData:
      title: ExternalSrlgMetaData
      type: object
      properties:
        total:
          type: integer
          description: The total number of entities in the data
          format: int32
    ExternalSrlgPoolRequest:
      title: ExternalSrlgPoolRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExternalSrlgPoolRequestData'
    ExternalSrlgPoolRequestAttributes:
      title: ExternalSrlgPoolRequestAttributes
      type: object
      properties:
        label:
          type: string
          description: Label.
        id:
          type: string
          description: Id of Srlg to be released
        srlgFields:
          type: object
    ExternalSrlgPoolRequestData:
      title: ExternalSrlgPoolRequestData
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op13'
        type:
          $ref: '#/components/schemas/Type95'
        attributes:
          $ref: '#/components/schemas/ExternalSrlgPoolRequestAttributes'
    ExternalSrlgPoolResetResponse:
      title: ExternalSrlgPoolResetResponse
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of SRLG operation
        jobType:
          $ref: '#/components/schemas/JobType'
        attributes:
          $ref: '#/components/schemas/ExternalSrlgPoolResetResponseAttributes'
    ExternalSrlgPoolResetResponseAttributes:
      title: ExternalSrlgPoolResetResponseAttributes
      type: object
      properties:
        status:
          type: string
          description: Status.
        startTime:
          type: string
          description: Start Time.
    FbProfileAuditDetailsV2:
      title: FbProfileAuditDetailsV2
      type: object
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/AuditReconcileAttributeV2'
          description: audit/reconcile details
    FbProfileOpAttributes:
      title: FbProfileOpAttributes
      type: object
      properties:
        attributeName:
          type: string
        expectedValue:
          type: array
          items:
            type: string
          description: ''
        actualValue:
          type: array
          items:
            type: string
          description: ''
        corrected:
          type: boolean
          default: false
    FbProfileOpDetails:
      title: FbProfileOpDetails
      type: object
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/FbProfileOpAttributes'
          description: ''
    MismatchResource:
      title: MismatchResource
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/MismatchResourceAttributes'
    MismatchResourceAttributes:
      title: MismatchResourceAttributes
      type: object
      properties:
        resourceType:
          type: string
        resourceId:
          type: string
        resourceName:
          type: string
        resourceDesc:
          type: string
    MismatchResourceV2:
      title: MismatchResourceV2
      type: object
      properties:
        resourceType:
          type: string
        resourceId:
          type: string
        resourceName:
          type: string
        resourceDesc:
          type: string
        owningNcId:
          type: string
        discoveredSrlgs:
          type: array
          items:
            type: string
          description: ''
        plannedSrlgs:
          type: array
          items:
            type: string
          description: ''
    ResourceEndpointAttributes:
      title: ResourceEndpointAttributes
      type: object
      properties:
        id:
          type: string
          description: An explanation about the purpose of this instance.
        tpeDetailsList:
          type: array
          items:
            $ref: '#/components/schemas/TpeDetails'
          description: An explanation about the purpose of this instance.
    ShareSrlgResourceReferenceV2:
      title: ShareSrlgResourceReferenceV2
      type: object
      properties:
        resourceType:
          $ref: '#/components/schemas/ResourceType'
        resourceName:
          type: string
          description: Name of the resource
        resourceId:
          type: string
          description: Resource id of the resource
    SrlgAllowedJobAttributes:
      title: SrlgAllowedJobAttributes
      type: object
      properties:
        job_id:
          type: string
          description: Job id, which will be used in other request payloads
        job_name:
          type: string
          description: Name of Job to be displayed on UI
    SrlgAssignedResourcesListV2:
      title: SrlgAssignedResourcesListV2
      type: object
      properties:
        assignedResources:
          type: array
          items:
            $ref: '#/components/schemas/SrlgAssignedResourcesV2'
          description: ''
    SrlgAssignedResourcesV2:
      title: SrlgAssignedResourcesV2
      type: object
      properties:
        resourceType:
          type: string
        resourceIds:
          type: array
          items:
            type: string
          description: ''
    SrlgAssignmentDetailsResponse:
      title: SrlgAssignmentDetailsResponse
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/AssociatedResourceData'
          description: ''
    SrlgIntentRequest:
      title: SrlgIntentRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgIntentRequestData'
    SrlgIntentRequestAttributes:
      title: SrlgIntentRequestAttributes
      type: object
      properties:
        resourceId:
          type: string
          description: The resource id (fre-id) of the roadmline
        resourceName:
          type: string
          description: Resource name (label) of the roadmline
        resourceType:
          $ref: '#/components/schemas/ResourceType2'
        srlgSet:
          type: array
          items:
            $ref: '#/components/schemas/SrlgSet'
          description: Srlg set
    SrlgIntentRequestAttributesV2:
      title: SrlgIntentRequestAttributesV2
      type: object
      properties:
        resourceId:
          type: string
          description: Resource id of the resource
        resourceName:
          type: string
          description: Resource name of the resource
        resourceType:
          $ref: '#/components/schemas/ResourceType'
        srlgSet:
          type: array
          items:
            $ref: '#/components/schemas/SrlgSetV2'
          description: Represents the SRLG set. Can be either combined/auto/manual/inherited/propagated/discovered/manualShare/propagatedShare/combinedShare depending on the parent container
    SrlgIntentRequestData:
      title: SrlgIntentRequestData
      type: object
      properties:
        id:
          type: string
          description: UUID rep
        requestType:
          type: string
          description: type of request
        attributes:
          $ref: '#/components/schemas/SrlgIntentRequestAttributes'
    SrlgIntentRequestDataV2:
      title: SrlgIntentRequestDataV2
      type: object
      properties:
        id:
          type: string
        attributes:
          $ref: '#/components/schemas/SrlgIntentRequestAttributesV2'
    SrlgIntentRequestV2:
      title: SrlgIntentRequestV2
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgIntentRequestDataV2'
    SrlgIntentResponseAttributesV3:
      title: SrlgIntentResponseAttributesV3
      type: object
      properties:
        resourceId:
          type: string
          description: Resource id of the resource
        resourceName:
          type: string
          description: Resource name of the resource
        resourceType:
          $ref: '#/components/schemas/ResourceType4'
        srlgSet:
          type: array
          items:
            $ref: '#/components/schemas/SrlgSetV2'
          description: Represents the SRLG set. Can be either combined/auto/manual/inherited/propagated/discovered/manualShare/propagatedShare/combinedShare depending on the parent container
    SrlgIntentResponseDataV3:
      title: SrlgIntentResponseDataV3
      type: object
      properties:
        id:
          type: string
        attributes:
          $ref: '#/components/schemas/SrlgIntentResponseAttributesV3'
    SrlgIntentResponseV3:
      title: SrlgIntentResponseV3
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgIntentResponseDataV3'
    SrlgJobAttributes:
      title: SrlgJobAttributes
      type: object
      properties:
        jobType:
          $ref: '#/components/schemas/JobType'
        jobId:
          type: string
          description: Id of the operation
        jobParams:
          type: object
        status:
          type: string
          description: Current status of the operation.
        startTime:
          type: string
          description: Start time of the operation
        endTime:
          type: string
          description: End time of the operation
        message:
          type: string
          description: Id of the operation
        scheduleId:
          type: string
          description: Id of the schedule
        scheduleName:
          type: string
          description: Name of the schedule
        scopeType:
          type: string
          description: It can have two values, Network or Region.
        scopeValue:
          type: string
          description: This value must be present if scope is other than Network
        jobDetails:
          type: array
          items:
            $ref: '#/components/schemas/SrlgManualJobOpResponseDetails'
          description: Srlg Manual Operations Response Details
    SrlgJobDetailsBO:
      title: SrlgJobDetailsBO
      type: object
      properties:
        resourceType:
          $ref: '#/components/schemas/ResourceType'
        resourceId:
          type: string
        resourceName:
          type: string
        riskType:
          $ref: '#/components/schemas/RiskType'
        opStatus:
          $ref: '#/components/schemas/OpStatus'
        appliedTime:
          type: string
        message:
          type: string
        srlgValue:
          type: string
        userLabel:
          type: string
        owningNcName:
          type: string
        fbProfileName:
          type: string
        fbProfileOpDetails:
          $ref: '#/components/schemas/FbProfileOpDetails'
        resourceDesc:
          type: string
    SrlgJobResponse:
      title: SrlgJobResponse
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SrlgJobResponseData'
          description: Srlg Job Response
    SrlgJobResponseData:
      title: SrlgJobResponseData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the SrlgJob
        type:
          $ref: '#/components/schemas/Type96'
        attributes:
          $ref: '#/components/schemas/SrlgJobAttributes'
    SrlgJobStatusBO:
      title: SrlgJobStatusBO
      type: object
      properties:
        lastTriggeredTime:
          type: string
        endTime:
          type: string
        id:
          type: string
          format: uuid
        srlgJobType:
          $ref: '#/components/schemas/SrlgJobType'
        jobParams:
          type: object
          additionalProperties:
            type: string
        jobDetails:
          type: array
          items:
            $ref: '#/components/schemas/SrlgJobDetailsBO'
          description: ''
        srlgJobStatus:
          $ref: '#/components/schemas/SrlgJobStatus'
        message:
          type: string
        lastUpdateTime:
          type: string
        scheduleId:
          type: string
        scheduleName:
          type: string
        scopeType:
          $ref: '#/components/schemas/ScopeType'
        scopeValue:
          type: string
        scheduled:
          type: boolean
          default: false
    SrlgManualJobDetailsOpResponse:
      title: SrlgManualJobDetailsOpResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgManualJobDetailsOpResponseData'
    SrlgManualJobDetailsOpResponseAttributes:
      title: SrlgManualJobDetailsOpResponseAttributes
      type: object
      properties:
        jobType:
          $ref: '#/components/schemas/JobType'
        status:
          type: string
          description: Current status of the operation.
        startTime:
          type: string
          description: Start time of the operation
        endTime:
          type: string
          description: End time of the operation
        jobId:
          type: string
          description: Id of the operation
        jobParams:
          type: object
        jobDetails:
          type: array
          items:
            $ref: '#/components/schemas/SrlgManualJobOpResponseDetails'
          description: Srlg Manual Operations Response Details
        message:
          type: string
          description: message of operation
    SrlgManualJobDetailsOpResponseData:
      title: SrlgManualJobDetailsOpResponseData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SrlgManualJobDetailsOpResponseAttributes'
    SrlgManualJobOpResponse:
      title: SrlgManualJobOpResponse
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SrlgManualJobOpResponseData'
          description: Srlg Manual Operations Response Data
    SrlgManualJobOpResponseAttributes:
      title: SrlgManualJobOpResponseAttributes
      type: object
      properties:
        jobType:
          $ref: '#/components/schemas/JobType'
        status:
          type: string
          description: Current status of the operation.
        startTime:
          type: string
          description: Start time of the operation
        endTime:
          type: string
          description: End time of the operation
        jobId:
          type: string
          description: Id of the operation
        message:
          type: string
          description: Id of the operation
    SrlgManualJobOpResponseData:
      title: SrlgManualJobOpResponseData
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SrlgManualJobOpResponseAttributes'
    SrlgManualJobOpResponseDetails:
      title: SrlgManualJobOpResponseDetails
      type: object
      properties:
        resourceType:
          type: string
          description: resource type of operation
        resourceId:
          type: string
          description: resource id of operation
        resourceName:
          type: string
          description: resource name of operation
        resourceDesc:
          type: string
          description: resource description of operation
        riskType:
          type: string
          description: risk type of operation
        opStatus:
          type: string
          description: status of operation
        appliedTime:
          type: string
          description: applied time of operation
        message:
          type: string
          description: message of operation
        owningNc:
          type: string
          description: Owning NC name
        fbProfileName:
          type: string
          description: Fb Profile Name
        fbProfileOpDetails:
          $ref: '#/components/schemas/FbProfileAuditDetailsV2'
    SrlgManualOpRequest:
      title: SrlgManualOpRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgManualOpRequestData'
    SrlgManualOpRequestAttributes:
      title: SrlgManualOpRequestAttributes
      type: object
      properties:
        resourceType:
          $ref: '#/components/schemas/ResourceType6'
        riskType:
          type: string
          description: Risk Type.
        resourceId:
          type: string
          description: Resource Id.
        resourceName:
          type: string
          description: Resource Name.
        region:
          type: string
          description: Region
        subNetwork:
          type: string
          description: Subnetwork
        reconcile:
          type: boolean
          description: a value of true indicate reconcile is enabled
          default: false
        opaque:
          type: string
          description: Opaque SRLG
        structured:
          type: object
        resourceTypes:
          type: string
          description: Comma separated Resource Types
    SrlgManualOpRequestData:
      title: SrlgManualOpRequestData
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op13'
        attributes:
          $ref: '#/components/schemas/SrlgManualOpRequestAttributes'
    SrlgMismatchData:
      title: SrlgMismatchData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/SrlgMismatchDataAttributes'
    SrlgMismatchDataAttributes:
      title: SrlgMismatchDataAttributes
      type: object
      properties:
        resourceId:
          type: string
        resourceType:
          type: string
        resourceName:
          type: string
        resourceDesc:
          type: string
        plannedSrlgs:
          type: array
          items:
            type: string
          description: ''
        writableSrlgs:
          type: array
          items:
            type: string
          description: ''
        endPointSrlgs:
          type: array
          items:
            $ref: '#/components/schemas/EndPointSrlgDetails'
          description: ''
    SrlgMismatchDetailsResponse:
      title: SrlgMismatchDetailsResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgMismatchData'
    SrlgMismatchResponse:
      title: SrlgMismatchResponse
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/MetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/MismatchResource'
          description: ''
    SrlgMismatchResponseV2:
      title: SrlgMismatchResponseV2
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MismatchResourceV2'
          description: ''
    SrlgResourceAssignmentDetailsV2:
      title: SrlgResourceAssignmentDetailsV2
      type: object
      properties:
        auto:
          $ref: '#/components/schemas/SrlgAssignedResourcesListV2'
        manual:
          $ref: '#/components/schemas/SrlgAssignedResourcesListV2'
        inherited:
          $ref: '#/components/schemas/SrlgAssignedResourcesListV2'
        propagated:
          $ref: '#/components/schemas/SrlgAssignedResourcesListV2'
        discovered:
          $ref: '#/components/schemas/SrlgAssignedResourcesListV2'
        manualShare:
          $ref: '#/components/schemas/SrlgAssignedResourcesListV2'
        propagatedShare:
          $ref: '#/components/schemas/SrlgAssignedResourcesListV2'
    SrlgResourceResponseDataV2:
      title: SrlgResourceResponseDataV2
      type: object
      properties:
        srlgValue:
          type: string
        assignmentDetails:
          $ref: '#/components/schemas/SrlgResourceAssignmentDetailsV2'
    SrlgResourceResponseV2:
      title: SrlgResourceResponseV2
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgResourceResponseDataV2'
    SrlgScheduleAttributes:
      title: SrlgScheduleAttributes
      type: object
      properties:
        scheduleId:
          type: string
          description: Id of the schedule
        scheduleName:
          type: string
          description: Name of the schedule
        scopeType:
          type: string
          description: It can have two values, Network or Region.
        scopeValue:
          type: string
          description: This value must be present if scope is other than Network
        cronExpression:
          type: string
          description: Cron Expression defining schedule of running provided SRLG jobs.
        cronExpressionFormat:
          type: string
          description: Cron Expression Format, it is generally Quartz
        cronDescription:
          type: string
          description: Description of Cron expression like it will run daily, weekly, monthly etc
        lastRunTime:
          type: string
          description: Date it last ran
        nextRunTime:
          type: string
          description: Date, it would run next
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/Job1'
          description: Set of SRLG jobs that need to be run as part of this schedule
    SrlgScheduleData:
      title: SrlgScheduleData
      type: object
      properties:
        id:
          type: string
          description: Unique identification of record, generally holds scheduleId
        type:
          type: string
          description: It is type - SrlgSchedule
        attributes:
          $ref: '#/components/schemas/SrlgScheduleAttributes'
    SrlgScheduleModelsAttributes:
      title: SrlgScheduleModelsAttributes
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/SrlgAllowedJobAttributes'
          description: SRLG Jobs supported for scheduling
    SrlgScheduleModelsData:
      title: SrlgScheduleModelsData
      type: object
      properties:
        id:
          type: string
          description: The unique identifier
        type:
          $ref: '#/components/schemas/Type97'
        attributes:
          $ref: '#/components/schemas/SrlgScheduleModelsAttributes'
    SrlgScheduleModelsResponse:
      title: SrlgScheduleModelsResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgScheduleModelsData'
    SrlgScheduleRequest:
      title: SrlgScheduleRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgScheduleData'
    SrlgScheduleResponse:
      title: SrlgScheduleResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgScheduleData'
    SrlgSchedulesResponse:
      title: SrlgSchedulesResponse
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SrlgScheduleData'
          description: ''
    SrlgSet:
      title: SrlgSet
      type: object
      properties:
        id:
          type: string
          description: Id of the srlgset
        plannedStartDate:
          type: string
          description: Planned start date in rfc 3339 format
        srlgValues:
          type: array
          items:
            type: string
          description: Srlg values
        structuredSRLGValues:
          type: array
          items:
            $ref: '#/components/schemas/StructuredSrlgValues'
          description: structuredSRLGValues
    SrlgSetV2:
      title: SrlgSetV2
      type: object
      properties:
        plannedStartDate:
          type: string
          description: Expectation Planned Start Date.
        combined:
          $ref: '#/components/schemas/SrlgV2'
        auto:
          $ref: '#/components/schemas/SrlgV2'
        manual:
          $ref: '#/components/schemas/SrlgV2'
        inherited:
          $ref: '#/components/schemas/SrlgV2'
        propagated:
          $ref: '#/components/schemas/SrlgV2'
        discovered:
          $ref: '#/components/schemas/SrlgV2'
        manualShare:
          $ref: '#/components/schemas/SrlgV2'
        propagatedShare:
          $ref: '#/components/schemas/SrlgV2'
        combinedShare:
          $ref: '#/components/schemas/SrlgV2'
    SrlgV2:
      title: SrlgV2
      type: object
      properties:
        srlgStructuredValues:
          type: array
          items:
            type: object
          description: ''
        srlgValues:
          type: array
          items:
            type: string
          description: SRLG Values set in Opaque format. If user assigns Structured SRLG in opaque format, then all optional values must be given as well
        srlgRefs:
          type: array
          items:
            $ref: '#/components/schemas/ShareSrlgResourceReferenceV2'
          description: ''
    StructuredSrlgValues:
      title: StructuredSrlgValues
      type: object
      properties:
        userBit:
          type: string
          description: user bit value of srlg
        controller:
          type: string
          description: controller value of srlg
        srlgType:
          type: string
          description: srlg type value of srlg
        srlgPriority:
          type: string
          description: srlg priority value of srlg
        srlgRisk:
          type: string
          description: srlg risk value of srlg
    TpeDetails:
      title: TpeDetails
      type: object
      properties:
        tpeId:
          type: string
          description: An explanation about the purpose of this instance.
        owningNetworkConstruct:
          type: string
          description: An explanation about the purpose of this instance.
        locations:
          type: array
          items:
            type: object
          description: An explanation about the purpose of this instance.
    AssignableEntityConfigPatchOperationRO:
      title: AssignableEntityConfigPatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op15'
        attributes:
          $ref: '#/components/schemas/SrlgAssignableEntityConfigAttributesRO'
    AssignableEntityConfigPatchRO:
      title: AssignableEntityConfigPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/AssignableEntityConfigPatchOperationRO'
          description: ''
    DataRO:
      title: DataRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op16'
        type:
          $ref: '#/components/schemas/Type98'
        attributes:
          $ref: '#/components/schemas/SRLGPoolOperationDataAttributesRO'
    NameValueStringPairRO:
      title: NameValueStringPairRO
      type: object
      properties:
        name:
          type: string
          description: parameter name.
        value:
          type: string
          description: parameter value.
    NameValuesPairRO:
      title: NameValuesPairRO
      type: object
      properties:
        name:
          type: string
          description: The name of this pair (e.g. 'property1').
        values:
          type: array
          items:
            type: string
          description: values of this pair (e.g. ['myValue1','myValue2'] or '6').
    PropagatableServiceConfigPatchOperationRO:
      title: PropagatableServiceConfigPatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op17'
        attributes:
          $ref: '#/components/schemas/SrlgPropagatableServiceConfigAttributesRO'
    PropagatableServiceConfigPatchRO:
      title: PropagatableServiceConfigPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/PropagatableServiceConfigPatchOperationRO'
          description: ''
    SrlgAssignableEntitiesListRO:
      title: SrlgAssignableEntitiesListRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataRO'
        links:
          $ref: '#/components/schemas/LinksRO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SrlgAssignableEntitiesRO'
          description: ''
    SrlgAssignableEntitiesRO:
      title: SrlgAssignableEntitiesRO
      type: object
      properties:
        entityType:
          $ref: '#/components/schemas/EntityType'
        riskType:
          type: string
        entityIds:
          type: array
          items:
            type: string
          description: ''
    SrlgAssignableEntityConfigAttributesRO:
      title: SrlgAssignableEntityConfigAttributesRO
      type: object
      properties:
        entityType:
          $ref: '#/components/schemas/EntityType'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/SrlgAssignableEntityConfigFilterRO'
          description: ''
    SrlgAssignableEntityConfigDataRO:
      title: SrlgAssignableEntityConfigDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the Srlg Assignable Entity Configuration
        type:
          $ref: '#/components/schemas/Type99'
        attributes:
          $ref: '#/components/schemas/SrlgAssignableEntityConfigAttributesRO'
    SrlgAssignableEntityConfigFilterRO:
      title: SrlgAssignableEntityConfigFilterRO
      type: object
      properties:
        riskType:
          type: string
        criteria:
          type: array
          items:
            $ref: '#/components/schemas/NameValuesPairRO'
          description: ''
    SrlgAssignableEntityConfigurationListRO:
      title: SrlgAssignableEntityConfigurationListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SrlgAssignableEntityConfigDataRO'
          description: ''
    SrlgFormatAttributesRO:
      title: SrlgFormatAttributesRO
      type: object
      properties:
        isEnabled:
          type: boolean
          default: false
        type:
          $ref: '#/components/schemas/Type100'
        isAutoAssignmentOn:
          type: boolean
          default: false
        isPropagationOn:
          type: boolean
          default: false
        length:
          type: integer
          description: Length of Srlg. There will be no restriction on length for opaque format
          format: int32
        displayFormat:
          $ref: '#/components/schemas/DisplayFormat'
        structure:
          type: array
          items:
            $ref: '#/components/schemas/SrlgFormatStructureRO'
          description: Strucutred items of SRLG
    SrlgFormatDataRO:
      title: SrlgFormatDataRO
      type: object
      properties:
        id:
          $ref: '#/components/schemas/Id'
        type:
          $ref: '#/components/schemas/Type101'
        attributes:
          $ref: '#/components/schemas/SrlgFormatAttributesRO'
        relationships:
          $ref: '#/components/schemas/SrlgFormatRelationshipsRO'
    SrlgFormatMappingAttributesRO:
      title: SrlgFormatMappingAttributesRO
      type: object
      properties:
        name:
          type: string
          description: parameter name.
        value:
          type: string
          description: parameter value.
        reservedForExtPool:
          type: boolean
          description: If reserved for the definition of External pool
          default: false
    SrlgFormatMappingDataRO:
      title: SrlgFormatMappingDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the Srlg Format Mapping
        type:
          type: string
          description: The Srlg Format mapping Type
        attributes:
          $ref: '#/components/schemas/SrlgFormatMappingAttributesRO'
    SrlgFormatMappingListRO:
      title: SrlgFormatMappingListRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SrlgFormatMappingDataRO'
          description: ''
    SrlgFormatPatchOperationRO:
      title: SrlgFormatPatchOperationRO
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op18'
        forceUpdate:
          type: boolean
          description: Used when the user wishes to update the srlgFormat forcefully.
          default: false
        attributes:
          $ref: '#/components/schemas/SrlgFormatAttributesRO'
    SrlgFormatPatchRO:
      title: SrlgFormatPatchRO
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/SrlgFormatPatchOperationRO'
          description: ''
    SrlgFormatRO:
      title: SrlgFormatRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrlgFormatDataRO'
        included:
          type: array
          items:
            type: object
          description: Referenced resources
    SrlgFormatRelationshipsRO:
      title: SrlgFormatRelationshipsRO
      type: object
      properties:
        srlgFormatMappings:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        assignableEntityConfiguration:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
        propagatableServiceConfiguration:
          $ref: '#/components/schemas/OneToManyRelationshipRO'
    SrlgFormatStructureRO:
      title: SrlgFormatStructureRO
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name4'
        displayName:
          type: string
          description: This will be the label that will be exposed on API for representing SRLG Structure
        startPos:
          type: integer
          description: Absolute start position of this structure in the Srlg value
          format: int32
        length:
          type: integer
          format: int32
        displayFormat:
          $ref: '#/components/schemas/DisplayFormat1'
        isPoolIdentifier:
          type: boolean
          description: If it can be used as SRLGPool identifier or not
          default: false
    SrlgPropagatableServiceConfigAttributes:
      title: SrlgPropagatableServiceConfigAttributes
      type: object
      properties:
        pruningConfig:
          $ref: '#/components/schemas/SrlgPropagatableServicePruningConfig'
        serviceClass:
          $ref: '#/components/schemas/ServiceClass4'
        serviceDescription:
          type: string
        protectionSrlgInclusion:
          type: boolean
          default: false
        isPropagatableTarget:
          type: boolean
          default: false
        writeToNetwork:
          type: boolean
          default: false
    SrlgPropagatableServiceConfigAttributesRO:
      title: SrlgPropagatableServiceConfigAttributesRO
      type: object
      properties:
        serviceDescription:
          type: string
          description: Used for describing service class
        serviceClass:
          $ref: '#/components/schemas/ServiceClass3'
        protectionSrlgInclusion:
          type: boolean
          description: Used for inclusion for srlg of protection service class
          default: false
        isPropagatableTarget:
          type: boolean
          description: Used to indicate propagatable target or not
          default: false
        writeToNetwork:
          type: boolean
          description: Used to indicate write to network for service class
          default: false
        pruningConfig:
          $ref: '#/components/schemas/SrlgPropagatableServicePruningConfigRO'
    SrlgPropagatableServiceConfigDataRO:
      title: SrlgPropagatableServiceConfigDataRO
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the Srlg Propagation Configuration
        type:
          $ref: '#/components/schemas/Type102'
        attributes:
          $ref: '#/components/schemas/SrlgPropagatableServiceConfigAttributesRO'
    SrlgPropagatableServiceConfiguration:
      title: SrlgPropagatableServiceConfiguration
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SrlgPropagatableServiceConfigAttributes'
        id:
          type: string
    SrlgPropagatableServicePruningConfig:
      title: SrlgPropagatableServicePruningConfig
      type: object
      properties:
        structuredMasks:
          type: array
          items:
            $ref: '#/components/schemas/SrlgPropagatableServiceStructuredMask'
          description: ''
        maxAllowedSrlgs:
          type: integer
          format: int32
        opaqueMasks:
          type: array
          items:
            type: string
          description: ''
    SrlgPropagatableServicePruningConfigRO:
      title: SrlgPropagatableServicePruningConfigRO
      type: object
      properties:
        maxAllowedSrlgs:
          type: integer
          format: int32
        structuredMasks:
          type: array
          items:
            $ref: '#/components/schemas/SrlgPropagatableServicePruningStructuredMasksRO'
          description: ''
        opaqueMasks:
          type: array
          items:
            type: string
          description: ''
    SrlgPropagatableServicePruningStructuredMasksRO:
      title: SrlgPropagatableServicePruningStructuredMasksRO
      type: object
      properties:
        priority:
          type: integer
          format: int32
        fieldMasks:
          type: array
          items:
            $ref: '#/components/schemas/NameValueStringPairRO'
          description: ''
    SrlgPropagatableServiceStructuredMask:
      title: SrlgPropagatableServiceStructuredMask
      type: object
      properties:
        fieldMasks:
          type: object
          additionalProperties:
            type: string
        priority:
          type: integer
          format: int32
    SrlgValuesRO:
      title: SrlgValuesRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DataRO'
    StructuredValueRO:
      title: StructuredValueRO
      type: object
      properties:
        id:
          type: string
    TransformedSrlgDataAttributesRO:
      title: TransformedSrlgDataAttributesRO
      type: object
      properties:
        srlgStructuredValue:
          $ref: '#/components/schemas/StructuredValueRO'
        srlgValue:
          type: string
          description: Opaque value of srlg
    TransformedSrlgDataRO:
      title: TransformedSrlgDataRO
      type: object
      properties:
        id:
          type: string
          description: Id of the SRLG
        type:
          $ref: '#/components/schemas/Type103'
        attributes:
          $ref: '#/components/schemas/TransformedSrlgDataAttributesRO'
    TransformedSrlgValuesRO:
      title: TransformedSrlgValuesRO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransformedSrlgDataRO'
          description: ''
    ExternalSRLGDataAttributesRO:
      title: ExternalSRLGDataAttributesRO
      type: object
      properties:
        poolIdentifier:
          type: string
          description: Describes the pool identifier using srlg type, risk type and subnetwork
        srlg:
          type: string
          description: Value of the srlg
        srlgStructured:
          type: object
    ExternalSRLGDataRO:
      title: ExternalSRLGDataRO
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type98'
        attributes:
          $ref: '#/components/schemas/ExternalSRLGDataAttributesRO'
    ExternalSRLGRO:
      title: ExternalSRLGRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExternalSRLGDataRO'
    SRLGPoolOperationDataAttributesRO:
      title: SRLGPoolOperationDataAttributesRO
      type: object
      properties:
        srlg:
          type: string
          description: Srlg Value
        srlgStructured:
          type: object
    SRLGPoolOperationRO:
      title: SRLGPoolOperationRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DataRO'
    scanNow:
      title: scanNow
      type: object
      properties:
        facilityAid:
          type: string
          description: Facility AID of the repeater system on which scan need to be initiated.
        label:
          type: string
          description: scan label.
      description: Parameters for initiating scan.
    scheduleScan:
      title: scheduleScan
      type: object
      properties:
        repeaterAID:
          type: string
          default: OTM2-0-0
        attributes:
          $ref: '#/components/schemas/Attributes21'
      description: Schedule Scan parameteres
    configLoss:
      title: configLoss
      type: object
      properties:
        ncId:
          type: string
          description: ncId of the network element..
        facilityAid:
          type: string
          description: Facility
        txLoss:
          type: string
          description: Tx loss in db
        rxLoss:
          type: string
          description: Rx loss in db
      description: Config loss parameters for specified repeater system.
    scanThreshold:
      title: scanThreshold
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data21'
          description: ''
      description: Set baseline parameteres
    ids:
      title: ids
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: ''
      description: Scan Ids of the scans to be deleted/exported
    deleteDescriptorFile:
      title: deleteDescriptorFile
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data22'
      description: Repeater, Slte, Cable descriptor files to be deleted
    commitCableSystem:
      title: commitCableSystem
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data23'
      description: Add to inventory /Remove from inventory cable system configuration
    spectrumSharingDetails:
      title: spectrumSharingDetails
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data24'
    provisionSpectrum:
      title: provisionSpectrum
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data25'
    removeSpectrum:
      title: removeSpectrum
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data26'
    facilityRequest:
      title: facilityRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data27'
    updateSwsel:
      title: updateSwsel
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data28'
    BasePmReading:
      title: BasePmReading
      type: object
      properties:
        id:
          type: string
        parameter:
          type: string
        parameterNative:
          type: string
        location:
          type: string
        locationNative:
          type: string
        direction:
          type: string
        directionNative:
          type: string
        binType:
          type: string
        threshold:
          type: string
        display:
          type: string
        unit:
          type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/PmValue'
          description: ''
    BerComplexData:
      title: BerComplexData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type105'
        attributes:
          $ref: '#/components/schemas/BerComplexDataAttributes'
        relationships:
          $ref: '#/components/schemas/BerComplexDataRelationships'
        diagResults:
          type: object
    BerComplexDataAttributes:
      title: BerComplexDataAttributes
      type: object
      properties:
        timeStamp:
          type: string
        pmType:
          $ref: '#/components/schemas/PmType2'
        otsiBerDetails:
          type: array
          items:
            $ref: '#/components/schemas/BerData'
          description: ''
        diagResults:
          type: object
    BerComplexDataRelationships:
      title: BerComplexDataRelationships
      type: object
      properties:
        fres:
          $ref: '#/components/schemas/OneToManyRelationship1'
    BerComplexResponse:
      title: BerComplexResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BerComplexData'
    BerData:
      title: BerData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type106'
        attributes:
          $ref: '#/components/schemas/BerDataAttributes'
        relationships:
          $ref: '#/components/schemas/PmDataRelationships'
    BerDataAttributes:
      title: BerDataAttributes
      type: object
      properties:
        pmTpes:
          type: array
          items:
            $ref: '#/components/schemas/PmTpe'
          description: ''
        diagResults:
          type: object
    BmTestData:
      title: BmTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type107'
        generatorId:
          type: string
        testParameters:
          type: object
        freId:
          type: string
        userAnnotation:
          type: string
    BmTestRo:
      title: BmTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BmTestData'
    CfmTestData:
      title: CfmTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type108'
        localTpeId:
          type: string
        remotePoint:
          $ref: '#/components/schemas/RemotePoint'
        testParameters:
          type: object
        freId:
          type: string
        userAnnotation:
          type: string
    CfmTestRo:
      title: CfmTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CfmTestData'
    CtpPtpRelationships:
      title: CtpPtpRelationships
      type: object
      properties:
        measurementpointTpes:
          $ref: '#/components/schemas/OneToOneRelationship1'
    FiberLossAttrs:
      title: FiberLossAttrs
      type: object
      properties:
        fiberLoss:
          type: object
    FiberLossData:
      title: FiberLossData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type109'
        attributes:
          $ref: '#/components/schemas/FiberLossAttrs'
        relationships:
          $ref: '#/components/schemas/FiberLossRelationships'
    FiberLossRelationships:
      title: FiberLossRelationships
      type: object
      properties:
        fre:
          $ref: '#/components/schemas/OneToOneRelationship1'
    FiberLossResponse:
      title: FiberLossResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FiberLossResults'
        included:
          type: array
          items:
            $ref: '#/components/schemas/FiberLossData'
          description: ''
    FiberLossResults:
      title: FiberLossResults
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type110'
        relationships:
          $ref: '#/components/schemas/FiberLossResultsRelationships'
    FiberLossResultsRelationships:
      title: FiberLossResultsRelationships
      type: object
      properties:
        fiberLossData:
          $ref: '#/components/schemas/OneToManyRelationship1'
    ItsAttributes:
      title: ItsAttributes
      type: object
      properties:
        tpeId:
          type: string
        cardType:
          type: string
        itsMode:
          type: array
          items:
            type: string
          description: ''
        layer:
          type: string
        layerRateQualifier:
          type: string
        nodeName:
          type: string
        nativeName:
          type: string
        resourceType:
          type: string
        testDescriptionData:
          $ref: '#/components/schemas/ItsDescriptionRAData'
        testConfigData:
          $ref: '#/components/schemas/ItsTestConfigData'
    ItsAttributesDetail:
      title: ItsAttributesDetail
      type: object
      properties:
        configResults:
          type: array
          items:
            type: object
          description: ''
        configStatus:
          type: string
    ItsDescriptionRAData:
      title: ItsDescriptionRAData
      type: object
      properties:
        berThreshold:
          type: array
          items:
            type: string
          description: ''
        monaBerThreshold:
          type: array
          items:
            type: string
          description: ''
        monbBerThreshold:
          type: array
          items:
            type: string
          description: ''
        monaPattern:
          type: array
          items:
            type: string
          description: ''
        monbPattern:
          type: array
          items:
            type: string
          description: ''
        genaPattern:
          type: array
          items:
            type: string
          description: ''
        genbPattern:
          type: array
          items:
            type: string
          description: ''
        genaErrorType:
          type: array
          items:
            type: string
          description: ''
        genbErrorType:
          type: array
          items:
            type: string
          description: ''
    ItsInjectErrorData:
      title: ItsInjectErrorData
      type: object
      properties:
        tpeId:
          type: string
        testId:
          type: string
        errorType:
          $ref: '#/components/schemas/ErrorType'
        errorOperation:
          $ref: '#/components/schemas/ErrorOperation'
        errorPoint:
          $ref: '#/components/schemas/ErrorPoint'
        errorRate:
          $ref: '#/components/schemas/ErrorRate'
    ItsInjectErrorRo:
      title: ItsInjectErrorRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ItsInjectErrorData'
    ItsOperationData:
      title: ItsOperationData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type111'
        localTpeData:
          type: object
        remoteTpeData:
          type: object
    ItsOperationRo:
      title: ItsOperationRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ItsOperationData'
    ItsTestConfigData:
      title: ItsTestConfigData
      type: object
      properties:
        mode:
          type: string
        adminState:
          type: string
        loopback:
          type: string
        duration:
          type: string
        berThreshold:
          type: string
        monaBerThreshold:
          type: string
        monbBerThreshold:
          type: string
        monaPattern:
          type: string
        monbPattern:
          type: string
        genaPattern:
          type: string
        genbPattern:
          type: string
        operation:
          type: string
        testStartTime:
          type: string
        genaErrorType:
          type: string
        genbErrorType:
          type: string
        genaErrorRate:
          type: string
        genbErrorRate:
          type: string
        genaErrorState:
          type: string
        genbErrorState:
          type: string
    ItsTestDescriptionData:
      title: ItsTestDescriptionData
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ItsAttributesDetail'
        relationships:
          $ref: '#/components/schemas/ItsTestRelationships'
    ItsTestDescriptions:
      title: ItsTestDescriptions
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          $ref: '#/components/schemas/ItsAttributes'
        relationships:
          $ref: '#/components/schemas/Relationships'
    ItsTestRelationships:
      title: ItsTestRelationships
      type: object
      properties:
        itsTestDetails:
          $ref: '#/components/schemas/OneToManyRelationship1'
    ItsTestRo:
      title: ItsTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ItsTestDescriptionData'
        included:
          type: array
          items:
            $ref: '#/components/schemas/ItsTestDescriptions'
          description: ''
    LbTestData:
      title: LbTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type112'
        localTpeId:
          type: string
        testParameters:
          type: object
        userAnnotation:
          type: string
    LbTestRo:
      title: LbTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LbTestData'
    LdpTestData:
      title: LdpTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type113'
        localTpeId:
          type: string
        remotePoint:
          $ref: '#/components/schemas/RemotePoint'
        freId:
          type: string
        isis-dest:
          type: string
        ncId:
          type: string
        testParameters:
          type: object
        userAnnotation:
          type: string
    LdpTestRo:
      title: LdpTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LdpTestData'
    LspTestRo:
      title: LspTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MplsTestData'
    MplsTestData:
      title: MplsTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type114'
        localTpeId:
          type: string
        remotePoint:
          $ref: '#/components/schemas/RemotePoint'
        freId:
          type: string
        testParameters:
          type: object
        userAnnotation:
          type: string
    OneToManyRelationship1:
      title: OneToManyRelationship1
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RelationshipData1'
          description: ''
    OneToOneRelationship1:
      title: OneToOneRelationship1
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RelationshipData1'
    OperMeasData:
      title: OperMeasData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type115'
        attributes:
          $ref: '#/components/schemas/OperMeasDataAttributes'
        relationships:
          $ref: '#/components/schemas/OperMeasDataRelationships'
    OperMeasDataAttributes:
      title: OperMeasDataAttributes
      type: object
      properties:
        timeStamp:
          type: string
        pmType:
          $ref: '#/components/schemas/PmType2'
        granularity:
          type: string
        pmFacilities:
          type: array
          items:
            $ref: '#/components/schemas/PmFacility'
          description: ''
    OperMeasDataRelationships:
      title: OperMeasDataRelationships
      type: object
      properties:
        fres:
          $ref: '#/components/schemas/OneToManyRelationship1'
        networkConstructs:
          $ref: '#/components/schemas/OneToManyRelationship1'
    OperMeasFacContext:
      title: OperMeasFacContext
      type: object
      properties:
        ncName:
          type: string
        reportingFacility:
          type: string
        granularity:
          $ref: '#/components/schemas/Granularity2'
        parameterNatives:
          type: array
          items:
            type: string
          description: ''
        range:
          $ref: '#/components/schemas/TimeRange'
        synchronous:
          type: boolean
          default: false
    OperMeasFacRequest:
      title: OperMeasFacRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OperMeasFacContext'
    OperMeasLatencyRequest:
      title: OperMeasLatencyRequest
      type: object
      properties:
        resourceId:
          type: string
        synchronous:
          type: boolean
          default: false
    OperMeasRO:
      title: OperMeasRO
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        data:
          $ref: '#/components/schemas/OperMeasData'
    OperMeasRouteContext:
      title: OperMeasRouteContext
      type: object
      properties:
        freIds:
          type: array
          items:
            type: string
          description: ''
        granularity:
          $ref: '#/components/schemas/Granularity3'
        synchronous:
          type: boolean
          default: false
    OperMeasRouteRequest:
      title: OperMeasRouteRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OperMeasRouteContext'
    OperStatusData:
      title: OperStatusData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type117'
        attributes:
          type: object
        relationships:
          $ref: '#/components/schemas/Relationships'
    OperStatusResultsRo:
      title: OperStatusResultsRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OperStatusData'
        included:
          type: array
          items:
            type: object
          description: ''
    OpticalPowerContext:
      title: OpticalPowerContext
      type: object
      properties:
        freIds:
          type: array
          items:
            type: string
          description: ''
        pmType:
          $ref: '#/components/schemas/PmType2'
        synchronous:
          type: boolean
          default: false
        pollInterval:
          type: integer
          format: int32
    OpticalPowerRequest:
      title: OpticalPowerRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OpticalPowerContext'
    PmData:
      title: PmData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type106'
        attributes:
          $ref: '#/components/schemas/PmDataAttributes'
        relationships:
          $ref: '#/components/schemas/PmDataRelationships'
    PmDataAttributes:
      title: PmDataAttributes
      type: object
      properties:
        timeStamp:
          type: string
        pmType:
          $ref: '#/components/schemas/PmType2'
        pmTpes:
          type: array
          items:
            $ref: '#/components/schemas/PmTpe'
          description: ''
        diagResults:
          type: object
    PmDataRelationships:
      title: PmDataRelationships
      type: object
      properties:
        fres:
          $ref: '#/components/schemas/OneToManyRelationship1'
        tpes:
          $ref: '#/components/schemas/OneToManyRelationship1'
    PmDiagResponse:
      title: PmDiagResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PmData'
    PmFacility:
      title: PmFacility
      type: object
      properties:
        id:
          type: string
        resourceId:
          type: string
        linkEdgeTpeId:
          type: string
        resourceDir:
          type: string
        ncName:
          type: string
        ncSubnet:
          type: string
        reportingFacility:
          type: string
        facilityType:
          type: string
        cardType:
          type: string
        startTime:
          type: string
        pmReadings:
          type: array
          items:
            $ref: '#/components/schemas/BasePmReading'
          description: ''
        relationships:
          $ref: '#/components/schemas/PmFacilityRelationships'
    PmFacilityRelationships:
      title: PmFacilityRelationships
      type: object
      properties:
        ncIds:
          $ref: '#/components/schemas/OneToOneRelationship1'
        measurementPointTpes:
          $ref: '#/components/schemas/OneToOneRelationship1'
    PmReading:
      title: PmReading
      type: object
      properties:
        reportingFacility:
          type: string
        facilityType:
          type: string
        frequency:
          type: string
        binType:
          type: string
        parameter:
          type: string
        parameterNative:
          type: string
        value:
          type: string
        startTime:
          type: string
        threshold:
          type: string
        binState:
          type: string
        alert:
          type: string
    PmResetContext:
      title: PmResetContext
      type: object
      properties:
        freIds:
          type: array
          items:
            type: string
          description: ''
        granularity:
          $ref: '#/components/schemas/Granularity4'
    PmResetData:
      title: PmResetData
      type: object
      properties:
        id:
          type: string
        attributes:
          $ref: '#/components/schemas/PmResetDataAttributes'
        relationships:
          $ref: '#/components/schemas/OperMeasDataRelationships'
    PmResetDataAttributes:
      title: PmResetDataAttributes
      type: object
      properties:
        resetTime:
          type: string
        granularity:
          type: string
        resetSummary:
          $ref: '#/components/schemas/PmResetSummary'
        pmFacilities:
          type: array
          items:
            $ref: '#/components/schemas/PmResetFacResult'
          description: ''
    PmResetFacResult:
      title: PmResetFacResult
      type: object
      properties:
        resourceId:
          type: string
        ncName:
          type: string
        aid:
          type: string
        status:
          type: string
        errors:
          type: string
    PmResetRO:
      title: PmResetRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PmResetData'
    PmResetRequest:
      title: PmResetRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PmResetContext'
    PmResetSummary:
      title: PmResetSummary
      type: object
      properties:
        status:
          type: string
        error:
          type: string
    PmTpe:
      title: PmTpe
      type: object
      properties:
        tpeId:
          type: string
        portDir:
          $ref: '#/components/schemas/PortDir'
        isReporting:
          type: boolean
          default: false
        ncName:
          type: string
        reportingFacility:
          type: string
        pmReadings:
          type: array
          items:
            $ref: '#/components/schemas/PmReading'
          description: ''
        relationships:
          $ref: '#/components/schemas/CtpPtpRelationships'
    PmValue:
      title: PmValue
      type: object
      properties:
        startTime:
          type: string
        value:
          type: string
        frequency:
          type: string
        binState:
          type: string
        alert:
          type: string
    PowerSnapshotRequestData:
      title: PowerSnapshotRequestData
      type: object
      properties:
        resourceId:
          type: string
        synchronous:
          type: boolean
          default: false
    PowerSnapshotRequestRO:
      title: PowerSnapshotRequestRO
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PowerSnapshotRequestData'
    PropRequestRo:
      title: PropRequestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PropertyRequestData'
    PropResponseRo:
      title: PropResponseRo
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PropertyData'
          description: ''
    PropertyData:
      title: PropertyData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type119'
        attributes:
          type: object
    PropertyRequestData:
      title: PropertyRequestData
      type: object
      properties:
        attributes:
          type: object
    PwTestRo:
      title: PwTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MplsTestData'
    ReflectorOperationData:
      title: ReflectorOperationData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type120'
        reflectorId:
          type: string
        reflectorParameters:
          type: object
    ReflectorOperationRo:
      title: ReflectorOperationRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReflectorOperationData'
    RelationshipData1:
      title: RelationshipData1
      type: object
      properties:
        type:
          type: string
        id:
          type: string
    RelationshipMetaData:
      title: RelationshipMetaData
      type: object
      properties:
        partiallyPopulated:
          type: boolean
          default: false
    RemotePoint:
      title: RemotePoint
      type: object
      properties:
        idType:
          $ref: '#/components/schemas/IdType'
        id:
          type: string
    SpectralAllocRo:
      title: SpectralAllocRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SpectralData'
        included:
          type: array
          items:
            type: object
          description: ''
    SpectralData:
      title: SpectralData
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type121'
        relationships:
          $ref: '#/components/schemas/SpectralDataRelationships'
    SpectralDataRelationships:
      title: SpectralDataRelationships
      type: object
      properties:
        spectralRoadmlines:
          $ref: '#/components/schemas/OneToManyRelationship1'
    SpectralResponse:
      title: SpectralResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SpectralResults'
        included:
          type: array
          items:
            type: object
          description: ''
    SpectralResults:
      title: SpectralResults
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type122'
        relationships:
          $ref: '#/components/schemas/Relationships'
    SrPolicyTestData:
      title: SrPolicyTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type113'
        policyName:
          type: string
        freId:
          type: string
        testParameters:
          type: object
        userAnnotation:
          type: string
        destEndPoint:
          type: string
    SrPolicyTestRo:
      title: SrPolicyTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrPolicyTestData'
    SrTestData:
      title: SrTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type113'
        localTpeId:
          type: string
        remotePoint:
          $ref: '#/components/schemas/RemotePoint'
        freId:
          type: string
        isis-dest:
          type: string
        ncId:
          type: string
        testParameters:
          type: object
        userAnnotation:
          type: string
    SrTestRo:
      title: SrTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SrTestData'
    TdmLbTestData:
      title: TdmLbTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type125'
        localTpeId:
          type: string
        testParameters:
          type: object
        freId:
          type: string
        userAnnotation:
          type: string
    TdmLbTestRo:
      title: TdmLbTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TdmLbTestData'
    TestCapRelationships:
      title: TestCapRelationships
      type: object
      properties:
        testDescriptions:
          $ref: '#/components/schemas/OneToManyRelationship1'
        fres:
          $ref: '#/components/schemas/OneToOneRelationship1'
    TestCapabilities:
      title: TestCapabilities
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type126'
        attributes:
          type: object
        relationships:
          $ref: '#/components/schemas/TestCapRelationships'
    TestCapabilitiesRo:
      title: TestCapabilitiesRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TestCapabilities'
        included:
          type: array
          items:
            $ref: '#/components/schemas/TestDescriptions'
          description: ''
    TestDesRelationships:
      title: TestDesRelationships
      type: object
      properties:
        tpes:
          $ref: '#/components/schemas/OneToManyRelationship1'
    TestDescriptions:
      title: TestDescriptions
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type127'
        attributes:
          type: object
        relationships:
          $ref: '#/components/schemas/TestDesRelationships'
    TestListRo:
      title: TestListRo
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TestResults'
          description: ''
    TestRelationships:
      title: TestRelationships
      type: object
      properties:
        tpes:
          $ref: '#/components/schemas/OneToManyRelationship1'
        networkConstructs:
          $ref: '#/components/schemas/OneToManyRelationship1'
    TestResults:
      title: TestResults
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/Type128'
        attributes:
          $ref: '#/components/schemas/TestResultsAttrs'
        relationships:
          $ref: '#/components/schemas/TestRelationships'
    TestResultsAttrs:
      title: TestResultsAttrs
      type: object
      properties:
        testResults:
          type: array
          items:
            type: object
          description: ''
        testType:
          $ref: '#/components/schemas/TestType'
        testStatus:
          $ref: '#/components/schemas/TestStatus'
        localTpeId:
          type: string
        remotePoints:
          type: array
          items:
            type: string
          description: ''
        localNcId:
          type: string
        remoteNcs:
          type: array
          items:
            type: string
          description: ''
        startTime:
          type: string
          format: date-time
        lastUpdateTime:
          type: string
          format: date-time
        testParameters:
          type: object
    TestResultsRo:
      title: TestResultsRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TestResults'
    TimeRange:
      title: TimeRange
      type: object
      properties:
        type:
          $ref: '#/components/schemas/requestTypeEnum'
        unit:
          $ref: '#/components/schemas/Unit2'
        value:
          type: string
        startTime:
          type: string
        endTime:
          type: string
    VrfTestData:
      title: VrfTestData
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type113'
        ipPrefix:
          type: string
        freId:
          type: string
        vrfId:
          type: string
        remotePoint:
          $ref: '#/components/schemas/RemotePoint'
        testParameters:
          type: object
        userAnnotation:
          type: string
    VrfTestRo:
      title: VrfTestRo
      type: object
      properties:
        data:
          $ref: '#/components/schemas/VrfTestData'
    PostTopics:
      title: PostTopics
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Topic'
          description: ''
    PutTopic:
      title: PutTopic
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data292'
    GetTopic:
      title: GetTopic
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data292'
    Topic:
      title: Topic
      required:
      - id
      - type
      - attributes
      type: object
      properties:
        id:
          type: string
          description: The topic name
        type:
          enum:
          - topic
          type: string
        attributes:
          $ref: '#/components/schemas/Attributes26'
      description: A Topic has a name (id), is of type Topic and has attributes reflecting its configuration
    ConsumerGroupState:
      title: ConsumerGroupState
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data29'
    ConsumerState:
      title: ConsumerState
      type: object
      properties:
        clientId:
          type: string
        consumerId:
          type: string
        partitions:
          type: array
          items:
            $ref: '#/components/schemas/Partition'
          description: ''
    TopicState:
      title: TopicState
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data30'
    ConsumerGroupProcessState:
      title: ConsumerGroupProcessState
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data31'
    Chronology:
      title: Chronology
      type: object
      properties:
        calendarType:
          type: string
        id:
          type: string
    Duration:
      title: Duration
      type: object
      properties:
        seconds:
          type: integer
          format: int64
        zero:
          type: boolean
          default: false
        negative:
          type: boolean
          default: false
        units:
          type: array
          items:
            $ref: '#/components/schemas/TemporalUnit'
          description: ''
        nano:
          type: integer
          format: int32
    Instant:
      title: Instant
      type: object
      properties:
        epochSecond:
          type: integer
          format: int64
        nano:
          type: integer
          format: int32
    LocalTime:
      title: LocalTime
      type: object
      properties:
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
        second:
          type: integer
          format: int32
        nano:
          type: integer
          format: int32
    Progress:
      title: Progress
      type: object
      properties:
        currentStep:
          type: integer
          format: int32
        totalSteps:
          type: integer
          format: int32
        subStep:
          $ref: '#/components/schemas/SubStep'
    SubStep:
      title: SubStep
      type: object
      properties:
        currentSubStep:
          type: integer
          format: int32
        totalSubSteps:
          type: integer
          format: int32
        application:
          type: string
    TemporalUnit:
      title: TemporalUnit
      type: object
      properties:
        duration:
          $ref: '#/components/schemas/Duration'
        dateBased:
          type: boolean
          default: false
        timeBased:
          type: boolean
          default: false
        durationEstimated:
          type: boolean
          default: false
    UpgradeJob:
      title: UpgradeJob
      type: object
      properties:
        id:
          type: integer
          format: int64
        states:
          type: array
          items:
            $ref: '#/components/schemas/UpgradeState'
          description: ''
        move:
          type: boolean
          default: false
        includeShared:
          type: boolean
          default: false
        startTime:
          type: string
          format: date-time
    UpgradeJobRO:
      title: UpgradeJobRO
      type: object
      properties:
        states:
          type: array
          items:
            $ref: '#/components/schemas/UpgradeStateRO'
          description: ''
        startTime:
          type: string
      description: The information about an upgrade
    UpgradeRequestRO:
      title: UpgradeRequestRO
      type: object
      properties:
        upgradeList:
          type: array
          items:
            $ref: '#/components/schemas/UpgradeSolutionRO'
          description: ''
        move:
          type: boolean
          default: false
        includeShared:
          type: boolean
          default: false
    UpgradeSolutionRO:
      title: UpgradeSolutionRO
      type: object
      properties:
        solutionName:
          type: string
        previousVersion:
          type: string
        newVersion:
          type: string
    UpgradeState:
      title: UpgradeState
      type: object
      properties:
        startTime:
          $ref: '#/components/schemas/ZonedDateTime'
        stateId:
          type: integer
          format: int64
        previousSolutionName:
          type: string
        lastMessage:
          type: string
        newSolutionName:
          type: string
        currentProgress:
          $ref: '#/components/schemas/Progress'
        previousSolutionSnapshots:
          type: array
          items:
            type: string
          description: ''
        state:
          type: string
    UpgradeStateRO:
      title: UpgradeStateRO
      type: object
      properties:
        stateId:
          type: integer
          format: int64
        previousSolutionName:
          type: string
        newSolutionName:
          type: string
        state:
          type: string
        lastMessage:
          type: string
        previousSolutionSnapshots:
          type: array
          items:
            type: string
          description: ''
        startTime:
          $ref: '#/components/schemas/ZonedDateTime'
        progress:
          $ref: '#/components/schemas/Progress'
      description: The information about an upgrade state
    ZoneId:
      title: ZoneId
      type: object
      properties:
        rules:
          $ref: '#/components/schemas/ZoneRules'
        id:
          type: string
    ZoneOffset:
      title: ZoneOffset
      type: object
      properties:
        totalSeconds:
          type: integer
          format: int32
        rules:
          $ref: '#/components/schemas/ZoneRules'
        id:
          type: string
    ZoneOffsetTransition:
      title: ZoneOffsetTransition
      type: object
      properties:
        offsetBefore:
          $ref: '#/components/schemas/ZoneOffset'
        offsetAfter:
          $ref: '#/components/schemas/ZoneOffset'
        dateTimeBefore:
          type: string
          format: date-time
        instant:
          $ref: '#/components/schemas/Instant'
        duration:
          $ref: '#/components/schemas/Duration'
        gap:
          type: boolean
          default: false
        overlap:
          type: boolean
          default: false
        dateTimeAfter:
          type: string
          format: date-time
    ZoneOffsetTransitionRule:
      title: ZoneOffsetTransitionRule
      type: object
      properties:
        month:
          $ref: '#/components/schemas/Month'
        timeDefinition:
          $ref: '#/components/schemas/TimeDefinition'
        standardOffset:
          $ref: '#/components/schemas/ZoneOffset'
        offsetBefore:
          $ref: '#/components/schemas/ZoneOffset'
        offsetAfter:
          $ref: '#/components/schemas/ZoneOffset'
        dayOfWeek:
          $ref: '#/components/schemas/DayOfWeek'
        dayOfMonthIndicator:
          type: integer
          format: int32
        localTime:
          $ref: '#/components/schemas/LocalTime'
        midnightEndOfDay:
          type: boolean
          default: false
    ZoneRules:
      title: ZoneRules
      type: object
      properties:
        transitions:
          type: array
          items:
            $ref: '#/components/schemas/ZoneOffsetTransition'
          description: ''
        transitionRules:
          type: array
          items:
            $ref: '#/components/schemas/ZoneOffsetTransitionRule'
          description: ''
        fixedOffset:
          type: boolean
          default: false
    ZonedDateTime:
      title: ZonedDateTime
      type: object
      properties:
        offset:
          $ref: '#/components/schemas/ZoneOffset'
        zone:
          $ref: '#/components/schemas/ZoneId'
        dayOfYear:
          type: integer
          format: int32
        dayOfWeek:
          $ref: '#/components/schemas/DayOfWeek'
        month:
          $ref: '#/components/schemas/Month'
        dayOfMonth:
          type: integer
          format: int32
        year:
          type: integer
          format: int32
        monthValue:
          type: integer
          format: int32
        nano:
          type: integer
          format: int32
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
        second:
          type: integer
          format: int32
        chronology:
          $ref: '#/components/schemas/Chronology'
    APIKeyPairSerializer:
      title: APIKeyPairSerializer
      required:
      - owner
      type: object
      properties:
        createdTime:
          type: string
          format: date-time
        id:
          type: integer
          format: int32
        keyId:
          type: string
        keySecret:
          type: string
        modifiedTime:
          type: string
          format: date-time
        owner:
          type: string
          description: User UUID
    ApplicationSerializer:
      title: ApplicationSerializer
      required:
      - name
      type: object
      properties:
        createdTime:
          type: string
          format: date-time
        description:
          type: string
          description: description
        displayName:
          type: string
          description: display name, same as name if not provided
        isInternal:
          type: boolean
          description: Is internal Application
        manager:
          type: string
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Application name
        uuid:
          type: string
    AuthSerializer:
      title: AuthSerializer
      required:
      - authType
      type: object
      properties:
        apps:
          type: array
          items:
            type: string
          description: list of Application names, request roles for these Applications. If empty, user roles are not returned for any Application
        authType:
          type: string
          description: Authentication Type, rest of the parameters depend on this
        keyId:
          type: string
          description: Required for authType mac
        password:
          type: string
          description: required for authType password
        tenant:
          type: string
          description: Tenant Name required for authType password
        token:
          type: string
          description: Required for authType token
        username:
          type: string
          description: required for authType password
    UserSerializer:
      title: UserSerializer
      required:
      - firstName
      - lastName
      - username
      type: object
      properties:
        accessibleTenants:
          type: array
          items:
            type: string
          description: ''
        clientInactivityTime:
          type: integer
          description: timeout in seconds of inactivity
          format: int32
        concurrentSessionMax:
          type: integer
          description: The maximum number of concurrent sessions. (0=infinity)
          format: int32
        dateJoined:
          type: string
          format: date-time
        description:
          type: string
          description: user's description
        directory:
          type: string
          description: Indicates which directory user is from, e.g. ldap
        dormancyDays:
          type: integer
          description: number of days before an account can become dormant
          format: int32
        email:
          type: string
          description: user's email address
        failedLoginAttempts:
          type: integer
          description: Failed login attempts since last successful attempt
          format: int32
        firstName:
          type: string
          description: user's first name
        initDormancyTime:
          type: string
          format: date-time
        isActive:
          type: boolean
          description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
        isDormant:
          type: boolean
          description: Designates whether this user is dormant from account inactivity
        isExpired:
          type: boolean
          description: Designates whether password of the user is expired or not
        isInternal:
          type: boolean
          description: Internal User
        isLocked:
          type: boolean
          description: Designates whether this user is locked from failed login attempts
        isVerboseLogging:
          type: boolean
          description: User permission for generating audit logs
        lastLoginDetail:
          type: string
        lastLoginDetailUuid:
          type: string
        lastName:
          type: string
          description: user's last name
        passwordChangeRequired:
          type: boolean
          description: Password change required
        passwordExpirationDays:
          type: integer
          description: Number of days before an password for the account expires.
          format: int32
        resolvedClientInactivityTime:
          type: string
        resolvedConcurrentSessionMax:
          type: string
        resolvedDisabledQualifiers:
          type: string
        resolvedDormancyDays:
          type: string
        resolvedPasswordExpirationDays:
          type: string
        resolvedPasswordExpirationTime:
          type: string
        resolvedTokenExpirationTime:
          type: string
        roles:
          type: array
          items:
            type: string
          description: ''
        tenant:
          type: string
          description: tenant UUID of user, if not provided "master" tenant is used
        tokenExpirationTime:
          type: integer
          description: token expires in timeout seconds from created time
          format: int32
        unlockTime:
          type: string
          description: Time when this user was locked.
          format: date-time
        usergroups:
          type: array
          items:
            type: string
          description: ''
        username:
          type: string
          description: Required. 100 characters or fewer. Letters, numbers and @/./+/-/_ characters
        uuid:
          type: string
    CurrentUserLoginInfoSerializer:
      title: CurrentUserLoginInfoSerializer
      required:
      - sessionId
      - tenantContext
      - tenantContextId
      - token
      type: object
      properties:
        sessionId:
          type: string
        tenantContext:
          type: string
          description: Tenant name for which this token is valid
        tenantContextId:
          type: string
          description: Tenant uuid for which this token is valid
        token:
          type: string
          description: Current Token used for Authentication
        user:
          type: string
          description: Token owner(user) UUID
    HealthCheckSerializer:
      title: HealthCheckSerializer
      required:
      - databaseCount
      type: object
      properties:
        databaseCount:
          type: integer
          description: Number of database back ends configured
          format: int32
    LDAPConfigSerializer:
      title: LDAPConfigSerializer
      required:
      - groupObjectFilter
      - name
      type: object
      properties:
        accessibleTenantsAttribute:
          type: string
          description: Attribute to define multiple tenant access for this user
        baseDn:
          type: string
        createdTime:
          type: string
          format: date-time
        description:
          type: string
          description: LDAP config description
        domainSearchUser:
          type: string
          description: 'LDAP username to perform user lookups. Example: user@domain.com'
        enableReferrals:
          type: boolean
          description: Microsoft AD needs this to be disabled. (Anonymous bind is not supported)
        enableSsl:
          type: boolean
        enabled:
          type: boolean
          description: Activate this LDAP Configuration, if false, configuration exists in database but will not be used
        groupNameAttribute:
          type: string
          description: Attribute to load group name
        groupObjectFilter:
          type: string
          description: Filter when searching group
        memberAttr:
          type: string
          description: "'member_attr' used for 'group_object_filter', e.g. set 'memberUid' for '(objectClass=posixGroup)', 'member' for '(objectClass=groupOfNames)', 'uniqueMember' for '(objectClass=GroupOfUniqueNames)' when using OpenLDAP; 'member' for '(objectClass=group)' when using Microsoft AD."
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: LDAP config name
        roleMap:
          type: string
          description: Dictionary string that maps LDAP groups/roles to a list of tron roles
        serverIp:
          type: string
          description: Server address
        sslLevel:
          type: string
          description: SSL security level (NEVER, ALLOW, DEMAND)
        tenantAttribute:
          type: string
          description: Tenant attribute to filter user
        userNameAttribute:
          type: string
          description: Attribute to load user name
        uuid:
          type: string
    LoginDetailSerializer:
      title: LoginDetailSerializer
      required:
      - ipAddress
      - sessionId
      - userUuid
      type: object
      properties:
        ipAddress:
          type: string
        isSuccessful:
          type: boolean
        sessionId:
          type: string
        time:
          type: string
          format: date-time
        userUuid:
          type: string
    LoginInfoSerializer:
      title: LoginInfoSerializer
      required:
      - emailNotificationEnabled
      - ldapEnabled
      - passwordResetEnabled
      - radiusEnabled
      - tenantNumber
      type: object
      properties:
        emailNotificationEnabled:
          type: boolean
          description: Email notifications enabled/disabled
        ldapEnabled:
          type: boolean
          description: LDAP Backend enabled/disabled
        passwordResetEnabled:
          type: boolean
          description: Password Reset Feature enabled/disabled
        radiusEnabled:
          type: boolean
          description: RADIUS Backend enabled/disabled
        tenantNumber:
          type: integer
          description: Total number of tenants
          format: int32
    LoginMessageSerializer:
      title: LoginMessageSerializer
      required:
      - message
      type: object
      properties:
        message:
          type: string
        uuid:
          type: string
    NotificationConfigSerializer:
      title: NotificationConfigSerializer
      type: object
      properties:
        confirmLinkPath:
          type: string
          description: Path on server of confirm email page - for example, uac/#/confirm-email for the uac-ui app.Don't change this field unless you really know what you're doing.
        emailLinkServer:
          type: string
          description: Hostname/IP to use in links in email alerts (Reset password and first time account setup emails)
        enabled:
          type: boolean
          description: Whether email support is enabled
        resetLinkPath:
          type: string
          description: Path on server of reset password page - for example, uac/#/set-password for the uac-ui app.Don't change this field unless you really know what you're doing.
        uuid:
          type: string
    OAuth2TokenSerializer:
      title: OAuth2TokenSerializer
      type: object
      properties:
        accessToken:
          type: string
        createdTime:
          type: string
          format: date-time
        expirationTime:
          type: string
          format: date-time
        expiresIn:
          type: integer
          description: Token expires in timeout seconds from created time
          format: int32
        failedLoginAttempts:
          type: integer
          format: int32
        inactiveExpirationTime:
          type: string
          format: date-time
        isSuccessful:
          type: string
          description: Deprecated. Only successfull logins are stored.
        lastSuccessIpAddress:
          type: string
        lastSuccessLogin:
          type: string
          format: date-time
        loginDetail:
          type: string
        radiusState:
          type: string
          description: Represents the Access-Challenge State attribute
        tokenType:
          type: string
        user:
          type: string
        userTenantUuid:
          type: string
    PartitionSerializer:
      title: PartitionSerializer
      required:
      - name
      type: object
      properties:
        createdTime:
          type: string
          format: date-time
        description:
          type: string
          description: description
        displayName:
          type: string
          description: display name, same as name if not provided
        isActive:
          type: boolean
          description: Designates whether this partition should be treated as active.
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Partition name
        uuid:
          type: string
    PasswordPolicySerializer:
      title: PasswordPolicySerializer
      required:
      - name
      type: object
      properties:
        createdTime:
          type: string
          format: date-time
        description:
          type: string
          description: Password policy description
        emailPasswordExpirationDailyNotifications:
          type: integer
          description: Number of days before password expires to send emails. One email sent per day.
          format: int32
        emailPasswordExpirationWeeklyNotifications:
          type: integer
          description: Number of weeks before password expires to send emails. One email sent per week.
          format: int32
        enableLockout:
          type: boolean
        failedLoginAttempts:
          type: integer
          format: int32
        historySize:
          type: integer
          format: int32
        lockoutDurationMinutes:
          type: integer
          format: int32
        lockoutNonChangedDays:
          type: integer
          format: int32
        minimumChangeDays:
          type: integer
          format: int32
        minimumDigits:
          type: integer
          format: int32
        minimumLowercase:
          type: integer
          format: int32
        minimumPasswordLength:
          type: integer
          format: int32
        minimumSpecialChars:
          type: integer
          format: int32
        minimumUppercase:
          type: integer
          format: int32
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Policy name
        passwordChangeDays:
          type: integer
          format: int32
        passwordExpirationWarningPeriod:
          type: integer
          description: Number of days before the password expires to provide notifications.
          format: int32
        requireDigits:
          type: string
        requireMixedCase:
          type: string
        requirePeriodicChange:
          type: boolean
        requireSpecialChars:
          type: string
        tenant:
          type: string
          description: Tenant UUID, if not provided "master" tenant is used
        uuid:
          type: string
    PermissionSerializer:
      title: PermissionSerializer
      required:
      - displayName
      - name
      - operation
      - standby
      type: object
      properties:
        category:
          type: string
          description: Permission Category
        createdTime:
          type: string
          format: date-time
        customerModifiable:
          type: boolean
          description: Can the customer modify or delete this Permission?  Used to prevent changes to default Permissions.
        description:
          type: string
          description: Permission Description
        displayName:
          type: string
          description: Display name, same as name if not provided
        isDefault:
          type: boolean
          description: Default permissions status
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Permission name
        operation:
          type: string
          description: HTTP Operation like GET/POST
        resources:
          type: array
          items:
            type: string
          description: ''
        resourcesAlways:
          type: array
          items:
            type: string
          description: ''
        resourcesConditional:
          type: array
          items:
            type: string
          description: ''
        resourcesNever:
          type: array
          items:
            type: string
          description: ''
        standby:
          type: boolean
        uuid:
          type: string
    PermissionResourcesSerializer:
      title: PermissionResourcesSerializer
      required:
      - resources
      type: object
      properties:
        resources:
          type: array
          items:
            type: string
          description: list of resource uuids
    RADIUSConfigSerializer:
      title: RADIUSConfigSerializer
      required:
      - name
      - serverIp
      - tenant
      type: object
      properties:
        authoritativeRoleSource:
          type: boolean
          description: True if your RADIUS keeps a list of users' roles
        authport:
          type: integer
          format: int32
        createdTime:
          type: string
          format: date-time
        description:
          type: string
          description: RADIUS config description
        enabled:
          type: boolean
          description: Activate this RADIUS configuration, if false, configuration exists in database but will not be used
        heartbeatUser:
          type: string
          description: Heartbeat user
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: RADIUS config name
        retries:
          type: integer
          format: int32
        roleMap:
          type: string
          description: Dictionary string that maps radius group/role to tron role
        serverIp:
          type: string
        tenant:
          type: string
          description: Tenant name
        timeout:
          type: integer
          description: Timeout in seconds for attempts to talk to the RADIUS server. Range is 1 to 60.
          format: int32
        uuid:
          type: string
    RegistrationSerializer:
      title: RegistrationSerializer
      required:
      - email
      - firstName
      - lastName
      - username
      type: object
      properties:
        email:
          type: string
          description: user's email address
        firstName:
          type: string
          description: user's first name
        lastName:
          type: string
          description: user's last name
        tenant:
          type: string
          description: tenant UUID of user, if not provided "master" tenant is used
        username:
          type: string
          description: User's username
        uuid:
          type: string
    ApproveUserSerializer:
      title: ApproveUserSerializer
      required:
      - registrations
      type: object
      properties:
        registrations:
          type: array
          items:
            type: string
          description: list of registration uuids
    BaseResponseSerializer:
      title: BaseResponseSerializer
      required:
      - status
      type: object
      properties:
        status:
          type: string
    EmailTokenSerializer:
      title: EmailTokenSerializer
      required:
      - token
      type: object
      properties:
        token:
          type: string
          description: Token from the email
    EmailVerificationSerializer:
      title: EmailVerificationSerializer
      required:
      - email
      type: object
      properties:
        email:
          type: string
          description: user's email address
        tenant:
          type: string
          description: tenant name
    SetPasswordSerializer:
      title: SetPasswordSerializer
      required:
      - password
      - token
      type: object
      properties:
        password:
          type: string
          description: user's new password
        token:
          type: string
          description: token from the forgot password email
    ResourceSerializer:
      title: ResourceSerializer
      required:
      - name
      - resource
      type: object
      properties:
        createdTime:
          type: string
          format: date-time
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Resource name
        resource:
          type: string
          description: HTTP Resource like api/v1/users
        uuid:
          type: string
    RoleSerializer:
      title: RoleSerializer
      required:
      - displayName
      - name
      type: object
      properties:
        allPartitions:
          type: boolean
          description: Ignore partitions field and enable all active available partitions
        application:
          type: string
          description: Application uuid, if not provided default "BluePlanet" app is used
        bypassDormancy:
          type: boolean
          description: Whether or not users with this role are exempt from the effects of dormancy.
        createdTime:
          type: string
          format: date-time
        customerModifiable:
          type: boolean
          description: Can the customer modify or delete this Role?  Used to prevent changes to default Roles.
        description:
          type: string
          description: description
        displayName:
          type: string
          description: display name, same as name if not provided
        isInternal:
          type: boolean
          description: Internal role
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Role name
        parents:
          type: array
          items:
            type: string
          description: ''
        partitions:
          type: array
          items:
            type: string
          description: ''
        permissions:
          type: array
          items:
            type: string
          description: ''
        reservedSessions:
          type: integer
          description: The maximum number of concurrent sessions per role. (0=infinity)
          format: int32
        uuid:
          type: string
    RoleParentsSerializer:
      title: RoleParentsSerializer
      required:
      - parents
      type: object
      properties:
        parents:
          type: array
          items:
            type: string
          description: list of role uuids
    RolePartitionSerializer:
      title: RolePartitionSerializer
      required:
      - partitions
      type: object
      properties:
        partitions:
          type: array
          items:
            type: string
          description: list of partition uuids
    RolePermissionsSerializer:
      title: RolePermissionsSerializer
      required:
      - permissions
      type: object
      properties:
        permissions:
          type: array
          items:
            type: string
          description: list of permission uuids
    RoleUsersSerializer:
      title: RoleUsersSerializer
      required:
      - users
      type: object
      properties:
        users:
          type: array
          items:
            type: string
          description: list of user uuids
    RoleReservedSessionsSerializer:
      title: RoleReservedSessionsSerializer
      required:
      - reservedSessions
      type: object
      properties:
        reservedSessions:
          type: integer
          description: The maximum number of concurrent sessions per role. (0=infinity)
          format: int32
    SessionSerializer:
      title: SessionSerializer
      required:
      - ipAddress
      - sessionId
      - sessionType
      - tenantId
      - tenantname
      - time
      - userAgent
      - userId
      - username
      type: object
      properties:
        ipAddress:
          type: string
        sessionId:
          type: string
        sessionType:
          type: string
        tenantId:
          type: string
        tenantname:
          type: string
        time:
          type: string
          format: date-time
        userAgent:
          type: string
        userId:
          type: string
        username:
          type: string
    TenantSerializer:
      title: TenantSerializer
      required:
      - name
      - parent
      type: object
      properties:
        clientInactivityTime:
          type: integer
          description: timeout in seconds of inactivity
          format: int32
        concurrentSessionMax:
          type: integer
          description: The maximum number of concurrent sessions for tenant users. (0=infinity)
          format: int32
        concurrentSessionMaxPerTenant:
          type: integer
          description: The maximum number of concurrent sessions per tenant. (0=infinity)
          format: int32
        createdTime:
          type: string
          format: date-time
        description:
          type: string
          description: Tenant description
        displayName:
          type: string
          description: Tenant display name
        dormancyDays:
          type: integer
          description: number of days before an account can become dormant
          format: int32
        emailDormancyDailyNotifications:
          type: integer
          description: Number of days before dormancy to send emails. One email sent per day.
          format: int32
        emailDormancyWeeklyNotifications:
          type: integer
          description: Number of weeks before dormancy to send emails. One email sent per week.
          format: int32
        isActive:
          type: boolean
          description: Designates whether this tenant should be treated as active. If Tenant is not active, none of its users can be authenticated
        isMaster:
          type: boolean
          description: Marks a tenant as Master, only one should be true
        message:
          type: string
          description: Message to be displayed after the user logs-in. Can be text, html, etc..
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Tenant name
        parent:
          type: string
          description: Parent tenant UUID
        tokenExpirationTime:
          type: integer
          description: token expires in timeout seconds from created time
          format: int32
        type:
          type: string
          description: Tenant type
        uuid:
          type: string
    TokenSerializer:
      title: TokenSerializer
      type: object
      properties:
        createdTime:
          type: string
          format: date-time
        failedLoginAttempts:
          type: integer
          format: int32
        inactiveExpirationTime:
          type: string
          format: date-time
        isSuccessful:
          type: string
          description: Deprecated. Only successfull logins are stored.
        lastSuccessIpAddress:
          type: string
        lastSuccessLogin:
          type: string
          format: date-time
        loginDetail:
          type: string
        radiusState:
          type: string
          description: Represents the Access-Challenge State attribute
        timeout:
          type: integer
          description: Seconds
          format: int32
        token:
          type: string
        user:
          type: string
        userTenantUuid:
          type: string
    TenantContextSerializer:
      title: TenantContextSerializer
      required:
      - tenantContext
      type: object
      properties:
        tenantContext:
          type: string
          description: Tenant name, request token for this tenant
    UserGroupSerializer:
      title: UserGroupSerializer
      required:
      - name
      type: object
      properties:
        clientInactivityTime:
          type: integer
          description: timeout in seconds of inactivity
          format: int32
        concurrentSessionMax:
          type: integer
          description: The maximum number of concurrent sessions. (0=infinity)
          format: int32
        createdTime:
          type: string
          format: date-time
        description:
          type: string
          description: description
        dormancyDays:
          type: integer
          description: number of days before an account can become dormant
          format: int32
        modifiedTime:
          type: string
          format: date-time
        name:
          type: string
          description: Group name
        parents:
          type: array
          items:
            type: string
          description: ''
        resolvedClientInactivityTime:
          type: string
        resolvedDormancyDays:
          type: string
        resolvedTokenExpirationTime:
          type: string
        roles:
          type: array
          items:
            type: string
          description: ''
        tokenExpirationTime:
          type: integer
          description: token expires in timeout seconds from created time
          format: int32
        uuid:
          type: string
    UserGroupParentsSerializer:
      title: UserGroupParentsSerializer
      required:
      - parents
      type: object
      properties:
        parents:
          type: array
          items:
            type: string
          description: list of user group uuids
    UserRoleSerializer:
      title: UserRoleSerializer
      required:
      - roles
      type: object
      properties:
        roles:
          type: array
          items:
            type: string
          description: list of role uuids
    UserGroupUsersSerializer:
      title: UserGroupUsersSerializer
      required:
      - users
      type: object
      properties:
        users:
          type: array
          items:
            type: string
          description: list of user uuids
    UserTenantSerializer:
      title: UserTenantSerializer
      required:
      - accessibleTenants
      type: object
      properties:
        accessibleTenants:
          type: array
          items:
            type: string
          description: list of tenant uuids
    UserUserGroupSerializer:
      title: UserUserGroupSerializer
      required:
      - usergroups
      type: object
      properties:
        usergroups:
          type: array
          items:
            type: string
          description: list of group uuids
    ResetPasswordSerializer:
      title: ResetPasswordSerializer
      required:
      - newPassword
      - newPasswordConfirm
      type: object
      properties:
        currentPassword:
          type: string
          description: Not required for reset_password,required for set_password if user's password is set at least once
        force:
          type: boolean
          description: Allow admin to skip password checks
        newPassword:
          type: string
          description: user's new password
        newPasswordConfirm:
          type: string
          description: Should match newPassword
    PasswordSerializer:
      title: PasswordSerializer
      required:
      - newPassword
      - newPasswordConfirm
      type: object
      properties:
        currentPassword:
          type: string
          description: Not required for reset_password,required for set_password if user's password is set at least once
        newPassword:
          type: string
          description: user's new password
        newPasswordConfirm:
          type: string
          description: Should match newPassword
    ModulationClassTypes:
      title: ModulationClassTypes
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      type: integer
    TerminationEquipmentType:
      title: TerminationEquipmentType
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 36
      - 37
      - 38
      - 39
      - 40
      - 41
      - 42
      - 43
      - 44
      - 45
      - 46
      - 47
      - 48
      - 49
      - 50
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 97
      - 98
      - 99
      - 100
      - 101
      - 102
      - 103
      - 104
      - 105
      - 106
      - 107
      - 108
      - 109
      - 110
      - 111
      - 112
      - 113
      - 114
      - 115
      - 116
      - 117
      - 118
      - 119
      - 120
      - 121
      - 122
      - 123
      - 124
      - 125
      - 126
      - 127
      - 128
      - 129
      - 130
      - 131
      - 132
      - 133
      - 134
      - 135
      - 136
      - 137
      - 138
      - 139
      - 140
      - 141
      - 142
      - 143
      - 144
      - 145
      - 146
      - 147
      - 148
      - 149
      - 150
      - 151
      - 152
      - 153
      - 154
      - 155
      - 156
      - 157
      - 158
      - 159
      - 160
      - 161
      - 162
      - 163
      - 164
      - 165
      - 166
      - 167
      - 168
      - 169
      - 170
      - 171
      - 172
      - 173
      - 174
      - 175
      - 176
      - 177
      - 178
      - 179
      - 180
      - 181
      - 182
      - 183
      - 184
      - 185
      - 186
      - 187
      - 188
      - 189
      - 190
      - 191
      - 192
      - 193
      - 194
      - 195
      - 196
      - 197
      - 198
      - 199
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 219
      - 220
      - 221
      - 222
      - 223
      - 224
      - 225
      - 226
      - 227
      - 228
      - 229
      - 230
      - 231
      - 232
      - 233
      - 234
      - 235
      - 236
      - 237
      - 238
      - 239
      - 240
      - 241
      - 242
      - 243
      - 244
      - 245
      - 246
      - 247
      - 248
      - 249
      - 250
      - 251
      - 252
      - 253
      - 254
      - 255
      - 256
      - 257
      - 258
      - 259
      - 260
      - 261
      - 262
      - 263
      - 264
      - 265
      - 266
      - 267
      - 268
      - 269
      - 270
      - 271
      - 272
      - 273
      - 274
      - 275
      - 276
      - 277
      - 278
      - 279
      - 280
      - 281
      - 282
      - 283
      - 284
      - 285
      - 286
      - 287
      - 288
      - 289
      - 290
      - 291
      - 292
      - 293
      - 294
      - 295
      - 296
      - 297
      - 298
      - 299
      - 300
      - 301
      - 302
      - 303
      - 304
      - 305
      - 306
      - 307
      - 308
      - 309
      - 310
      - 311
      - 312
      - 313
      - 314
      - 315
      - 316
      - 317
      - 318
      - 319
      - 320
      - 321
      - 322
      - 323
      - 324
      - 325
      - 326
      - 327
      - 328
      - 329
      - 330
      - 331
      - 332
      - 333
      - 334
      - 335
      - 336
      - 337
      - 338
      - 339
      - 340
      - 341
      - 342
      - 343
      - 344
      - 345
      - 346
      - 347
      - 348
      - 349
      - 350
      - 351
      - 352
      - 353
      - 354
      - 355
      - 356
      - 357
      - 358
      - 359
      - 360
      - 361
      - 362
      - 363
      - 364
      - 365
      - 366
      - 367
      - 368
      - 369
      - 370
      - 371
      - 372
      - 373
      - 374
      - 375
      - 376
      - 377
      - 378
      - 379
      - 380
      - 381
      - 382
      - 383
      - 384
      - 385
      - 386
      - 387
      - 388
      - 389
      - 390
      - 391
      - 392
      - 393
      - 394
      - 395
      - 396
      - 397
      - 398
      - 399
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 411
      - 412
      - 413
      - 414
      - 415
      - 416
      - 417
      - 418
      - 419
      - 420
      - 421
      - 422
      - 423
      - 424
      - 425
      - 426
      - 427
      - 428
      - 429
      - 430
      - 431
      - 432
      - 433
      - 434
      - 435
      - 436
      - 437
      - 438
      - 439
      - 440
      - 441
      - 442
      - 443
      - 444
      - 445
      - 446
      - 447
      - 448
      - 449
      - 450
      - 451
      - 452
      - 453
      - 454
      - 455
      - 456
      - 457
      - 458
      - 459
      - 460
      - 461
      - 462
      - 463
      - 464
      - 465
      - 466
      - 467
      - 468
      - 469
      - 470
      - 471
      - 472
      - 473
      - 474
      - 475
      - 476
      - 477
      - 478
      - 479
      - 480
      - 481
      - 482
      - 483
      - 484
      - 485
      - 486
      - 487
      - 488
      - 489
      - 490
      - 491
      - 492
      - 493
      - 494
      - 495
      - 496
      - 497
      - 498
      - 499
      - 500
      - 501
      - 502
      - 503
      - 504
      - 505
      - 506
      - 507
      - 508
      - 509
      - 510
      - 511
      - 512
      - 513
      - 514
      - 515
      - 516
      - 517
      - 518
      - 519
      - 520
      - 521
      - 522
      - 523
      - 524
      - 525
      - 526
      - 527
      - 528
      - 529
      - 530
      - 531
      - 532
      - 533
      - 534
      - 535
      - 536
      - 537
      - 538
      - 539
      - 540
      - 541
      - 542
      - 543
      - 544
      - 545
      - 546
      - 547
      - 548
      - 549
      - 550
      - 551
      - 552
      - 553
      - 554
      - 555
      - 556
      - 557
      - 558
      - 559
      - 560
      - 561
      - 562
      - 563
      - 564
      - 565
      - 566
      - 567
      - 568
      - 569
      - 570
      - 571
      - 572
      - 573
      - 574
      - 575
      - 576
      - 577
      - 578
      - 579
      - 580
      - 581
      - 582
      - 583
      - 584
      - 585
      - 586
      - 587
      - 588
      - 589
      - 590
      - 591
      - 592
      - 593
      - 594
      - 595
      - 596
      - 597
      - 598
      - 599
      - 600
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      - 609
      - 610
      - 611
      - 612
      - 613
      - 614
      - 615
      - 616
      - 617
      - 618
      - 619
      - 620
      - 621
      - 622
      - 623
      - 624
      - 625
      - 626
      - 627
      - 628
      - 629
      - 630
      - 631
      - 632
      - 633
      - 634
      - 635
      - 636
      - 637
      - 638
      - 639
      - 640
      - 641
      - 642
      - 643
      - 644
      - 645
      - 646
      - 647
      - 648
      - 649
      - 650
      - 651
      - 652
      - 653
      - 654
      - 655
      - 656
      - 657
      - 658
      - 659
      - 660
      - 661
      - 662
      - 663
      - 664
      - 665
      - 666
      - 667
      - 668
      - 669
      - 670
      - 671
      - 672
      - 673
      - 674
      - 675
      - 676
      - 677
      - 678
      - 679
      - 680
      - 681
      - 682
      - 683
      - 684
      - 685
      - 686
      - 687
      - 688
      - 689
      - 690
      - 691
      - 692
      - 693
      - 694
      - 695
      - 696
      - 697
      - 698
      - 699
      - 700
      - 701
      - 702
      - 703
      - 704
      - 705
      - 706
      - 707
      - 708
      - 709
      - 710
      - 711
      - 712
      - 713
      - 714
      - 715
      - 716
      - 717
      - 718
      - 719
      - 720
      - 721
      - 722
      - 723
      - 724
      - 725
      - 726
      - 727
      - 728
      - 729
      - 730
      - 731
      - 732
      - 733
      - 734
      - 735
      - 736
      - 737
      - 738
      - 739
      - 740
      - 741
      - 742
      - 743
      - 744
      - 745
      - 746
      - 747
      - 748
      - 749
      - 750
      - 751
      - 752
      - 753
      - 754
      - 755
      - 756
      - 757
      - 758
      - 759
      - 760
      - 761
      - 762
      - 763
      - 764
      - 765
      - 766
      - 767
      - 768
      - 769
      - 770
      - 771
      - 772
      - 773
      - 774
      - 775
      - 776
      - 777
      - 778
      - 779
      - 780
      - 781
      - 782
      - 783
      - 784
      - 785
      - 786
      - 787
      - 788
      - 789
      - 790
      - 791
      - 792
      - 793
      - 794
      - 795
      - 796
      - 797
      - 798
      - 799
      - 800
      - 801
      - 802
      - 803
      - 804
      - 805
      - 806
      - 807
      - 808
      - 809
      - 810
      - 811
      - 812
      - 813
      - 814
      - 815
      - 816
      - 817
      - 818
      - 819
      - 820
      - 821
      - 822
      - 823
      - 824
      - 825
      - 826
      - 827
      - 828
      - 829
      - 830
      - 831
      - 832
      - 833
      - 834
      - 835
      - 836
      - 837
      - 838
      - 839
      - 840
      - 841
      - 842
      - 843
      - 844
      - 845
      - 846
      - 847
      - 848
      - 849
      - 850
      - 851
      - 852
      - 853
      - 854
      - 855
      - 856
      - 857
      - 858
      - 859
      - 860
      - 861
      - 862
      - 863
      - 864
      - 865
      - 866
      - 867
      - 868
      - 869
      - 870
      - 871
      - 872
      - 873
      - 874
      - 875
      - 876
      - 877
      - 878
      - 879
      - 880
      - 881
      - 882
      - 883
      - 884
      - 885
      - 886
      - 887
      - 888
      - 889
      - 890
      - 891
      - 892
      - 893
      - 894
      - 895
      - 896
      - 897
      - 898
      - 899
      - 900
      - 901
      - 902
      - 903
      - 904
      - 905
      - 906
      - 907
      - 908
      - 909
      - 910
      - 911
      - 912
      - 913
      - 914
      - 915
      - 916
      - 917
      - 918
      - 919
      - 920
      - 921
      - 922
      - 923
      - 924
      - 925
      - 926
      - 927
      - 928
      - 929
      - 930
      - 931
      - 932
      - 933
      - 934
      - 935
      - 936
      - 937
      - 938
      - 939
      - 940
      - 941
      - 942
      - 943
      - 944
      - 945
      - 946
      - 947
      - 948
      - 949
      - 950
      - 951
      - 952
      - 953
      - 954
      - 955
      - 956
      - 957
      - 958
      - 959
      - 960
      - 961
      - 962
      - 963
      - 964
      - 965
      - 966
      - 967
      - 968
      - 969
      - 970
      - 971
      - 972
      - 973
      - 974
      - 975
      - 976
      - 977
      - 978
      - 979
      - 980
      - 981
      - 982
      - 983
      - 984
      - 985
      - 986
      - 987
      - 988
      - 989
      - 990
      - 991
      - 992
      - 993
      - 994
      - 995
      - 996
      - 997
      - 998
      - 999
      - 1000
      - 1001
      - 1002
      - 1003
      - 1004
      - 1005
      - 1006
      - 1007
      - 1008
      - 1009
      - 1010
      - 1011
      - 1012
      - 1013
      - 1014
      - 1015
      - 1016
      - 1017
      - 1018
      - 1019
      - 1020
      - 1021
      - 1022
      - 1023
      - 1024
      - 1025
      - 1026
      - 1027
      - 1028
      - 1029
      - 1030
      - 1031
      - 1032
      - 1033
      - 1034
      - 1035
      - 1036
      - 1037
      - 1038
      - 1039
      - 1040
      - 1041
      - 1042
      - 1043
      - 1044
      - 1045
      - 1046
      - 1047
      - 1048
      - 1049
      - 1050
      - 1051
      - 1052
      - 1053
      - 1054
      - 1055
      - 1056
      - 1057
      - 1058
      - 1059
      - 1060
      - 1061
      - 1062
      - 1063
      - 1064
      - 1065
      - 1066
      - 1067
      - 1068
      - 1069
      - 1070
      - 1071
      - 1072
      - 1073
      - 1074
      - 1075
      - 1076
      - 1077
      - 1078
      - 1079
      - 1080
      - 1081
      - 1082
      - 1083
      - 1084
      - 1085
      - 1086
      - 1087
      - 1088
      - 1089
      - 1090
      - 1091
      - 1092
      - 1093
      - 1094
      - 1095
      - 1096
      - 1097
      - 1098
      - 1099
      - 1100
      - 1101
      - 1102
      - 1103
      - 1104
      - 1105
      - 1106
      - 1107
      - 1108
      - 1109
      - 1110
      - 1111
      - 1112
      - 1113
      - 1114
      - 1115
      - 1116
      - 1117
      - 1118
      - 1119
      - 1120
      - 1121
      - 1122
      - 1123
      - 1124
      - 1125
      - 1126
      - 1127
      - 1128
      - 1129
      - 1130
      - 1131
      - 1132
      - 1133
      - 1134
      - 1135
      - 1136
      - 1137
      - 1138
      - 1139
      - 1140
      - 1141
      - 1142
      - 1143
      - 1144
      - 1145
      - 1146
      - 1147
      - 1148
      - 1149
      - 1150
      - 1151
      - 1152
      - 1153
      - 1154
      - 1155
      - 1156
      - 1157
      - 1158
      - 1159
      - 1160
      - 1161
      - 1162
      - 1163
      - 1164
      - 1165
      - 1166
      - 1167
      - 1168
      - 1169
      - 1170
      - 1171
      - 1172
      - 1173
      - 1174
      - 1175
      - 1176
      - 1177
      - 1178
      - 1179
      - 1180
      - 1181
      - 1182
      - 1183
      - 1184
      - 1185
      - 1186
      - 1187
      - 1188
      - 1189
      - 1190
      - 1191
      - 1192
      - 1193
      - 1194
      - 1195
      - 1196
      - 1197
      - 1198
      - 1199
      - 1200
      - 1201
      - 1202
      - 1203
      - 1204
      - 1205
      - 1206
      - 1207
      - 1208
      - 1209
      - 1210
      - 1211
      - 1212
      - 1213
      - 1214
      - 1215
      - 1216
      - 1217
      - 1218
      - 1219
      - 1220
      - 1221
      - 1222
      - 1223
      - 1224
      - 1225
      - 1226
      - 1227
      - 1228
      - 1229
      - 1230
      - 1231
      - 1232
      - 1233
      - 1234
      - 1235
      - 1236
      - 1237
      - 1238
      - 1239
      - 1240
      - 1241
      - 1242
      - 1243
      - 1244
      - 1245
      - 1246
      - 1247
      - 1248
      - 1249
      - 1250
      - 1251
      - 1252
      - 1253
      - 1254
      - 1255
      - 1256
      - 1257
      - 1258
      - 1259
      - 1260
      - 1261
      - 1262
      - 1263
      - 1264
      - 1265
      - 1266
      - 1267
      - 1268
      - 1269
      - 1270
      - 1271
      - 1272
      - 1273
      - 1274
      - 1275
      - 1276
      - 1277
      - 1278
      - 1279
      - 1280
      - 1281
      - 1282
      - 1283
      - 1284
      - 1285
      - 1286
      - 1287
      - 1288
      - 1289
      - 1290
      - 1291
      - 1292
      - 1293
      - 1294
      - 1295
      - 1296
      - 1297
      - 1298
      - 1299
      - 1300
      - 1301
      - 1302
      - 1303
      - 1304
      - 1305
      - 1306
      - 1307
      - 1308
      - 1309
      - 1310
      - 1311
      - 1312
      - 1313
      - 1314
      - 1315
      - 1316
      - 1317
      - 1318
      - 1319
      - 1320
      - 1321
      - 1322
      - 1323
      - 1324
      - 1325
      - 1326
      - 1327
      - 1328
      - 1329
      - 1330
      - 1331
      - 1332
      - 1333
      - 1334
      - 1335
      - 1336
      - 1337
      - 1338
      - 1339
      - 1340
      - 1341
      - 1342
      - 1343
      - 1344
      - 1345
      - 1346
      - 1347
      - 1348
      - 1349
      - 1350
      - 1351
      - 1352
      - 1353
      - 1354
      - 1355
      - 1356
      - 1357
      - 1358
      - 1359
      - 1360
      - 1361
      - 1362
      - 1363
      - 1364
      - 1365
      - 1366
      - 1367
      - 1368
      - 1369
      - 1370
      - 1371
      - 1372
      - 1373
      - 1374
      - 1375
      - 1376
      - 1377
      - 1378
      - 1379
      - 1380
      - 1381
      - 1382
      - 1383
      - 1384
      - 1385
      - 1386
      - 1387
      - 1388
      - 1389
      - 1390
      - 1391
      - 1392
      - 1393
      - 1394
      - 1395
      - 1396
      - 1397
      - 1398
      - 1399
      - 1400
      - 1401
      - 1402
      - 1403
      - 1404
      - 1405
      - 1406
      - 1407
      - 1408
      - 1409
      - 1410
      - 1411
      - 1412
      - 1413
      - 1414
      - 1415
      - 1416
      - 1417
      - 1418
      - 1419
      - 1420
      - 1421
      - 1422
      - 1423
      - 1424
      - 1425
      - 1426
      - 1427
      - 1428
      - 1429
      - 1430
      - 1431
      - 1432
      - 1433
      - 1434
      - 1435
      - 1436
      - 1437
      - 1438
      - 1439
      - 1440
      - 1441
      - 1442
      - 1443
      - 1444
      - 1445
      - 1446
      - 1447
      - 1448
      - 1449
      - 1450
      - 1451
      - 1452
      - 1453
      - 1454
      - 1455
      - 1456
      - 1457
      - 1458
      - 1459
      - 1460
      - 1461
      - 1462
      - 1463
      - 1464
      - 1465
      - 1466
      - 1467
      - 1468
      - 1469
      - 1470
      - 1471
      - 1472
      - 1473
      - 1474
      - 1475
      - 1476
      - 1477
      - 1478
      - 1479
      - 1480
      - 1481
      - 1482
      - 1483
      - 1484
      - 1485
      - 1486
      - 1487
      - 1488
      - 1489
      - 1490
      - 1491
      - 1492
      - 1493
      - 1494
      - 1495
      - 1496
      - 1497
      - 1498
      - 1499
      - 1500
      - 1501
      - 1502
      - 1503
      - 1504
      - 1505
      - 1506
      - 1507
      - 1508
      - 1509
      - 1510
      - 1511
      - 1512
      - 1513
      - 1514
      - 1515
      - 1516
      - 1517
      - 1518
      - 1519
      - 1520
      - 1521
      - 1522
      - 1523
      - 1524
      - 1525
      - 1526
      - 1527
      - 1528
      - 1529
      - 1530
      - 1531
      - 1532
      - 1533
      - 1534
      - 1535
      - 1536
      - 1537
      - 1538
      - 1539
      - 1540
      - 1541
      - 1542
      - 1543
      - 1544
      - 1545
      - 1546
      - 1547
      - 1548
      - 1549
      - 1550
      - 1551
      - 1552
      - 1553
      - 1554
      - 1555
      - 1556
      - 1557
      - 1558
      - 1559
      - 1560
      - 1561
      - 1562
      - 1563
      - 1564
      - 1565
      - 1566
      - 1567
      - 1568
      - 1569
      - 1570
      - 1571
      - 1572
      - 1573
      - 1574
      - 1575
      - 1576
      - 1577
      - 1578
      - 1579
      - 1580
      - 1581
      - 1582
      - 1583
      - 1584
      - 1585
      - 1586
      - 1587
      - 1588
      - 1589
      - 1590
      - 1591
      - 1592
      - 1593
      - 1594
      - 1595
      - 1596
      - 1597
      - 1598
      - 1599
      - 1600
      - 1601
      - 1602
      - 1603
      - 1604
      - 1605
      - 1606
      - 1607
      - 1608
      - 1609
      - 1610
      - 1611
      - 1612
      - 1613
      - 1614
      - 1615
      - 1616
      - 1617
      - 1618
      - 1619
      - 1620
      - 1621
      - 1622
      - 1623
      - 1624
      - 1625
      - 1626
      - 1627
      - 1628
      - 1629
      - 1630
      - 1631
      - 1632
      - 1633
      - 1634
      - 1635
      - 1636
      - 1637
      - 1638
      - 1639
      - 1640
      - 1641
      - 1642
      - 1643
      - 1644
      - 1645
      - 1646
      - 1647
      - 1648
      - 1649
      - 1650
      - 1651
      - 1652
      - 1653
      - 1654
      - 1655
      - 1656
      - 1657
      - 1658
      - 1659
      - 1660
      - 1661
      - 1662
      - 1663
      - 1664
      - 1665
      - 1666
      - 1667
      - 1668
      - 1669
      - 1670
      - 1671
      - 1672
      - 1673
      - 1674
      - 1675
      - 1676
      - 1677
      - 1678
      - 1679
      - 1680
      - 1681
      - 1682
      - 1683
      - 1684
      - 1685
      - 1686
      - 1687
      - 1688
      - 1689
      - 1690
      - 1691
      - 1692
      - 1693
      - 1694
      - 1695
      - 1696
      - 1697
      - 1698
      - 1699
      - 1700
      - 1701
      - 1702
      - 1703
      - 1704
      - 1705
      - 1706
      - 1707
      - 1708
      - 1709
      - 1710
      - 1711
      - 1712
      - 1713
      - 1714
      - 1715
      - 1716
      - 1717
      - 1718
      - 1719
      - 1720
      - 1721
      - 1722
      - 1723
      - 1724
      - 1725
      - 1726
      - 1727
      - 1728
      - 1729
      - 1730
      - 1731
      - 1732
      - 1733
      - 1734
      - 1735
      - 1736
      - 1737
      - 1738
      - 1739
      - 1740
      - 1741
      - 1742
      - 1743
      - 1744
      - 1745
      - 1746
      - 1747
      - 1748
      - 1749
      - 1750
      - 1751
      - 1752
      - 1753
      - 1754
      - 1755
      - 1756
      - 1757
      - 1758
      - 1759
      - 1760
      - 1761
      - 1762
      - 1763
      - 1764
      - 1765
      - 1766
      - 1767
      - 1768
      - 1769
      - 1770
      - 1771
      - 1772
      - 1773
      - 1774
      - 1775
      - 1776
      - 1777
      - 1778
      - 1779
      - 1780
      - 1781
      - 1782
      - 1783
      - 1784
      - 1785
      - 1786
      - 1787
      - 1788
      - 1789
      - 1790
      - 1791
      - 1792
      - 1793
      - 1794
      - 1795
      - 1796
      - 1797
      - 1798
      - 1799
      - 1800
      - 1801
      - 1802
      - 1803
      - 1804
      - 1805
      - 1806
      - 1807
      - 1808
      - 1809
      - 1810
      - 1811
      - 1812
      - 1813
      - 1814
      - 1815
      - 1816
      - 1817
      - 1818
      - 1819
      - 1820
      - 1821
      - 1822
      - 1823
      - 1824
      - 1825
      - 1826
      - 1827
      - 1828
      - 1829
      - 1830
      - 1831
      - 1832
      - 1833
      - 1834
      - 1835
      - 1836
      - 1837
      - 1838
      - 1839
      - 1840
      - 1841
      - 1842
      - 1843
      - 1844
      - 1845
      - 1846
      - 1847
      - 1848
      - 1849
      - 1850
      - 1851
      - 1852
      - 1853
      - 1854
      - 1855
      - 1856
      - 1857
      - 1858
      - 1859
      - 1860
      - 1861
      - 1862
      - 1863
      - 1864
      - 1865
      - 1866
      - 1867
      - 1868
      - 1869
      - 1870
      - 1871
      - 1872
      - 1873
      - 1874
      - 1875
      - 1876
      - 1877
      - 1878
      - 1879
      - 1880
      - 1881
      - 1882
      - 1883
      - 1884
      - 1885
      - 1886
      - 1887
      - 1888
      - 1889
      - 1890
      - 1891
      - 1892
      - 1893
      - 1894
      - 1895
      - 1896
      - 1897
      - 1898
      - 1899
      - 1900
      - 1901
      - 1902
      - 1903
      - 1904
      - 1905
      - 1906
      - 1907
      - 1908
      - 1909
      - 1910
      - 1911
      - 1912
      - 1913
      - 1914
      - 1915
      - 1916
      - 1917
      - 1918
      - 1919
      - 1920
      - 1921
      - 1922
      - 1923
      - 1924
      - 1925
      - 1926
      - 1927
      - 1928
      - 1929
      - 1930
      - 1931
      - 1932
      - 1933
      - 1934
      - 1935
      - 1936
      - 1937
      - 1938
      - 1939
      - 1940
      - 1941
      - 1942
      - 1943
      - 1944
      - 1945
      - 1946
      - 1947
      - 1948
      - 1949
      - 1950
      - 1951
      - 1952
      - 1953
      - 1954
      - 1955
      - 1956
      - 1957
      - 1958
      - 1959
      - 1960
      - 1961
      - 1962
      - 1963
      - 1964
      - 1965
      - 1966
      - 1967
      - 1968
      - 1969
      - 1970
      - 1971
      - 1972
      - 1973
      - 1974
      - 1975
      - 1976
      - 1977
      - 1978
      - 1979
      - 1980
      - 1981
      - 1982
      - 1983
      - 1984
      - 1985
      - 1986
      - 1987
      - 1988
      - 1989
      - 1990
      - 1991
      - 1992
      - 1993
      - 1994
      - 1995
      - 1996
      - 1997
      - 1998
      - 1999
      - 2000
      - 2001
      - 2002
      - 2003
      - 2004
      - 2005
      - 2006
      - 2007
      - 2008
      - 2009
      - 2010
      - 2011
      - 2012
      - 2013
      - 2014
      - 2015
      - 2016
      - 2017
      - 2018
      - 2019
      - 2020
      - 2021
      - 2022
      - 2023
      - 2024
      - 2025
      - 2026
      - 2027
      - 2028
      - 2029
      - 2030
      - 2031
      - 2032
      - 2033
      - 2034
      - 2035
      - 2036
      - 2037
      - 2038
      - 2039
      - 2040
      - 2041
      - 2042
      - 2043
      - 2044
      - 2045
      - 2046
      - 2047
      - 2048
      - 2049
      - 2050
      - 2051
      - 2052
      - 2053
      - 2054
      - 2055
      - 2056
      - 2057
      - 2058
      - 2059
      - 2060
      - 2061
      - 2062
      - 2063
      - 2064
      - 2065
      - 2066
      - 2067
      - 2068
      - 2069
      - 2070
      - 2071
      - 2072
      - 2073
      - 2074
      - 2075
      - 2076
      - 2077
      - 2078
      - 2079
      - 2080
      - 2081
      - 2082
      - 2083
      - 2084
      - 2085
      - 2086
      - 2087
      - 2088
      - 2089
      - 2090
      - 2091
      - 2092
      - 2093
      - 2094
      - 2095
      - 2096
      - 2097
      - 2098
      - 2099
      - 2100
      - 2101
      - 2102
      - 2103
      - 2104
      - 2105
      - 2106
      - 2107
      - 2108
      - 2109
      - 2110
      - 2111
      - 2112
      - 2113
      - 2114
      - 2115
      - 2116
      - 2117
      - 2118
      - 2119
      - 2120
      - 2121
      - 2122
      - 2123
      - 2124
      - 2125
      - 2126
      - 2127
      - 2128
      - 2129
      - 2130
      - 2131
      - 2132
      - 2133
      - 2134
      - 2135
      - 2136
      - 2137
      - 2138
      - 2139
      - 2140
      - 2141
      - 2142
      - 2143
      - 2144
      - 2145
      - 2146
      - 2147
      - 2148
      - 2149
      - 2150
      - 2151
      - 2152
      - 2153
      - 2154
      - 2155
      - 2156
      - 2157
      - 2158
      - 2159
      - 2160
      - 2161
      - 2162
      - 2163
      - 2164
      - 2165
      - 2166
      - 2167
      - 2168
      - 2169
      - 2170
      - 2171
      - 2172
      - 2173
      - 2174
      - 2175
      - 2176
      - 2177
      - 2178
      - 2179
      - 2180
      - 2181
      - 2182
      - 2183
      - 2184
      - 2185
      - 2186
      - 2187
      - 2188
      - 2189
      - 2190
      - 2191
      - 2192
      - 2193
      - 2194
      - 2195
      - 2196
      - 2197
      - 2198
      - 2199
      - 2200
      - 2201
      - 2202
      - 2203
      - 2204
      - 2205
      - 2206
      - 2207
      - 2208
      - 2209
      - 2210
      - 2211
      - 2212
      - 2213
      - 2214
      - 2215
      - 2216
      - 2217
      - 2218
      - 2219
      - 2220
      - 2221
      - 2222
      - 2223
      - 2224
      - 2225
      - 2226
      - 2227
      - 2228
      - 2229
      - 2230
      - 2231
      - 2232
      - 2233
      - 2234
      - 2235
      - 2236
      - 2237
      - 2238
      - 2239
      - 2240
      - 2241
      - 2242
      - 2243
      - 2244
      - 2245
      - 2246
      - 2247
      - 2248
      - 2249
      - 2250
      - 2251
      - 2252
      - 2253
      - 2254
      - 2255
      - 2256
      - 2257
      - 2258
      - 2259
      - 2260
      - 2261
      - 2262
      - 2263
      - 2264
      - 2265
      - 2266
      - 2267
      - 2268
      - 2269
      - 2270
      - 2271
      - 2272
      - 2273
      - 2274
      - 2275
      - 2276
      - 2277
      - 2278
      - 2279
      - 2280
      - 2281
      - 2282
      - 2283
      - 2284
      - 2285
      - 2286
      - 2287
      - 2288
      - 2289
      - 2290
      - 2291
      - 2292
      - 2293
      - 2294
      - 2295
      - 2296
      - 2297
      - 2298
      - 2299
      - 2300
      - 2301
      - 2302
      - 2303
      - 2304
      - 2305
      - 2306
      - 2307
      - 2308
      - 2309
      - 2310
      - 2311
      - 2312
      - 2313
      - 2314
      - 2315
      - 2316
      - 2317
      - 2318
      - 2319
      - 2320
      - 2321
      - 2322
      - 2323
      - 2324
      - 2325
      - 2326
      - 2327
      - 2328
      - 2329
      - 2330
      - 2331
      - 2332
      - 2333
      - 2334
      - 2335
      - 2336
      - 2337
      - 2338
      - 2339
      - 2340
      - 2341
      - 2342
      - 2343
      - 2344
      - 2345
      - 2346
      - 2347
      - 2348
      - 2349
      - 2350
      - 2351
      - 2352
      - 2353
      - 2354
      - 2355
      - 2356
      - 2357
      - 2358
      - 2359
      - 2360
      - 2361
      - 2362
      - 2363
      - 2364
      - 2365
      - 2366
      - 2367
      - 2368
      - 2369
      - 2370
      - 2371
      - 2372
      - 2373
      - 2374
      - 2375
      - 2376
      - 2377
      - 2378
      - 2379
      - 2380
      - 2381
      - 2382
      - 2383
      - 2384
      - 2385
      - 2386
      - 2387
      - 2388
      - 2389
      - 2390
      - 2391
      - 2392
      type: integer
    CmdFilterType:
      title: CmdFilterType
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      type: integer
    WSSType:
      title: WSSType
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      type: integer
    AmpPackageType:
      title: AmpPackageType
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      type: integer
    SplitterCouplerType:
      title: SplitterCouplerType
      enum:
      - 0
      - 1
      - 2
      type: integer
    VpEndPointDetail:
      title: VpEndPointDetail
      required:
      - dwdmInterface
      - cmdType
      type: object
      properties:
        dwdmInterface:
          $ref: '#/components/schemas/TerminationEquipmentType'
        cmdType:
          $ref: '#/components/schemas/CmdFilterType'
        wssType:
          $ref: '#/components/schemas/WSSType'
        diaAmpType:
          $ref: '#/components/schemas/AmpPackageType'
        padList:
          type: string
        splitterCouplerType:
          $ref: '#/components/schemas/SplitterCouplerType'
        coadmAmpType:
          $ref: '#/components/schemas/AmpPackageType'
        demuxAmpType:
          $ref: '#/components/schemas/AmpPackageType'
        diaWssType:
          $ref: '#/components/schemas/WSSType'
        diaSplitterCouplerType:
          $ref: '#/components/schemas/SplitterCouplerType'
    StatusTypes:
      title: StatusTypes
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
    CalcModeTypes:
      title: CalcModeTypes
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
    DispersionShiftFiberTypeTypes:
      title: DispersionShiftFiberTypeTypes
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      type: integer
    LeVerificationCertificationTypes:
      title: LeVerificationCertificationTypes
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
    FailureReasonSeverityTypes:
      title: FailureReasonSeverityTypes
      enum:
      - 0
      - 1
      - 2
      type: integer
    ValidationResult:
      title: ValidationResult
      type: object
      properties:
        calcMode:
          $ref: '#/components/schemas/CalcModeTypes'
        rcvDispersionMargin:
          type: number
        rcvDispersionMarginMax:
          type: number
        optimumDispersionShift:
          type: number
        dispersionShiftFiberType:
          $ref: '#/components/schemas/DispersionShiftFiberTypeTypes'
        lowDispersionMargin:
          type: number
        highDispersionMargin:
          type: number
        simulatedOsnr:
          type: number
        adjustedReceiverOsnr:
          type: number
        rcvOsnrMargin:
          type: number
        rcvPowerMax:
          type: number
        rcvPowerMaxMargin:
          type: number
        rcvPowerMin:
          type: number
        rcvPowerMinMargin:
          type: number
        requiredReceiverPowerMax:
          type: number
        requiredReceiverPowerMin:
          type: number
        transmitterPowerReduction:
          type: number
        leVerificationCertification:
          $ref: '#/components/schemas/LeVerificationCertificationTypes'
        mpi:
          type: number
        prfber:
          type: number
        pmdOutage:
          type: number
        allocMarginPdl:
          type: number
        maxRxPower:
          type: number
        e2pn:
          type: number
        estimatedPadValue:
          type: number
        failureReasonDescription:
          type: string
        failureReasonSeverity:
          $ref: '#/components/schemas/FailureReasonSeverityTypes'
        failureReasonSummary:
          type: string
        failureReasonType:
          type: string
        minOpsRxPowerLevel:
          type: number
    VPOmsRoute:
      title: VPOmsRoute
      required:
      - freid
      - aEndNcid
      - routeIndex
      - zEndNcid
      type: object
      properties:
        freid:
          type: string
        aEndNcid:
          type: string
        aEndNodeName:
          type: string
        omsTlName:
          type: string
        length:
          type: number
        routeIndex:
          type: integer
          format: int64
        zEndNcid:
          type: string
        zEndNodeName:
          type: string
    VpTypeTypes:
      title: VpTypeTypes
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
    McMixTypeTypes:
      title: McMixTypeTypes
      enum:
      - 0
      - 1
      - 2
      type: integer
    VerificationPathDetail:
      title: VerificationPathDetail
      required:
      - vpName
      - aEndVpEndPoint
      - zEndVpEndPoint
      - status
      - vpOmsRoute
      - vpSourceNcid
      - vpDestinationNcid
      type: object
      properties:
        vpName:
          type: string
        amplifiedSpanCount:
          type: integer
          format: int64
        csWavelengthStatusGrid:
          type: string
        fiberLatency:
          type: number
        mateVpName:
          type: string
        maxDispersion:
          type: number
        minDispersion:
          type: number
        modulationClass:
          $ref: '#/components/schemas/ModulationClassTypes'
        aEndVpEndPoint:
          $ref: '#/components/schemas/VpEndPointDetail'
        zEndVpEndPoint:
          $ref: '#/components/schemas/VpEndPointDetail'
        opsEnabled:
          type: boolean
        parentLongPathVpId:
          type: string
        pmd:
          type: number
        status:
          $ref: '#/components/schemas/StatusTypes'
        validationResult:
          $ref: '#/components/schemas/ValidationResult'
        wavelengthInHex:
          type: string
        wavelengthrange:
          type: integer
          format: int64
        vpOmsRoute:
          type: array
          items:
            $ref: '#/components/schemas/VPOmsRoute'
          description: ''
        vpSourceNodeName:
          type: string
        vpDestinationNodeName:
          type: string
        vpSourceNcid:
          type: string
        vpDestinationNcid:
          type: string
        vpType:
          $ref: '#/components/schemas/VpTypeTypes'
        mcMixType:
          $ref: '#/components/schemas/McMixTypeTypes'
        channelSpacing:
          type: number
        startFrequency:
          type: number
        endFrequency:
          type: number
        txSnrBias:
          type: number
    VerificationPathList:
      title: VerificationPathList
      type: object
      properties:
        VerificationPaths:
          type: array
          items:
            $ref: '#/components/schemas/VerificationPathDetail'
          description: ''
    Action:
      title: Action
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        creator:
          type: string
        enabled:
          type: boolean
          description: 'define if the action is enabled : disabled actions are not executed'
        execResult:
          type: string
          description: The object (created) of the last execution of the action
        execStatus:
          type: string
          description: Status of the last execution of the action
        properties:
          type: object
        type:
          type: integer
          format: int32
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        updator:
          type: string
        uuid:
          type: string
        watcherUuid:
          type: string
          description: The uuid of the watcher to which the action belongs to
    ActionCreate:
      title: ActionCreate
      required:
      - type
      type: object
      properties:
        enabled:
          type: boolean
          description: 'define if the action is enabled : disabled actions are not executed'
        properties:
          type: object
          additionalProperties:
            type: object
        type:
          type: string
          description: >-
            The type of the action. This determine the content of the Properties field

            Can be : ALERT
    ActionUpdate:
      title: ActionUpdate
      required:
      - type
      type: object
      properties:
        enabled:
          type: boolean
          description: 'define if the action is enabled : disabled actions are not executed'
        properties:
          type: object
          additionalProperties:
            type: object
        type:
          type: string
          description: >-
            The type of the action. This determine the content of the Properties field

            Can be : ALERT
        uuid:
          type: string
        watcherUuid:
          type: string
    AlarmHolder:
      title: AlarmHolder
      type: object
      properties:
        Data:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RawAlarm'
    AlarmServer:
      title: AlarmServer
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
    AppConfig:
      title: AppConfig
      type: object
      properties:
        schedulerCycle:
          type: integer
          format: int64
        uuid:
          type: string
    BaseAppConfig:
      title: BaseAppConfig
      type: object
      properties:
        schedulerCycle:
          type: integer
          format: int64
    BaseEntity:
      title: BaseEntity
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        creator:
          type: string
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        updator:
          type: string
        uuid:
          type: string
    BaseWatcher:
      title: BaseWatcher
      type: object
      properties:
        active:
          type: boolean
          description: The status of the watcher, if it's active or not (inactive watchers are not executed)
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        creator:
          type: string
        delay:
          type: number
          description: The amount of time (in seconds) to wait for before executing actions
        description:
          type: string
        domainId:
          type: string
        evalExpr:
          type: string
          description: 'Define how conditions will be evaluated: Example "C1 AND C2 OR C3" where Cx is the tag associated to Condition X'
        execAt:
          type: string
          description: Last time the watcher has been executed
          format: date-time
        execMessage:
          type: string
        execStatus:
          type: string
          description: The status of the last execution of the watcher (This is not the status of conditions evaluation)
        name:
          type: string
        priority:
          type: integer
          description: The priority of the watcher
          format: int64
        resourceAlias:
          type: string
        resourceProvId:
          type: string
        resourceUuid:
          type: string
        sound:
          type: string
        triggerCount:
          type: integer
          description: The amount of time the watcher's conditions has been met consecutively
          format: int64
        type:
          type: integer
          format: int32
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        updator:
          type: string
        uuid:
          type: string
    ConditionCreate:
      title: ConditionCreate
      required:
      - type
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            type: object
        tag:
          type: string
          description: This represents the value with which the condition will be referenced in the EvaluationPath of the watcher
        type:
          type: string
          description: >-
            The type of the condition, this determines the content of the Properties field.

            Can be : 'DISCREPANCY', 'STATE_CHANGE', 'DATA_USAGE', 'BW_USAGE' or `ALARM`
    ConditionUpdate:
      title: ConditionUpdate
      required:
      - type
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            type: object
        tag:
          type: string
          description: This represents the value with which the condition will be referenced in the EvaluationPath of the watcher
        type:
          type: string
          description: >-
            The type of the condition, this determines the content of the Properties field.

            Can be : 'DISCREPANCY', 'STATE_CHANGE', 'DATA_USAGE', 'BW_USAGE' or `ALARM`
        uuid:
          type: string
        watcherUuid:
          type: string
    CreateWatcherParams:
      title: CreateWatcherParams
      type: object
      properties:
        Body:
          $ref: '#/components/schemas/WatcherCreate'
    DConfig:
      title: DConfig
      required:
      - alertName
      - alertSeverity
      - discrepancyDuration
      type: object
      properties:
        active:
          type: boolean
          description: Enable/disable Discrepancy watch
        alertDescription:
          type: string
          description: The description (additionalText) of the alert message that will be send on discrepancy
        alertName:
          type: string
          description: The name of the alert message that will be send on discrepancy
        alertSeverity:
          type: string
          description: The severity of the alert message that will be send on discrepancy
        discrepancyDuration:
          type: number
          description: The number of seconds to wait before send an alert of discrepancy
    Delete204:
      title: Delete204
      type: object
      properties:
        Message:
          type: string
    DiscrepancyData:
      title: DiscrepancyData
      required:
      - alertName
      - alertSeverity
      - discrepancyDuration
      type: object
      properties:
        active:
          type: boolean
          description: Enable/disable Discrepancy watch
        alertDescription:
          type: string
          description: The description (additionalText) of the alert message that will be send on discrepancy
        alertName:
          type: string
          description: The name of the alert message that will be send on discrepancy
        alertSeverity:
          type: string
          description: The severity of the alert message that will be send on discrepancy
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        creator:
          type: string
        discrepancyDuration:
          type: number
          description: The number of seconds to wait before send an alert of discrepancy
        sentAlarms:
          $ref: '#/components/schemas/AlarmHolder'
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        updator:
          type: string
        uuid:
          type: string
    ExecRecord:
      title: ExecRecord
      type: object
      properties:
        actionUuid:
          type: string
        content:
          type: string
          description: The json text of the result of the execution of the action
        contentType:
          type: string
          description: The type of the json string of the content field
        createdAt:
          type: string
          format: date-time
        triggerCount:
          type: integer
          format: int64
        triggerId:
          type: string
          description: The ID of the element (ALARM, RESOURCE, ...) which triggered the execution of the action
        uuid:
          type: string
        watcherName:
          type: string
        watcherUuid:
          type: string
    FilenamePathParams:
      title: FilenamePathParams
      required:
      - filename
      type: object
      properties:
        filename:
          type: string
          description: 'In: path'
    ForceQueryParams:
      title: ForceQueryParams
      type: object
      properties:
        force:
          type: boolean
          description: 'In: query'
    IdGetOneParams:
      title: IdGetOneParams
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: 'In: path'
    ImportOneCParams:
      title: ImportOneCParams
      type: object
      properties:
        Body:
          $ref: '#/components/schemas/OneCImporter'
    Logging:
      title: Logging
      type: object
      properties:
        level:
          type: string
    LoggingParams:
      title: LoggingParams
      type: object
      properties:
        Body:
          $ref: '#/components/schemas/Logging'
    OneCAlert:
      title: OneCAlert
      type: object
      properties:
        AlertOccurenceTime:
          type: number
        Criteria:
          type: string
        EmailIsActive:
          type: boolean
        EmailRuleAction:
          type: string
        Icon:
          type: string
        IsActive:
          type: boolean
        IsDismissed:
          type: boolean
        IsMatched:
          type: boolean
        LastActivation:
          type: number
        LastOccurenceTime:
          type: number
        Name:
          type: string
        Occurences:
          type: integer
          format: int64
        ReceiverList:
          type: string
        ResendDelay:
          type: integer
          format: int64
        RuleAction:
          type: string
        RuleIsActive:
          type: boolean
        Source:
          type: string
        UserId:
          type: string
    OneCImporter:
      title: OneCImporter
      required:
      - fileName
      type: object
      properties:
        attributeMapping:
          type: object
          additionalProperties:
            type: string
          description: Define a mapping between fields in conditions from OneControl to fields in FilteredAlarm in AEProcessor
        fileName:
          type: string
        forceFullScan:
          type: boolean
          description: Set to true, So the reading of the file don't stop when parsing lines
        skipFirstLine:
          type: boolean
          description: Set to true if the first line of the CSV file should not be considered
        userMapping:
          type: object
          additionalProperties:
            type: string
          description: Define a mapping between username from oneControl (names in the file) and username in tron (in the platform)
    OneCImporterResult:
      title: OneCImporterResult
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
          description: ''
        watchers:
          type: array
          items:
            $ref: '#/components/schemas/Watcher'
          description: ''
    PmRequestData:
      title: PmRequestData
      type: object
      properties:
        ResourceKey:
          type: string
        aggregation:
          type: object
          additionalProperties:
            type: object
        filters:
          type: array
          items:
            type: string
          description: ''
        range:
          type: object
          additionalProperties:
            type: object
    RawAlarm:
      title: RawAlarm
      type: object
      properties:
        _type:
          type: string
        additionalAttributes:
          type: object
        additionalText:
          type: string
        conditionSource:
          type: string
        id:
          type: string
        nativeConditionType:
          type: string
        op:
          type: string
        resource:
          type: string
        resourceId:
          type: string
        server:
          $ref: '#/components/schemas/AlarmServer'
        serviceAffecting:
          type: string
        severity:
          type: string
        time:
          type: string
          format: date-time
    RestFilter:
      title: RestFilter
      type: object
      properties:
        facets:
          type: array
          items:
            type: string
          description: 'In: query'
        filter:
          type: array
          items:
            type: string
          description: 'In: query'
        paging:
          type: string
          description: 'In: query'
        sort:
          type: array
          items:
            type: string
          description: 'In: query'
    RsAttr:
      title: RsAttr
      type: object
      properties:
        name:
          type: string
        uuid:
          type: string
    SoundPath:
      title: SoundPath
      type: object
      properties:
        name:
          type: string
        path:
          type: string
    TcaRetrive:
      title: TcaRetrive
      type: object
      properties:
        billingCycle:
          type: integer
          format: int32
        budget:
          type: integer
          format: int32
        resourceId:
          type: string
        tcaLevel:
          type: integer
          format: int32
    UpdateConfigParam:
      title: UpdateConfigParam
      type: object
      properties:
        Body:
          $ref: '#/components/schemas/BaseAppConfig'
    UpdateDiscrepancyParams:
      title: UpdateDiscrepancyParams
      type: object
      properties:
        Body:
          $ref: '#/components/schemas/DConfig'
    UpdateWatcherParams:
      title: UpdateWatcherParams
      type: object
      properties:
        Body:
          $ref: '#/components/schemas/WatcherUpdate'
    UuidPathParams:
      title: UuidPathParams
      required:
      - uuid
      type: object
      properties:
        uuid:
          type: string
          description: 'In: path'
    UuidQueryParams:
      title: UuidQueryParams
      type: object
      properties:
        uuid:
          type: string
          description: 'In: query'
    ValueItem:
      title: ValueItem
      type: object
      properties:
        Key:
          type: string
        Value:
          type: string
    Watcher:
      title: Watcher
      type: object
      properties:
        actionCount:
          type: integer
          format: int64
        actions:
          type: array
          items:
            $ref: '#/components/schemas/Action'
          description: The list of actions performed by this watcher if its conditions are meet
        active:
          type: boolean
          description: The status of the watcher, if it's active or not (inactive watchers are not executed)
        conditionCount:
          type: integer
          format: int64
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/Condition'
          description: The list of conditions evaluated by this watcher during its execution
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        creator:
          type: string
        delay:
          type: number
          description: The amount of time (in seconds) to wait for before executing actions
        description:
          type: string
        domainId:
          type: string
        evalExpr:
          type: string
          description: 'Define how conditions will be evaluated: Example "C1 AND C2 OR C3" where Cx is the tag associated to Condition X'
        execAt:
          type: string
          description: Last time the watcher has been executed
          format: date-time
        execMessage:
          type: string
        execStatus:
          type: string
          description: The status of the last execution of the watcher (This is not the status of conditions evaluation)
        name:
          type: string
        priority:
          type: integer
          description: The priority of the watcher
          format: int64
        resourceAlias:
          type: string
        resourceProvId:
          type: string
        resourceUuid:
          type: string
        sound:
          type: string
        triggerCount:
          type: integer
          description: The amount of time the watcher's conditions has been met consecutively
          format: int64
        type:
          type: integer
          format: int32
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        updator:
          type: string
        uuid:
          type: string
    WatcherCreate:
      title: WatcherCreate
      required:
      - name
      - resourceUuid
      type: object
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/ActionCreate'
          description: ''
        active:
          type: boolean
          description: The status of the watcher, if it's active or not (inactive watchers are not executed)
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/ConditionCreate'
          description: ''
        delay:
          type: number
          description: The amount of time (in seconds) to wait for before executing actions
        description:
          type: string
        evalExpr:
          type: string
          description: 'Define how conditions will be evaluated: Example "C1 AND C2 OR C3" where Cx is the tag associated to Condition X'
        name:
          type: string
        priority:
          type: integer
          description: The priority of the watcher
          format: int64
        resourceUuid:
          type: string
        sound:
          type: string
    WatcherDiff:
      title: WatcherDiff
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WatcherState'
          description: ''
        diff:
          type: boolean
    WatcherState:
      title: WatcherState
      type: object
      properties:
        changeTime:
          type: integer
          format: int64
        sound:
          type: string
        triggerCount:
          type: integer
          format: int64
        watcherUuid:
          type: string
    WatcherUpdate:
      title: WatcherUpdate
      required:
      - name
      - resourceUuid
      type: object
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/ActionUpdate'
          description: ''
        active:
          type: boolean
          description: The status of the watcher, if it's active or not (inactive watchers are not executed)
        addedActions:
          type: array
          items:
            $ref: '#/components/schemas/ActionCreate'
          description: ''
        addedConditions:
          type: array
          items:
            $ref: '#/components/schemas/ConditionCreate'
          description: ''
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/ConditionUpdate'
          description: ''
        delay:
          type: number
          description: The amount of time (in seconds) to wait for before executing actions
        description:
          type: string
        evalExpr:
          type: string
          description: 'Define how conditions will be evaluated: Example "C1 AND C2 OR C3" where Cx is the tag associated to Condition X'
        name:
          type: string
        priority:
          type: integer
          description: The priority of the watcher
          format: int64
        removedActions:
          type: array
          items:
            type: string
          description: ''
        removedConditions:
          type: array
          items:
            type: string
          description: ''
        resourceUuid:
          type: string
        sound:
          type: string
    retrievePmParams:
      title: retrievePmParams
      type: object
      properties:
        Body:
          $ref: '#/components/schemas/PmRequestData'
    AcknowledgeState:
      title: AcknowledgeState
      enum:
      - NOT_ACKNOWLEDGED
      - ACKNOWLEDGED
      type: string
      description: The acknowledge state of the alarm
    Action1:
      title: Action1
      enum:
      - create
      - delete
      - update
      - add
      - remove
      - unset
      type: string
    Action3:
      title: Action3
      enum:
      - create
      - update
      - delete
      type: string
    active:
      title: active
      enum:
      - 'true'
      - 'false'
      type: string
    AdaptsToLayerRate:
      title: AdaptsToLayerRate
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    AdaptsToLayerRate2:
      title: AdaptsToLayerRate2
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    AdaptsToLayerRateQualifier:
      title: AdaptsToLayerRateQualifier
      enum:
      - ODUC1
      - ODUC2
      - ODUC2_25
      - ODUC2_30
      - ODUC3
      - ODUC4
      - ODUC4_60
      - ODUC4_70
      - ODUC5
      - ODUC5_90
      - ODUC6
      - ODUC6_110
      - ODUC7
      - ODUC8
      - ODUC9
      - ODUC10
      - ODUC11
      - ODUC12
      - ODUC13
      - ODUC14
      - ODUC15
      - ODUC16
      - OTUC1
      - OTUC2
      - OTUC2_25
      - OTUC2_30
      - OTUC3
      - OTUC3_50
      - OTUC4
      - OTUC4_60
      - OTUC4_70
      - OTUC5
      - OTUC5_90
      - OTUC6
      - OTUC6_110
      - OTUC7
      - OTUC8
      - OTUC9
      - OTUC10
      - OTUC11
      - OTUC12
      - OTUC13
      - OTUC14
      - OTUC15
      - OTUC16
      - OC3
      - OC12
      - OC48
      - OC192
      - OC768
      - STM1
      - STM4
      - STM16
      - STM64
      - STM256
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - _1GE
      - _10GE
      - _40GE
      - _100GE
      - _400GE
      - _2G5
      - _1G25
      - _10G
      - _40G
      - _100G
      - _150G
      - _200G
      - _250G
      - _300G
      - _350G
      - _400G
      - _450G
      - _500G
      - _550G
      - _600G
      - _650G
      - _700G
      - _750G
      - _800G
      - ETHFLEX
      - _10GE_ODUFLEX
      - _100GE_ODUFLEX
      - FICON1G
      - FICONEXPRESS2G
      - FICON4G
      - FICON8G
      - FICON16G
      - FC100
      - FC200
      - FC400
      - FC800
      - FC1200
      - FC1600
      - FC3200
      - _2G5_CBR
      - _10G_CBR
      - UNKNOWN
      type: string
      description: Provides a means to provide additional qualification attributes for a Layer Rate. For example, for beyond 100G rates OTUCn and ODUCn, the value of n, where n is a multiple of 100. For example, for beyond 100G rates with sub rate potential (i.e. OTUCn-M), this includes the n-M options where n is the number of OxUC overhead instances and M is the number of 5G tributary slots. For example, OTUC4-60 implies 4 instances of OxUC overhead, and 300G capacity (5G x 60).
    AdjacencyPackage1:
      title: AdjacencyPackage1
      type: object
      properties:
        adjacencyType:
          type: string
        localTag:
          type: string
        provisionedRemoteTag:
          type: string
        remoteTag:
          type: string
        remoteTagFormat:
          type: string
        topologySourceTag:
          type: string
        linkAttributes:
          $ref: '#/components/schemas/LinkAttributes1'
    AdjacencyPackage2:
      title: AdjacencyPackage2
      type: object
      properties:
        smdToLim:
          $ref: '#/components/schemas/SmdToLim'
    AdjacencyPackage3:
      title: AdjacencyPackage3
      type: object
      properties:
        smdToLim:
          $ref: '#/components/schemas/SmdToLim1'
    AdminState:
      title: AdminState
      enum:
      - up
      - down
      type: string
      description: The administrative state of BFD for this endpoint
    AdminState2:
      title: AdminState2
      enum:
      - up
      - down
      type: string
      description: The administrative state of the layer termination.
    AdminState3:
      title: AdminState3
      enum:
      - ENABLED
      - DISABLED
      type: string
      description: Admin state of this parent policer
    AdminState6:
      title: AdminState6
      enum:
      - ENABLED
      - DISABLED
      - NOT_APPLICABLE
      - IN_SERVICE
      - OUT_OF_SERVICE
      type: string
      description: Indicates the administrative state of the FRE, including whether traffic has been enabled and whether the FRE should be used by clients. It is derived from the state(s) of terminating TPE(s). Disabled means that FRE is prevented from carrying traffic. Enabled means that FRE is allowed to carry traffic.
    AdminState7:
      title: AdminState7
      enum:
      - UP
      - DOWN
      type: string
      description: Tunnel admin state
    AdminState10:
      title: AdminState10
      enum:
      - ENABLED
      - DISABLED
      - UNKNOWN
      type: string
      description: The global admin state of the frequency timing system.
    Advertise:
      title: Advertise
      enum:
      - all
      - best2
      - best3
      type: string
      description: The number of paths to advertise to the neighbor. Applicable only when the capability is send or both.
    Advertise1:
      title: Advertise1
      enum:
      - all
      - best1
      - best2
      - best3
      type: string
      description: The number of paths to advertise to the neighbor. Applicable only when the capability is send or both.
    Advertise2:
      title: Advertise2
      enum:
      - all
      - best2
      - best3
      type: string
    Ains:
      title: Ains
      enum:
      - ACTIVE
      - INACTIVE
      - NA
      type: string
    AisSessionAdminState:
      title: AisSessionAdminState
      enum:
      - up
      - down
      type: string
      description: The administrative state of the AIS session for this MPLS tunnel
    AliasType:
      title: AliasType
      enum:
      - TID
      - IP_ADDRESS
      - MAC_ADDRESS
      - PLANNING_ID
      - CUSTOM
      type: string
      description: The type of this device alias instance.
    AliasType1:
      title: AliasType1
      enum:
      - CLFI
      - DISTINGUISHED_NAME
      - MANAGEMENT_NAME
      type: string
      description: <br/>CLFI - Common Language Facility code<br/>DISTINGUISHED_NAME - Distinguished Alias Name<br/>MANAGEMENT_NAME - the CESD VS name
    AreaBorderRouter:
      title: AreaBorderRouter
      enum:
      - RFC_3509
      - RFC_2328
      type: string
      description: Area border Router
    AreaSystemBorderRouter:
      title: AreaSystemBorderRouter
      enum:
      - ON
      - OFF
      type: string
      description: Defines if the router is a area system border router
    AseData:
      title: AseData
      type: object
      properties:
        aid:
          type: string
          default: BMD-1-85
        wssToSmd:
          $ref: '#/components/schemas/WssToSmd'
        wssToAse:
          $ref: '#/components/schemas/WssToAse'
    AssociationState:
      title: AssociationState
      enum:
      - GOA
      - LOA
      type: string
      description: Association state of the network construct.
    AssociationState1:
      title: AssociationState1
      enum:
      - GOA
      - LOA
      type: string
      description: Association state of the management session.
    AssociationStateQualifier:
      title: AssociationStateQualifier
      enum:
      - MANUAL
      - SYSTEM
      - NETWORK
      type: string
      description: How the associationState has been set.
    AssociationStateQualifier1:
      title: AssociationStateQualifier1
      enum:
      - MANUAL
      - SYSTEM
      - NETWORK
      type: string
    AsyncProtocolVersion:
      title: AsyncProtocolVersion
      enum:
      - v1
      - v2
      type: string
      description: Identifies the async protocol version supported by the resource provider
    Attribute:
      title: Attribute
      type: object
      properties:
        IP:
          type: array
          items:
            type: string
          description: ''
        ospfArea:
          type: string
    Attributes:
      title: Attributes
      type: object
      properties:
        planning:
          $ref: '#/components/schemas/Planning'
        networkConstruct:
          $ref: '#/components/schemas/networkConstructData'
        equipment:
          $ref: '#/components/schemas/Equipment'
      description: Attributes required for an equipment commissioning.
    Attributes1:
      title: Attributes1
      type: object
      properties:
        planning:
          $ref: '#/components/schemas/Planning'
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/networkConstructData'
          description: ''
        expectations:
          type: array
          items:
            $ref: '#/components/schemas/networkConstructExpectationsData'
          description: ''
      description: Attributes required for commissionining shelves available in planning project.
    Attributes2:
      title: Attributes2
      type: object
      properties:
        ospfArea:
          type: string
        ospfAreaV3:
          type: string
        IP:
          type: string
        IP6:
          type: string
    Attributes3:
      title: Attributes3
      type: object
      properties:
        userData:
          type: object
          description: Userdata for a network construct
        ipaddress:
          type: string
        name:
          type: string
        accessIdentifier:
          type: string
      description: Attributes for the associated NC and expectation identifiers
    Attributes4:
      title: Attributes4
      type: object
      properties:
        counts:
          type: object
          additionalProperties:
            type: string
    Attributes5:
      title: Attributes5
      required:
      - sync-timestamp
      type: object
      properties:
        sync-timestamp:
          type: string
          description: The timestamp declaring the starting point of data to sync from the specified site, in format 2018-05-10T15:00:00.00Z
    Attributes6:
      title: Attributes6
      type: object
      properties:
        LOACount:
          type: integer
          format: int32
        failureOrDelayedCollectionCount:
          type: integer
          format: int32
        id:
          type: string
        networkElementNames:
          $ref: '#/components/schemas/NetworkElementNames'
        successCount:
          type: integer
          format: int32
        totalNetworkElementCount:
          type: integer
          format: int32
        type:
          type: string
    Attributes7:
      title: Attributes7
      required:
      - configName
      type: object
      properties:
        applyForNeNames:
          type: array
          items:
            type: string
          description: ''
        applyForNeTypes:
          type: array
          items:
            type: string
          description: ''
        configName:
          type: string
        enabled:
          type: boolean
        pollingInterval:
          $ref: '#/components/schemas/PollingInterval'
        resolution:
          $ref: '#/components/schemas/Resolution'
    Attributes8:
      title: Attributes8
      type: object
      properties:
        configName:
          type: string
        enabled:
          type: boolean
        pollingInterval:
          $ref: '#/components/schemas/PollingInterval'
        resolution:
          $ref: '#/components/schemas/Resolution'
    Attributes9:
      title: Attributes9
      required:
      - configName
      type: object
      properties:
        configName:
          type: string
        enabled:
          type: boolean
        pollingInterval:
          $ref: '#/components/schemas/PollingInterval'
        resolution:
          $ref: '#/components/schemas/Resolution'
    Attributes10:
      title: Attributes10
      required:
      - filter
      - range
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/Filter12'
        range:
          $ref: '#/components/schemas/Range3'
        tags:
          type: array
          items:
            type: string
          description: Define the list of tags to be returned. If no tags are set the query will return all tags. All queries will return networkElementName, facilityNameNative, and parameterNative by default.
    Attributes11:
      title: Attributes11
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: A tag
        values:
          type: object
          additionalProperties:
            type: number
          description: A map, representing the time series. timestamp:<correlated-datapoint-object>. Timestamp can be milliseconds or RFC3339 formatted.
    Attributes12:
      title: Attributes12
      required:
      - filter
      - range
      type: object
      properties:
        filter:
          type: array
          items:
            type: object
          description: Define a filter for your query
        interval:
          type: string
          description: The time interval returned in the response. This can be used to page through the specified time range. If not specified, all data for the queried time period is returned. To facilitate access to the next interval, a link is present in meta>nextInterval. Use a value with a time suffix (m - minutes, h - hours, d - days)
        pageSize:
          type: integer
          description: The maximum amount of unique time series returned in the response. If more time series are in the result set, a link to the next page is created in meta>nextPage
          format: int32
        range:
          $ref: '#/components/schemas/Range3'
        sort:
          type: array
          items:
            type: string
          description: Define a sort order for the result. Prefix with '-' for DESC
        tags:
          type: array
          items:
            type: string
          description: Define the list of tags the user wants to select in their query. If no tags are set the query will select all tags
    Attributes13:
      title: Attributes13
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: A tag
        values:
          type: object
          additionalProperties:
            type: number
          description: A map, representing the time series. timestamp:value. Timestamp can be milliseconds or RFC3339 formatted.
    Attributes14:
      title: Attributes14
      type: object
      properties:
        metaTags:
          type: object
          additionalProperties:
            type: string
          description: Additional generic tags
        tags:
          type: object
          additionalProperties:
            type: string
          description: A tag
        values:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Values'
          description: A map, representing the time series. timestamp:<context-datapoint-object>. Timestamp can be milliseconds or RFC3339 formatted.
    Attributes15:
      title: Attributes15
      required:
      - resourceId
      - status
      type: object
      properties:
        resourceId:
          type: string
          description: The resourceId for which response is returned
        status:
          type: array
          items:
            $ref: '#/components/schemas/initRegStatus'
          description: ''
    Attributes16:
      title: Attributes16
      type: object
      properties:
        collectionIntervals:
          type: object
          additionalProperties: {}
    Attributes17:
      title: Attributes17
      type: object
      properties:
        label:
          type: string
        operators:
          type: array
          items:
            type: string
          description: ''
    Attributes18:
      title: Attributes18
      required:
      - filter
      - range
      type: object
      properties:
        filter:
          type: array
          items:
            type: object
          description: Define a filter for your query
        range:
          $ref: '#/components/schemas/Range3'
    Attributes19:
      title: Attributes19
      required:
      - filter
      - range
      type: object
      properties:
        filter:
          type: array
          items:
            type: object
          description: Define a filter for your query. Specify networkElementName, facilityNameNative, and facilityName.
        range:
          $ref: '#/components/schemas/Range3'
    Attributes20:
      title: Attributes20
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: A tag
        values:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Values1'
          description: A map, representing the time series. Timestamp can be milliseconds or RFC3339 formatted.
    Attributes21:
      title: Attributes21
      type: object
      properties:
        scheduleName:
          type: string
          default: Schedule-1
        scheduleDetails:
          $ref: '#/components/schemas/ScheduleDetails1'
        neDetails:
          $ref: '#/components/schemas/NeDetails'
    Attributes22:
      title: Attributes22
      type: object
      properties:
        baselineDetails: {}
        neDetails:
          $ref: '#/components/schemas/NeDetails1'
    Attributes23:
      title: Attributes23
      type: object
      properties:
        cable_attributes:
          $ref: '#/components/schemas/CableAttributes'
        repeater_attributes:
          $ref: '#/components/schemas/RepeaterAttributes'
        slte_attributes:
          $ref: '#/components/schemas/SlteAttributes'
    Attributes24:
      title: Attributes24
      type: object
      properties:
        operation_type:
          type: string
        slte_attributes:
          $ref: '#/components/schemas/SlteAttributes'
    Attributes25:
      title: Attributes25
      type: object
      properties:
        sstId:
          type: string
          default: 9014e61f-92c2-335a-8591-68aa61f2f9c5_OTS-1-1
        customerPorts:
          type: array
          items:
            $ref: '#/components/schemas/CustomerPort'
          description: ''
        smdToWss:
          $ref: '#/components/schemas/SmdToWss'
    Attributes26:
      title: Attributes26
      required:
      - replicationFactor
      - partitions
      - config
      - meta
      type: object
      properties:
        replicationFactor:
          type: integer
          description: Replication factor
          format: int32
        partitions:
          type: integer
          description: The number of partitions for the topic
          format: int32
        config:
          type: object
          additionalProperties:
            type: string
          description: The configuration of the topic as outlined in Kafkas documentation
        meta:
          type: object
          additionalProperties:
            type: string
        created:
          type: string
        creator:
          type: string
    Attributes27:
      title: Attributes27
      type: object
      properties:
        topic:
          type: string
        consumerGroup:
          type: string
        consumers:
          type: array
          items:
            $ref: '#/components/schemas/ConsumerState'
          description: ''
    Attributes28:
      title: Attributes28
      type: object
      properties:
        topic:
          type: string
        partitions:
          type: array
          items:
            $ref: '#/components/schemas/Partition'
          description: ''
    Attributes29:
      title: Attributes29
      type: object
      properties:
        topic:
          type: string
        consumerGroup:
          type: string
        processState:
          $ref: '#/components/schemas/ProcessState1'
    Attributes30:
      title: Attributes30
      type: object
      properties:
        file_name:
          type: string
        tid_name:
          type: string
        trace_tag:
          type: string
        trace_type:
          type: string
        trace_id:
          type: string
        label:
          type: string
        timestamp:
          type: string
        trace_direction:
          type: string
    Attributes31:
      title: Attributes31
      type: object
      properties:
        additionalAttributes:
          type: object
        scanData:
          type: array
          items:
            $ref: '#/components/schemas/ScanDatum'
          description: ''
    Attributes32:
      title: Attributes32
      type: object
      properties:
        additionalAttributes:
          type: object
        neDetails:
          $ref: '#/components/schemas/NeDetails'
        scheduleDetails:
          $ref: '#/components/schemas/ScheduleDetails2'
        scheduleId:
          type: string
        callbackId:
          type: string
        scheduleName:
          type: string
    Attributes33:
      title: Attributes33
      type: object
      properties:
        additionalAttributes:
          type: object
        neDetails:
          $ref: '#/components/schemas/NeDetails1'
        baselineDetails:
          type: object
    Attributes34:
      title: Attributes34
      type: object
      properties:
        additionalAttributes:
          type: object
        cableStations:
          type: array
          items:
            type: string
          description: ''
        branchingUnits:
          type: array
          items:
            type: string
          description: ''
        description:
          type: string
        branchingUnitsCount:
          type: integer
          format: int32
        cableSystemFileName:
          type: string
        customerNamesCount:
          type: integer
          format: int32
        customerNames:
          type: array
          items:
            type: string
          description: ''
        powerNetworkName:
          type: array
          items:
            type: string
          description: ''
        repeaterSystemFileName:
          type: array
          items:
            type: string
          description: ''
        cableStationsCount:
          type: integer
          format: int32
        name:
          type: string
    Attributes35:
      title: Attributes35
      type: object
      properties:
        trendReadings:
          type: array
          items:
            $ref: '#/components/schemas/TrendReading'
          description: ''
        type:
          type: string
        id:
          type: string
    Attributes36:
      title: Attributes36
      type: object
      properties:
        opmCurrent:
          type: array
          items:
            $ref: '#/components/schemas/OpmCurrent'
          description: ''
    Attributes37:
      title: Attributes37
      type: object
      properties:
        additionalAttributes:
          type: object
        customers:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
          description: ''
        nodeType:
          type: string
          default: '6500'
        tidName:
          type: string
          default: SITEA
        otsAid:
          type: string
          default: OTS-1-1
        cableSystemName:
          type: string
          default: BRUSA-VIRGINIA-BEACH
        cableSystemInfo:
          type: string
          default: FP1
        availableCustomerPorts:
          type: integer
          format: int32
          default: 8
        usedCustomerPorts:
          type: integer
          format: int32
          default: 1
        SSTAdjacencyPackage:
          $ref: '#/components/schemas/SSTAdjacencyPackage'
    Attributes38:
      title: Attributes38
      type: object
      properties:
        aseData:
          $ref: '#/components/schemas/AseData'
        customerData:
          type: array
          items:
            $ref: '#/components/schemas/CustomerDatum'
          description: ''
        additionalAttributes:
          type: object
    Attributes39:
      title: Attributes39
      type: object
      properties:
        availableMinFreqRange:
          type: array
          items:
            type: string
          description: ''
        availableMaxFreqRange:
          type: array
          items:
            type: string
          description: ''
        smdPort9Index:
          type: number
          default: 3
        smdPort10Index:
          type: number
          default: 4
        wssPort22Index:
          type: number
          default: 5
    Attributes40:
      title: Attributes40
      type: object
      properties:
        TARGSWSEL:
          type: string
          default: '12'
        INITATTEN:
          type: string
          default: '12.00'
        CTRLFREQOFFSET:
          type: string
          default: '0.000'
        EXPINITPOW:
          type: string
          default: N/A
        SWSEL:
          type: string
          default: '16'
        REFBW:
          type: string
          default: 12.5GHZ
        WSSCHINPOW:
          type: string
          default: N/A
        CENTERFREQ:
          type: string
          default: '191.343750'
        CTRLSSCATTEN:
          type: string
          default: '20.00'
        MAXFREQ:
          type: string
          default: '191.362500'
        TID:
          type: string
          default: SSTSite3
        AID:
          type: string
          default: NMCC-1-2-9-2-1
        INPWEREF:
          type: string
          default: N/A
        INPOWSRC:
          type: string
          default: '0.0'
        SPECTRALWIDTH:
          type: string
          default: '37.500'
        CHNLPOW:
          type: string
          default: N/A
        TARGLOSS:
          type: string
          default: '18.00'
        CTRLSTATE:
          type: string
          default: Not Applicable
        SST:
          type: string
          default: IS
        ISOPQ:
          type: string
          default: YES
        CTRLTARGPOW:
          type: string
          default: N/A
        WSSOUTPOW:
          type: string
          default: N/A
        LOSS:
          type: string
          default: N/A
        CTRLSSC:
          type: string
          default: SSC-1-2-9-3
        MINFREQ:
          type: string
          default: '191.325000'
        CHCMODE:
          type: string
          default: OPENLOOPLOSS
        ATTEN:
          type: string
          default: N/A
        INPOW:
          type: string
          default: N/A
        CKTID:
          type: string
          default: N/A
        WSSCHOUTPOW:
          type: string
          default: N/A
        PST:
          type: string
          default: IS
        CTRLOUTPOW:
          type: string
          default: N/A
    AuditType:
      title: AuditType
      enum:
      - NeConfiguration
      - Network
      type: string
      description: Audit Type
    AutoBackup:
      title: AutoBackup
      enum:
      - on
      - off
      type: string
      description: A flag to signal if auto-backup tunnel creation is on or off
    AutoReversionType:
      title: AutoReversionType
      enum:
      - delay
      - timeOfDay
      type: string
      description: If autoReversionPossible, this type is the behaviour of that reversion, currently only delay is supported.
    AutoSize:
      title: AutoSize
      enum:
      - enable
      - disable
      type: string
      description: If true, the MPLS tunnel will be auto-sized by the NE
    AutoSizeFailureAction:
      title: AutoSizeFailureAction
      enum:
      - none
      - alarm
      - mbb
      type: string
      description: 'The action to be taken when auto-sizing fails: raise alarm, or make-before-break'
    AutoSizeLastResizeState:
      title: AutoSizeLastResizeState
      enum:
      - success
      - failure
      - in_progress
      type: string
      description: The state of the last auto-sizing attempt
    AutoSizingMode:
      title: AutoSizingMode
      enum:
      - none
      - cac
      - utilization
      type: string
      description: The configured auto-sizing mode
    AvailabilityState:
      title: AvailabilityState
      enum:
      - PLANNED
      - AVAILABLE
      - UNVALIDATED
      - INUSE
      type: string
      description: The availability state of the equipment
    AvailabilityState3:
      title: AvailabilityState3
      enum:
      - PLANNED
      - AVAILABLE
      - UNVALIDATED
      - INUSE
      type: string
    AvgLossStatus:
      title: AvgLossStatus
      enum:
      - low
      - good
      - high
      type: string
    BackupType:
      title: BackupType
      enum:
      - MANUAL
      - SCHEDULED
      type: string
    BadRequest1:
      title: BadRequest1
      type: object
      properties:
        statuscode:
          type: string
        message:
          type: string
    BadRequest111:
      title: BadRequest111
      type: object
      properties:
        status:
          type: string
          default: BADREQUEST
        errors:
          type: array
          items:
            type: string
          description: ''
    band:
      title: band
      enum:
      - C
      - L
      type: string
    BaseHO:
      title: BaseHO
      enum:
      - ODU2
      - ODU3
      - ODU4
      type: string
      description: Indicates the base HO ODUk for which the bitrate is applicable.
    Baselinedetails:
      title: Baselinedetails
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data43'
          description: ''
    batchType:
      title: batchType
      enum:
      - BACKUP
      - PRE_UPGRADE
      - UPGRADE
      - POST_UPGRADE
      - SCRIPT
      - CUSTOM_SCRIPT
      type: string
    BaudRate:
      title: BaudRate
      enum:
      - 35GBAUD
      - 56GBAUD
      type: string
    BfdMonitor:
      title: BfdMonitor
      enum:
      - shop
      - mhop
      type: string
    BfdType:
      title: BfdType
      enum:
      - ipBFD
      - mplsBFD
      - bgpBFD
      type: string
      description: Type of BFD - ipBFD, mplsBFD or bgpBFD
    BindingAllocMode:
      title: BindingAllocMode
      enum:
      - explicit
      - dynamic
      type: string
      description: Binding SID allocation mode. It can be either Explicitly specified BSID or Dynamically allocated BSID
    BindingSidAllocationMode:
      title: BindingSidAllocationMode
      enum:
      - SystemDefined
      - Device
      type: string
      description: Policy bindingSid allocation mode
    body_params:
      title: body_params
      type: object
      properties:
        site_state:
          $ref: '#/components/schemas/site_state'
        site_address:
          type: string
          description: Network address at which remote site can be reached.
    body_params1:
      title: body_params1
      required:
      - cluster_name
      - state_update
      type: object
      properties:
        cluster_name:
          pattern: '[a-zA-Z0-9_-]{3,}'
          type: string
          description: The name of a georedundant aware application, such as `galera` or `datomic`
        state_update:
          type: object
    bookingData.lockout:
      title: bookingData.lockout
      enum:
      - 'true'
      - 'false'
      type: string
    BwLockOut:
      title: BwLockOut
      enum:
      - NO
      - YES
      type: string
      description: Specifies if bandwidth lockout is enabled locally for the OSRP line.
    BwThresholdMode:
      title: BwThresholdMode
      enum:
      - ADV_ALL
      - AUTO
      - MANUAL
      type: string
      description: The default setting of OSRP link bandwidth threshold mode
    Cablesystemdetails:
      title: Cablesystemdetails
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data44'
          description: ''
    CableAttributes:
      title: CableAttributes
      type: object
      properties:
        cable_system_name:
          type: string
    CableSystemUpdateConfirmationMessage:
      title: CableSystemUpdateConfirmationMessage
      type: object
      properties:
        status:
          type: string
    CachingInformation:
      title: CachingInformation
      enum:
      - FULLY_CACHED
      - PARTIALLY_CACHED
      - NOT_CACHED
      type: string
    calculation:
      title: calculation
      enum:
      - ThroughputWithOctets
      - ThroughputWithOctetsAndFrames
      type: string
    CalendarProtocol:
      title: CalendarProtocol
      enum:
      - enabled
      - disabled
      type: string
      description: Whether calendar negotiation protocol is enabled or not
    CallbackRequest:
      title: CallbackRequest
      required:
      - application
      - name
      - callbacks
      type: object
      properties:
        application:
          maxLength: 64
          type: string
          description: The application or service to whom this configuration value belongs.
        instance:
          maxLength: 2
          type: string
          description: The instance identifier of the application. If not provided, the instance will default to the instance agnostic identifier ("-").
        partition:
          maxLength: 64
          type: string
          description: The partition to under which the configuration is found.
        group:
          type: array
          items:
            maxLength: 64
            type: string
          description: Groupings of configurations within a configuration partition. Used to further sort and identify configurations.
        name:
          maxLength: 64
          type: string
          description: The name of the configuration.
        callbacks:
          type: array
          items:
            maxLength: 256
            type: string
          description: A list of URLs specifying the callback location.
        password:
          maxLength: 256
          type: string
          description: The optional password for the configuration
    Capabilities:
      title: Capabilities
      type: object
      properties:
        capability:
          type: array
          items:
            type: string
          description: ''
    Capability:
      title: Capability
      enum:
      - send
      - receive
      - both
      type: string
      description: The add-path capability towards the neighbor.
    Capability1:
      title: Capability1
      enum:
      - send
      - receive
      - both
      - disable
      type: string
      description: The add-path capability towards the neighbor.
    Capability2:
      title: Capability2
      enum:
      - send
      - receive
      - both
      - disable
      type: string
    CapacityClass:
      title: CapacityClass
      enum:
      - discrete
      - continuous
      type: string
      description: Discrete – b/w space is treated as a list of discrete values; this is default. Continuous – b/w space is treated as continuous segment, in the range of low/upper.
    CapacityType:
      title: CapacityType
      enum:
      - RSZ
      - NRSZ
      type: string
      description: Resizable or Non-Resizable capacity type of ODUFLEX
    CaptureAvailabilityState:
      title: CaptureAvailabilityState
      enum:
      - NOT_AVAILABLE
      - LOCAL_ONLY
      - REMOTE_ONLY
      - LOCAL_REMOTE
      type: string
    CardMode:
      title: CardMode
      enum:
      - maxReach
      - maxCapacity
      - maxReach_Regen
      - maxCapacity_Regen
      - undetermined
      type: string
      description: Provides a means to differentiate different configurations of the card setup. For example, WLAi 400G OTR has several configuration options for 400G line service rate.
    Category:
      title: Category
      enum:
      - rack
      - shelf
      - pluggable
      - standalone
      type: string
      description: The equipment category
    Category3:
      title: Category3
      enum:
      - shelf
      - slot
      - subslot
      type: string
    Category4:
      title: Category4
      enum:
      - CHANNEL_TX
      - CHANNEL_RX
      - OTN_ACCESS
      type: string
    CCMD:
      title: CCMD
      type: object
      properties:
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '89'
    CcmTransmitState:
      title: CcmTransmitState
      enum:
      - ON
      - OFF
      type: string
      description: The transmission state of CCM (on/off)
    CcmTransmitState1:
      title: CcmTransmitState1
      enum:
      - ON
      - OFF
      - PARTIAL
      type: string
      description: The transmission state of CCM (on/off)
    CctState:
      title: CctState
      enum:
      - IN_PROGRESS
      - FAILED
      - DELETED
      - COMPLETE
      type: string
      description: The cctData state
    CenterFrequencyRule:
      title: CenterFrequencyRule
      enum:
      - transponderResolution
      type: string
      description: Rule that the centerFrequency of the range must follow. Can point to a specific algorithm to be executed.
    CfmAdminState:
      title: CfmAdminState
      enum:
      - ENABLED
      - DISABLED
      - PARTIAL
      type: string
      description: The administrative state (enabled/disabled/partial)
    CfmOperState:
      title: CfmOperState
      enum:
      - ENABLED
      - DISABLED
      - PARTIAL
      type: string
      description: The operational state (enabled/disabled/partial)
    ChangeType:
      title: ChangeType
      enum:
      - Set
      - Unset
      - Updated
      - Added
      - Removed
      type: string
      description: The type of change made to the attribute
    ChcData:
      title: ChcData
      type: object
      properties:
        SMD:
          type: array
          items:
            $ref: '#/components/schemas/SMD4'
          description: ''
        WSSOPM:
          type: array
          items:
            $ref: '#/components/schemas/WSSOPM3'
          description: ''
    Children:
      title: Children
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Relationship'
          description: ''
    CirPolicy:
      title: CirPolicy
      enum:
      - no_auto_adjust
      - child_Cir_as_percent
      - cir_as_percent
      - child_cir_sum
      type: string
    CirPolicy1:
      title: CirPolicy1
      enum:
      - no_auto_adjust
      - child_cir_as_percent
      - cir_as_percent
      - child_cir_sum
      - auto_adjust_disabled
      type: string
    ClockState:
      title: ClockState
      enum:
      - FREE_RUN
      - ACQUIRING
      - LOCKED
      - HOLDOVER
      - HOLDOVER_EXPIRED
      - HOLDOVER_IN_SPEC
      - HOLDOVER_OUT_OF_SPEC
      - UNKNOWN
      type: string
      description: The operational state of the currently selected clock source.
    ClockType:
      title: ClockType
      enum:
      - BOUNDARY
      - GRANDMASTER
      - SLAVE
      - TRANSPARENT
      - UNKNOWN
      type: string
      description: The definition of all ClockType enumerations
    ColanA:
      title: ColanA
      type: object
      properties:
        defaultGateway:
          type: string
          description: Default gateway of the shelf.
        override:
          type: string
          description: Override property of the shelf.
        usage:
          type: string
          description: Usage of the shelf.
        subnetMask:
          type: string
          description: Subnet mask of the shelf.
        ipAddress:
          type: string
          description: IP address of the colan A.
        topology:
          type: string
          description: Network topology of the shelf in the network.
      description: colan A properties of the shelf.
    ColanX:
      title: ColanX
      type: object
      properties:
        defaultGateway:
          type: string
          description: Default gateway of the shelf.
        override:
          type: string
          description: Override property of the shelf.
        usage:
          type: string
          description: Usage of the shelf.
        subnetMask:
          type: string
          description: Subnet mask of the shelf.
        ipAddress:
          type: string
          description: IP address of the colan X.
        topology:
          type: string
          description: Network topology of the shelf in the network.
      description: colan X properties of the shelf.
    Command:
      title: Command
      type: object
      properties:
        commandType:
          type: string
        command:
          type: string
    CommissioningScriptsData:
      title: CommissioningScriptsData
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data32'
    ConditionSeverity:
      title: ConditionSeverity
      enum:
      - CRITICAL
      - MAJOR
      - MINOR
      - WARNING
      - INDETERMINATE
      - INFO
      - CONFIG
      - DEBUG
      type: string
      description: The severity of the alarm
    ConditionSource:
      title: ConditionSource
      enum:
      - NETWORK
      - MANAGER
      - SYSTEM
      type: string
      description: The source of the alarm
    configuration:
      title: configuration
      enum:
      - 15_MINUTES
      - 24_HOURS
      type: string
    ConfiguredDfElectionMethod:
      title: ConfiguredDfElectionMethod
      enum:
      - DEFAULT
      - HIGHEST_RANDOM_WEIGHT
      - PREFERENCE
      type: string
      description: The configured DF election method - default, highest-random-weight, or preference-based
    ConfiguredLatencyType:
      title: ConfiguredLatencyType
      enum:
      - disc
      - manual
      type: string
      description: Describe whether the latency is discovered or  manual.
    ConfigureLossData:
      title: ConfigureLossData
      type: object
      properties:
        tx_loss:
          type: string
        rx_loss:
          type: string
    Constraint:
      title: Constraint
      enum:
      - writeAtFarEnd
      type: string
    Construct:
      title: Construct
      type: object
      properties:
        identifiers:
          $ref: '#/components/schemas/Identifiers2'
        attributes:
          $ref: '#/components/schemas/Attributes62'
    content:
      title: content
      enum:
      - summary
      - detail
      type: string
    content2:
      title: content2
      enum:
      - file
      - json
      type: string
    ControlActivityState:
      title: ControlActivityState
      enum:
      - NONE
      - ACTIVATING
      - DEACTIVATING
      - IDLE
      - PENDING
      - MODIFYING
      - FAILING
      - DEGRADED
      type: string
      description: Represents the state of management activity being performed against this FRE.
    ControllerType:
      title: ControllerType
      enum:
      - switchController
      - configurationController
      type: string
      description: controller type
    ControlPlane:
      title: ControlPlane
      enum:
      - L_0
      type: string
      description: Technology layer of the control plane.
    CostCriteria:
      title: CostCriteria
      enum:
      - Delay
      - AdminWeight
      type: string
      description: Defines Cost Criteria between admin wt or latency
    CreateRequest:
      title: CreateRequest
      required:
      - application
      - name
      type: object
      properties:
        application:
          maxLength: 64
          type: string
          description: The application or service to whom this configuration value belongs.
        instance:
          maxLength: 2
          type: string
          description: The instance identifier of the application. If not provided, the instance will default to the instance agnostic identifier ("-").
        partition:
          maxLength: 64
          type: string
          description: The partition to under which the configuration is found.
        group:
          type: array
          items:
            maxLength: 64
            type: string
          description: Groupings of configurations within a configuration partition. Used to further sort and identify configurations.
        name:
          maxLength: 64
          type: string
          description: The name of the configuration.
        title:
          maxLength: 64
          type: string
          description: A descriptive title of the configuration value for UI readability.
        description:
          maxLength: 256
          type: string
          description: A description of the configuration value for UI readability.
        tags:
          type: array
          items:
            maxLength: 64
            type: string
          description: A list of the tags associated with this configuraiton value.
        value:
          maxLength: 256
          type: string
          description: The value of the configuration.
        default:
          maxLength: 256
          type: string
          description: The default value of the configuration.
        callbacks:
          type: array
          items:
            maxLength: 256
            type: string
          description: A list of URLs specifying the callback location.
        password:
          maxLength: 64
          type: string
          description: The optional password for the configuration
    CurrentLossMethod:
      title: CurrentLossMethod
      enum:
      - totalPower
      - osc
      - ramanTelemetry
      - rls
      type: string
    Customer:
      title: Customer
      type: object
      properties:
        customerPort:
          type: string
          default: C1
        customerName:
          type: string
          default: Antel
        limAid:
          type: string
          default: LIM-1-5
        adjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage3'
        frequency:
          $ref: '#/components/schemas/Frequency2'
    CustomerDatum:
      title: CustomerDatum
      type: object
      properties:
        customerPort:
          type: string
          default: C1
        limAid:
          type: string
          default: LIM-1-5
        customerName:
          type: string
          default: ANTEL
        customerSpectrum:
          $ref: '#/components/schemas/CustomerSpectrum'
        customerPortState:
          type: string
          default: In Use
        smdToLim:
          $ref: '#/components/schemas/SmdToLim2'
        CCMD:
          $ref: '#/components/schemas/CCMD'
        chcData:
          $ref: '#/components/schemas/ChcData'
    CustomerPort:
      title: CustomerPort
      type: object
      properties:
        customerPort:
          type: string
          default: C1
        customerName:
          type: string
          default: AngolaCables
        limAid:
          type: string
          default: LIM-1-5
        adjacencyPackage:
          $ref: '#/components/schemas/AdjacencyPackage2'
    CustomerSpectrum:
      title: CustomerSpectrum
      type: object
      properties:
        totalSpectrum:
          type: array
          items:
            type: string
          description: ''
        usedSpectrum:
          type: array
          items:
            $ref: '#/components/schemas/UsedSpectrum'
          description: ''
    Data:
      title: Data
      required:
      - tenant_context
      - tenant_name
      - user_roles
      type: object
      properties:
        session_id:
          type: string
        tenant_context:
          type: string
        tenant_context_id:
          type: string
        tenant_id:
          type: string
        tenant_name:
          type: string
        user_id:
          type: string
        user_name:
          type: string
        user_roles:
          type: array
          items:
            type: string
          description: ''
    Data1:
      title: Data1
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes310'
      description: Data for commissioning an equipment.
    Data2:
      title: Data2
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes52'
      description: Data for nodes and planning projects identifiers.
    Data3:
      title: Data3
      type: object
      properties:
        attribute:
          $ref: '#/components/schemas/Attribute'
        type:
          type: string
        id:
          type: string
    Data4:
      title: Data4
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes2'
        type:
          type: string
    Data5:
      title: Data5
      required:
      - projectName
      type: object
      properties:
        projectName:
          type: string
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentDataNodes'
          description: Deployment nodes data.
    Data6:
      title: Data6
      required:
      - projectName
      type: object
      properties:
        projectName:
          type: string
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentDataNodes'
          description: Deployment nodes data.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Errors1'
          description: Error from NSI against an construct ID.
    Data7:
      title: Data7
      required:
      - projectName
      type: object
      properties:
        projectName:
          type: string
        constructs:
          type: array
          items:
            $ref: '#/components/schemas/Construct'
          description: Array of expectations to be updated
    Data8:
      title: Data8
      type: object
      properties:
        ip:
          type: string
          description: foo
        username:
          type: string
          description: foo
        password:
          type: string
          description: foo
    Data9:
      title: Data9
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes6'
    Data10:
      title: Data10
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes10'
    Data11:
      title: Data11
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes11'
    Data12:
      title: Data12
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes12'
    Data13:
      title: Data13
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes13'
    Data14:
      title: Data14
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes14'
    Data15:
      title: Data15
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes152'
        type:
          type: string
    Data16:
      title: Data16
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes16'
    Data17:
      title: Data17
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes17'
        id:
          type: string
        type:
          type: string
    Data18:
      title: Data18
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes18'
    Data19:
      title: Data19
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes19'
    Data20:
      title: Data20
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes20'
    Data21:
      title: Data21
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes22'
    Data22:
      title: Data22
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes23'
    Data23:
      title: Data23
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes24'
    Data24:
      title: Data24
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes25'
    Data25:
      title: Data25
      type: object
      properties:
        ncId:
          type: string
          default: dbc7eae5-f75e-36f3-9607-a6cb905feadc
        minFrequency:
          type: string
          default: '196.037500'
        maxFrequency:
          type: string
          default: '196.075000'
        channelWidth:
          type: string
          default: '37.50'
        centerFrequency:
          type: string
          default: '196.056250'
        SMD:
          $ref: '#/components/schemas/SMD2'
        WSSOPM:
          $ref: '#/components/schemas/WSSOPM1'
    Data26:
      title: Data26
      type: object
      properties:
        ncId:
          type: string
          default: dbc7eae5-f75e-36f3-9607-a6cb905feadc
        SMD:
          $ref: '#/components/schemas/SMD3'
        WSSOPM:
          $ref: '#/components/schemas/WSSOPM2'
    Data27:
      title: Data27
      type: object
      properties:
        ncId:
          type: string
          default: dbc7eae5-f75e-36f3-9607-a6cb905feadc
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '2'
        chcAid:
          type: array
          items:
            type: string
          description: ''
    Data28:
      title: Data28
      type: object
      properties:
        ncId:
          type: string
          default: dbc7eae5-f75e-36f3-9607-a6cb905feadc
        chcAid:
          type: string
          default: CHC-1-10-22-1
        switchSelector:
          type: string
          default: '5'
    Data29:
      title: Data29
      type: object
      properties:
        id:
          type: string
          description: topicName
        type:
          $ref: '#/components/schemas/Type130'
        attributes:
          $ref: '#/components/schemas/Attributes27'
    Data30:
      title: Data30
      type: object
      properties:
        id:
          type: string
          description: topicName
        type:
          $ref: '#/components/schemas/Type131'
        attributes:
          $ref: '#/components/schemas/Attributes28'
    Data31:
      title: Data31
      type: object
      properties:
        id:
          type: string
          description: topicName
        type:
          $ref: '#/components/schemas/Type132'
        attributes:
          $ref: '#/components/schemas/Attributes29'
    Data32:
      title: Data32
      type: object
      properties:
        projectName:
          type: string
        relatedProjects:
          type: array
          items:
            type: string
          description: ''
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Node1'
          description: ''
    Data33:
      title: Data33
      type: object
      properties:
        description:
          type: string
        policy_name:
          type: string
        state:
          type: string
        policy_type:
          type: string
        policy_id:
          type: string
        customer_name:
          type: string
    Data34:
      title: Data34
      type: object
      properties:
        supported_operation:
          type: string
        master_template:
          type: string
        policy_type:
          type: string
        defaults_file:
          type: string
        handler_class:
          type: string
    Data35:
      title: Data35
      type: object
      properties:
        id:
          type: string
        profile_name:
          type: string
        description:
          type: string
        user_name:
          type: string
        passwd:
          type: string
        ip_address:
          type: string
        protocol_type:
          type: string
        port:
          type: string
        location:
          type: string
    Data36:
      title: Data36
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          default: sorTrace
        attributes:
          $ref: '#/components/schemas/Attributes30'
        relationships:
          $ref: '#/components/schemas/Relationships1'
    Data38:
      title: Data38
      type: object
      properties:
        success:
          type: array
          items:
            type: string
          description: ''
        failure:
          type: array
          items:
            type: string
          description: ''
    Data40:
      title: Data40
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes31'
        type:
          type: string
        id:
          type: string
    Data41:
      title: Data41
      type: object
      properties:
        scan_id:
          type: string
        status:
          type: string
        ne_name:
          type: string
        start_time:
          type: string
        run_by:
          type: string
        facility_aid:
          type: string
        is_baseline:
          type: string
        nc_id:
          type: string
        completed_time:
          type: string
        rptr_sys_family:
          type: string
    Data42:
      title: Data42
      type: object
      properties:
        repeaterAID:
          type: string
        attributes:
          $ref: '#/components/schemas/Attributes32'
    Data43:
      title: Data43
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes33'
    Data44:
      title: Data44
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes34'
        type:
          type: string
        id:
          type: string
    Data45:
      title: Data45
      type: object
      properties:
        deviceName:
          type: string
        deviceType:
          type: string
        lattitude:
          type: string
        longitude:
          type: string
    Data46:
      title: Data46
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes35'
    Data47:
      title: Data47
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes36'
        type:
          type: string
    Data48:
      title: Data48
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes37'
        type:
          type: string
          default: spectrum-sharing-terminal
        id:
          type: string
          default: 9014e61f-92c2-335a-8591-68aa61f2f9c5_OTS-1-1
    Data49:
      title: Data49
      type: object
      properties:
        id:
          type: string
          default: 637a35c6-d24e-11ea-87d0-0242ac130003
        type:
          type: string
          default: sst-detail
        attributes:
          $ref: '#/components/schemas/Attributes38'
    Data50:
      title: Data50
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes39'
    Data51:
      title: Data51
      type: object
      properties:
        id:
          type: string
          default: NMCC-1-2-9-2-1
        type:
          type: string
          default: spectrum-facility
        attributes:
          $ref: '#/components/schemas/Attributes40'
    DataplaneType:
      title: DataplaneType
      enum:
      - mpls
      - srv6
      type: string
      description: Dataplane type of the segments. Can be either Segment-routing MPLS or Segment-routing v6
    Day:
      title: Day
      enum:
      - mon
      - tue
      - wed
      - thu
      - fri
      - sat
      - sun
      type: string
    DayOfWeek:
      title: DayOfWeek
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      type: string
    DefaultAttributeSourcePolicy:
      title: DefaultAttributeSourcePolicy
      enum:
      - plannedOverDiscovered
      - discoveredOverPlanned
      type: string
      description: Source of attribute.
    DefaultsData:
      title: DefaultsData
      type: object
      properties:
        data:
          type: object
    DeleteCallbackRequest:
      title: DeleteCallbackRequest
      required:
      - application
      - name
      type: object
      properties:
        application:
          maxLength: 64
          type: string
          description: The application or service to whom this configuration value belongs.
        instance:
          maxLength: 2
          type: string
          description: The instance identifier of the application. If not provided, the instance will default to the instance agnostic identifier ("-").
        partition:
          maxLength: 64
          type: string
          description: The partition to under which the configuration is found.
        group:
          type: array
          items:
            maxLength: 64
            type: string
          description: Groupings of configurations within a configuration partition. Used to further sort and identify configurations.
        name:
          maxLength: 64
          type: string
          description: The name of the configuration.
        callbacks:
          type: array
          items:
            maxLength: 256
            type: string
          description: A list of URLs specifying the callback location.  Leave blank to delete all callbacks
        password:
          maxLength: 64
          type: string
          description: The optional password for the configuration
    DeleteRequest:
      title: DeleteRequest
      type: object
      properties:
        application:
          maxLength: 64
          type: string
          description: The application or service to whom this configuration value belongs.
        instance:
          maxLength: 2
          type: string
          description: The instance identifier of the application.
        partition:
          maxLength: 64
          type: string
          description: The partition to under which the configuration is found.
        group:
          type: array
          items:
            maxLength: 64
            type: string
          description: Groupings of configurations within a configuration partition. Used to further sort and identify configurations.
        name:
          maxLength: 64
          type: string
          description: The name of the configuration.
        hard:
          type: boolean
          description: Indicates if the metadata should be deleted along with the value.
        password:
          maxLength: 64
          type: string
          description: The optional password for the configuration
    deletesortrace:
      title: deletesortrace
      required:
      - network_construct_id
      - trace_id
      - file_name
      type: object
      properties:
        network_construct_id:
          type: string
          description: Identifier of the Network Construct
        trace_id:
          type: string
          description: OTDR entity id
        file_name:
          type: string
          description: SOR Trace file name
    DeployedShelf:
      title: DeployedShelf
      type: object
      properties:
        deployedShelf:
          type: array
          items:
            $ref: '#/components/schemas/DeployedShelf1'
          description: ''
    deployedNetwork:
      title: deployedNetwork
      type: object
      properties:
        ospfArea:
          type: string
        projectId:
          type: string
        projectName:
          type: string
        shelfIP:
          type: string
        shelfNumber:
          type: string
        tid:
          type: string
        usage:
          type: string
    DeployedShelf1:
      title: DeployedShelf1
      type: object
      properties:
        usage:
          type: string
        projectId:
          type: string
        ospfArea:
          type: string
        shelfNumber:
          type: string
        tid:
          type: string
        projectName:
          type: string
        shelfIP:
          type: string
    Deploymentdata:
      title: Deploymentdata
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/projectDeploymentData'
          description: ''
    Deploymentdata1:
      title: Deploymentdata1
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/projectPostDeploymentResponseData'
          description: ''
    DeploymentState:
      title: DeploymentState
      enum:
      - SCHEDULED
      - NOT_PRESENT_IN_NETWORK
      - DEPLOYMENT_IN_PROGRESS
      - PROVISIONED
      - INCOMPLETE_DEPLOYMENT
      - DEPLOYED
      - COMPLETE_IN_NETWORK
      - INCOMPLETE_PARTIAL
      - INCOMPLETE_PARTIAL_IN_CONFLICT
      - INCOMPLETE_READY_BEST_EFFORT
      - UNDEPLOYMENT_IN_PROGRESS
      - INCOMPLETE_UNDEPLOYMENT
      - DISCOVERED
      - MODIFYING
      - MODIFICATION_FAILED
      type: string
      description: Represents the stage that the FRE is at in the construction/deployment/discovery life cycle
    DeploymentState1:
      title: DeploymentState1
      enum:
      - PARTIALLY_DEFINED
      - DEFINED_AND_VIABLE
      - READY_TO_DEPLOY
      - DEPLOYMENT_IN_PROGRESS
      - INCOMPLETE_DEPLOYMENT
      - INCOMPLETE_NOT_READY
      - INCOMPLETE_NOT_READY_CONFLICT
      - INCOMPLETE_READY_BEST_EFFORT
      - COMPLETE_FULLY_READY
      - UNDEPLOYMENT_IN_PROGRESS
      - INCOMPLETE_UNDEPLOYMENT
      - UNDEPLOYED
      - WAITING_TO_ADOPT
      type: string
    DeploymentStateDependents:
      title: DeploymentStateDependents
      enum:
      - COMPLETE_IN_NETWORK
      - INCOMPLETE_PARTIAL
      - INCOMPLETE_PARTIAL_IN_CONFLICT
      type: string
      description: Represents rolled deployment state of the immediate children
    DesiredOrchState:
      title: DesiredOrchState
      enum:
      - active
      - assembled
      - requested
      - scheduled
      - terminated
      - unspecified
      type: string
      description: Desired orchestration state
    DevicetypesURL:
      title: DevicetypesURL
      required:
      - deviceType
      - scriptLinks
      type: object
      properties:
        deviceType:
          type: string
          description: The device type value
        scriptLinks:
          type: array
          items:
            $ref: '#/components/schemas/ScriptLink'
          description: The URLs array to get commissioning scripts for each device type.
    DiagnosticType:
      title: DiagnosticType
      enum:
      - PM_TEST
      type: string
    dir:
      title: dir
      enum:
      - Tx
      - Rx
      type: string
    Direction:
      title: Direction
      enum:
      - tx
      - rx
      type: string
    Direction1:
      title: Direction1
      enum:
      - in
      - out
      type: string
      description: Direction to filter BGP advertisements.
    Direction2:
      title: Direction2
      enum:
      - rx
      - tx
      - both
      type: string
      description: Outbound Route Filtering direction
    Direction3:
      title: Direction3
      enum:
      - in
      - out
      type: string
      description: The route-map direction.
    Direction4:
      title: Direction4
      enum:
      - bidirectional
      - ingress
      - egress
      - unidirectional
      type: string
      description: Tunnel direction. Use value bidirectional or unidirectional only and TPE attribute stackDirection since ingress and egress are ambiguous
    Direction5:
      title: Direction5
      enum:
      - RX
      - TX
      - RXTX
      type: string
      description: The directionality defined in terms of RX/TX.
    Direction7:
      title: Direction7
      enum:
      - in
      - out
      type: string
      description: Prefix list direction to filter BGP advertisements.
    Direction12:
      title: Direction12
      enum:
      - Tx
      - Rx
      type: string
      description: the direction of the resiliency service
    Direction14:
      title: Direction14
      enum:
      - in
      - out
      type: string
    Direction15:
      title: Direction15
      enum:
      - INPUT
      - OUTPUT
      type: string
      description: The direction (input or output) of the timing reference with respect to the timing node
    Direction17:
      title: Direction17
      type: object
      properties:
        value:
          type: string
    Directionality:
      title: Directionality
      enum:
      - unidirectional
      - bidirectional
      type: string
      description: Indicates if the FRE is unidirectional or bidirectional
    Directionality1:
      title: Directionality1
      enum:
      - bidirectional
      - unidirectional
      type: string
      description: Indicates if the FRE is unidirectional or bidirectional.
    Directionality2:
      title: Directionality2
      enum:
      - UNIDIRECTIONAL
      - BIDIRECTIONAL
      type: string
      description: Describes the directionality of the routes traffic flow.
    directionality5:
      title: directionality5
      enum:
      - unidirectional
      - bidirectional
      type: string
    DiscoveryState:
      title: DiscoveryState
      enum:
      - PENDING
      - AUTO_DISCOVERED
      - VALIDATING
      - VALIDATING_FAILED
      - CONNECTING
      - CONNECTED
      - DISCOVERING
      - COMPLETED
      - DISCOVERY_RETRY
      - CHANGE_SESSION
      - RECONNECT
      - CONFLICT_NAME
      - DEENROLLING
      - DISCONNECTED
      - FAILED_CONNECT
      - FAILED_DISCOVERY
      - POKING
      type: string
      description: >-
        Discovery state of the management session.
         PENDING is the state of staging.
         AUTO_DISCOVERED is the state of being auto discovered but not connected.
         VALIDATING is the state setting up a session;
         VALIDATING_FAILED, failed to setup a session;
         CONNECTING, connecting a session to NE;
         CONNECTED, session connected.
         DISCOVERING, in progress of shallow discovery;
         COMPLETED, shallow discovery completed.
         DISCOVERY_RETRY, shallow discovery failed.
         CHANGE_SESSION, in progress of change active session.
         DERENROLLING, in progress of deenrolling NE.
    DiscrepancyState:
      title: DiscrepancyState
      enum:
      - MATCH
      - MISMATCH
      - CHILD_CONFLICT
      type: string
      description: Represents the comparison of planned and discovered data for an FRE
    DisplayAvailabilityState:
      title: DisplayAvailabilityState
      enum:
      - PLANNED
      - AVAILABLE
      - UNVALIDATED
      - IN_USE
      type: string
      description: Display name of the equipment availability state
    DisplayDeploymentState:
      title: DisplayDeploymentState
      enum:
      - SCHEDULED
      - NETWORK_MISMATCH_DETECTED
      - PROPERTY_MISMATCH
      - DEPLOYED
      - DISCOVERED
      - DEPLOYING
      - MONITORING
      - DEPLOYMENT_FAILED
      - DELETING
      - DELETE_FAILED
      - MODIFYING
      - MODIFICATION_FAILED
      type: string
      description: Represents the stage that the FRE is at in the construction/deployment/discovery life cycle
    DisplayFormat:
      title: DisplayFormat
      enum:
      - DECIMAL
      - BIT
      - STRING
      - HEXADECIMAL
      type: string
      description: Suggests how the opaque equivalent value will be displayed to user
    DisplayFormat1:
      title: DisplayFormat1
      enum:
      - DECIMAL
      - BIT
      - ENUM
      - HEXADECIMAL
      type: string
      description: Suggests how the Structure value will be displayed to user
    DisplayServerRefreshState:
      title: DisplayServerRefreshState
      enum:
      - PENDING
      - CALCULATING
      - PROVISIONING
      - FAILED
      - NOT_APPLICABLE
      type: string
      description: Enumeration of the various SNC refresh life cycle states
    DisplayState:
      title: DisplayState
      enum:
      - IS
      - OOS
      - OOS_AU
      - OOS_MA
      - OOS_AUMA
      type: string
      description: Display state of the equipment
    DisplayState1:
      title: DisplayState1
      enum:
      - PENDING
      - CONNECTING
      - CONNECTED
      - FAILED
      - NOT_CONNECTED
      type: string
      description: Discovery state of the management session
    DisplaySyncState:
      title: DisplaySyncState
      enum:
      - PLANNED
      - NOT_SYNCHRONIZED
      - SYNCHRONIZING
      - SYNCHRONIZED
      - FAILED
      - PENDING
      - DELETING
      - TIMEOUT
      - AUDIT_PENDING
      - AUDITING
      type: string
    DiversityLevel:
      title: DiversityLevel
      enum:
      - strict
      - maximal
      type: string
      description: The diversity level of backup tunnel creation (maximal meaning best-effort)
    DiversityResource:
      title: DiversityResource
      enum:
      - unknown
      - none
      - link
      - srlg
      - node
      - srlg_and_node
      - srlg_and_link
      - link_and_node
      - srlg_or_node
      - srlg_and_link_and_node
      type: string
      description: The object upon which to base diversity for the backup tunnel
    DmmState:
      title: DmmState
      enum:
      - ENABLED
      - DISABLED
      - PARTIAL
      type: string
      description: DMM Measurement State (enabled/disabled/partial)
    duration1:
      title: duration1
      enum:
      - 15 MINUTES
      - 30 MINUTES
      - 1 HOURS
      - 2 HOURS
      - 3 HOURS
      - 6 HOURS
      - 24 HOURS
      - 48 HOURS
      type: string
    DynamicLayerRate:
      title: DynamicLayerRate
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    DynamicLayerRate1:
      title: DynamicLayerRate1
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    EFreTerminationState:
      title: EFreTerminationState
      enum:
      - hapFre_terminated
      - hapFre_not_terminated
      type: string
      description: Values to handle TPEs that have multiple poolAdapters, especially multiple poolAdapters adapting to the same layer rate
    EirPolicy:
      title: EirPolicy
      enum:
      - no_auto_adjust
      - eir_as_percent
      type: string
    EirPolicy1:
      title: EirPolicy1
      enum:
      - no_auto_adjust
      - eir_as_percent
      - auto_adjust_disabled
      type: string
    EndPointPolicy:
      title: EndPointPolicy
      enum:
      - EndPointAddDelete
      - EndPointNone
      type: string
      description: For the end point(s) of an FRE will be added/deleted/no-action along with FRE's change
    EntityType:
      title: EntityType
      enum:
      - FRES
      - EQUIPMENTS
      - NETWORK_CONSTRUCTS
      type: string
    Error1:
      title: Error1
      required:
      - code
      - detail
      - title
      type: object
      properties:
        code:
          type: string
          description: Error code
        detail:
          type: string
          description: Error description
        title:
          type: string
          description: Error Title
      description: Error response object
    ErrorOperation:
      title: ErrorOperation
      enum:
      - start
      - stop
      type: string
    ErrorPoint:
      title: ErrorPoint
      enum:
      - GENA
      - GENB
      type: string
    ErrorRate:
      title: ErrorRate
      enum:
      - single
      - continuous
      type: string
    Errors1:
      title: Errors1
      type: object
      properties:
        code:
          type: string
          description: Error code
        title:
          type: string
          description: Error title
        details:
          type: string
          description: Error details
    Errors2:
      title: Errors2
      type: object
      properties:
        status:
          type: string
          description: The HTTP status code
        detail:
          type: string
          description: The detailed description of the error
        title:
          type: string
          description: The error title
    Errors3:
      title: Errors3
      type: object
      properties:
        code:
          type: string
          description: Application error code
        status:
          type: string
          description: HTTP status code
        title:
          type: string
          description: The error title
    ErrorType:
      title: ErrorType
      enum:
      - Bit_Error
      - LF
      - RF
      type: string
    EtherType:
      title: EtherType
      enum:
      - ET_8100
      - ET_88A8
      - ET_88E7
      - ET_9100
      - ET_9101
      type: string
      description: tpid-8100/tpid-88a8/tpid-9100
    EvcPortType:
      title: EvcPortType
      enum:
      - MAPPED
      - TRANSPARENT
      type: string
      description: Convenient instruction about handling endpoint data (e.g. ETHERNET differentiates EPL from EVPL via CVID).
    EventType:
      title: EventType
      enum:
      - ResourceSnapshot
      - ResourceDelete
      type: string
    exclude:
      title: exclude
      enum:
      - actual
      - expectation
      type: string
    ExecutionType:
      title: ExecutionType
      enum:
      - MANUAL
      - SCHEDULED
      - IDLE
      type: string
    facilityBypass:
      title: facilityBypass
      enum:
      - exclude
      type: string
    FacilityType:
      title: FacilityType
      enum:
      - SDMON
      - CHMON
      - OPM
      type: string
      description: The facility type to query; must be either SDMON or CHMON or OPM.
    Failed21:
      title: Failed21
      type: object
      properties:
        status:
          type: string
          default: Failed
        errors:
          type: array
          items:
            type: string
          description: ''
    FailureOrDelayed:
      title: FailureOrDelayed
      type: object
      properties:
        lastCollection:
          type: string
        previousCollection:
          type: string
    FamilyType:
      title: FamilyType
      type: object
      properties:
        value:
          type: string
    field:
      title: field
      enum:
      - uri
      - commitHash
      - versionSignature
      - releaseSignature
      - upgradeAvailable
      type: string
    FieldKind:
      title: FieldKind
      enum:
      - provider
      - user
      type: string
      description: Indicates what the identifying property field points to
    fillratio:
      title: fillratio
      enum:
      - current
      - full
      type: string
    Filter1:
      title: Filter1
      type: object
      properties:
        networkElements:
          $ref: '#/components/schemas/NetworkElements2'
        networkElementsAndFacilities:
          type: object
          additionalProperties: {}
          description: A map of network element names to lists of facilities from which to query correlated metrics. In order for paging to behave correctly, only include one facility type in your query, either SDMON or CHMON or OPM. Ensure that the facility name does NOT include the subport value, only use the shelf-slot-port.
      description: Define a filter for your query. Specify only ONE of networkElementsAndFacilities or networkElements.
    filter2:
      title: filter2
      enum:
      - all
      - max
      - min
      - mean
      type: string
    FindingState:
      title: FindingState
      enum:
      - NoFindings
      - Findings
      type: string
      description: Audit Type
    FlexFrameType:
      title: FlexFrameType
      enum:
      - CBR
      - GFP_F
      type: string
      description: Type of Framing used in the Flex.
    FlowSelection:
      title: FlowSelection
      enum:
      - working
      - protecting
      type: string
      description: flowSelect
    FlowType:
      title: FlowType
      enum:
      - CommonIngress
      type: string
    Frequency:
      title: Frequency
      enum:
      - ONCE
      - DAILY
      - WEEKLY
      - MONTHLY
      type: string
    Frequency1:
      title: Frequency1
      enum:
      - MINUTELY
      - HOURLY
      - DAILY
      - WEEKLY
      - MONTHLY
      - YEARLY
      type: string
      description: frequency of recurrence
    Frequency2:
      title: Frequency2
      type: object
      properties:
        spectrumRange:
          type: array
          items:
            type: string
          description: ''
        usedSpectrumRange:
          type: array
          items:
            type: string
          description: ''
    FreType:
      title: FreType
      enum:
      - explicitRoute
      - explicitRouteGroup
      - cascadedExplicitRoute
      - snc
      - sncGroup
      - regen
      - route
      - resilientConfig
      - osrpLine
      - osrpLink
      - sncp
      - eline
      - elan
      - etree
      - dropAndContinue
      - explicitRouteInstance
      - omsCutThroughRegen
      - l3vpn
      - cascadedExplicitRouteInstance
      - staticRoute
      - eBgpSession
      - vpws
      type: string
      description: The sub type of FRE
    Fri:
      title: Fri
      enum:
      - ON
      - OFF
      type: string
    FrrProfile:
      title: FrrProfile
      enum:
      - none
      - link_protect
      - node_protect
      type: string
      description: Deprecated by frr package and will be removed later. The fast re-route profile for this MPLS tunnel
    FrrSignaling:
      title: FrrSignaling
      enum:
      - on
      - off
      type: string
      description: Deprecated by frr package and will be removed later. Flag for fast re-route capability
    FunctionType:
      title: FunctionType
      enum:
      - PUSH
      - POP
      - STAMP
      type: string
      description: nature of operation push/pop/stamp
    Granularity:
      title: Granularity
      enum:
      - UNTIMED
      - 15_MINUTE
      - 24_HOUR
      - BASELINE
      - ALL
      type: string
    Granularity2:
      title: Granularity2
      enum:
      - bin_24_hour
      - bin_15_minute
      type: string
    Granularity3:
      title: Granularity3
      enum:
      - untimed
      - bin_24_hour
      - bin_15_minute
      type: string
    Granularity4:
      title: Granularity4
      enum:
      - UNTIMED
      - BASELINE
      type: string
    granularity5:
      title: granularity5
      enum:
      - 1_Day
      - 7_Days
      type: string
    GrCapability:
      title: GrCapability
      enum:
      - enabled
      - disabled
      type: string
      description: GR capability
    group:
      title: group
      enum:
      - dwa
      - infrastructure
      - packet
      - packet_infrastructure
      - tdm
      type: string
    group4:
      title: group4
      enum:
      - dwa
      - infrastructure
      - packet
      type: string
    GroupType:
      title: GroupType
      enum:
      - INCLUSION
      - EXCLUSION
      type: string
      description: The resource type
    GuardTimeUnit:
      title: GuardTimeUnit
      enum:
      - min
      - sec
      - msec
      type: string
      description: Unit of time
    HoldOffTimeUnit:
      title: HoldOffTimeUnit
      enum:
      - min
      - sec
      - msec
      type: string
      description: Unit of time
    HomeCostPreference:
      title: HomeCostPreference
      enum:
      - Mandatory
      - BestEffort
      - Disable
      type: string
      description: Available Cost Preferences for home and protect path of SNC
    HopType:
      title: HopType
      enum:
      - strict
      - loose
      type: string
      description: The type of this hop
    Id:
      title: Id
      enum:
      - SRLG_FORMAT
      type: string
    Identifiers:
      title: Identifiers
      type: object
      properties:
        type:
          type: string
          description: type of network construct, shelf, networkElement, osrpNode
        ncId:
          type: string
          description: Network construct id
        ncExpectationId:
          type: string
          description: Network construct expectation id.What about multiple expectations for a NC?
      description: Network construct and expectation ids to be updated
    IdType:
      title: IdType
      enum:
      - macAddress
      - ipAddress
      - tpes
      - mepId
      type: string
    IffX:
      title: IffX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    IffY:
      title: IffY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    Impact:
      title: Impact
      enum:
      - trafficImpactingWithNoMatch
      - noTrafficImpactWithNoMatch
      type: string
    include:
      title: include
      enum:
      - expectations
      - physicalLocation
      - parentNetworkConstruct
      - networkConstructDiscovered
      - networkConstructPlanned
      type: string
    IndexName:
      title: IndexName
      enum:
      - wavelength
      - odu4_index
      - odu2_index
      - frequency
      - nmcId
      type: string
      description: Named attribute of the signal index
    InputX:
      title: InputX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    InputY:
      title: InputY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    IntegrityCheckEnabled:
      title: IntegrityCheckEnabled
      enum:
      - YES
      - NO
      type: string
      description: This parameter indicates the SnIC Admin State for a SNC. It can be yes or no to enable or disable SnIC on a SNC.
    IntentDeploymentState:
      title: IntentDeploymentState
      enum:
      - READY_TO_DEPLOY
      - DEPLOYMENT_IN_PROGRESS
      - INCOMPLETE_DEPLOYMENT
      - COMPLETE_FULLY_READY
      - INCOMPLETE_NOT_READY
      - INCOMPLETE_NOT_READY_CONFLICT
      - INCOMPLETE_READY_BEST_EFFORT
      - UNDEPLOYMENT_IN_PROGRESS
      - INCOMPLETE_UNDEPLOYMENT
      - WAITING_TO_ADOPT
      type: string
      description: Represents the intent deployment stage that the FRE is at in the construction/deployment/discovery life cycle
    IntentDeploymentStateString:
      title: IntentDeploymentStateString
      enum:
      - NOT_APPLICABLE
      - IN_PROGRESS
      - MONITORING
      - FAILED
      - IN_THE_NETWORK
      - NETWORK_MISMATCH_DETECTED
      - PROPERTY_MISMATCH
      type: string
      description: Represents the deployment state of the service intent through its life cycle
    IntentLifeCycle:
      title: IntentLifeCycle
      enum:
      - SCHEDULED
      - DEPLOYMENT_IN_PROGRESS
      - PROVISIONED
      - INCOMPLETE_DEPLOYMENT
      - UNDEPLOYMENT_IN_PROGRESS
      - INCOMPLETE_UNDEPLOYMENT
      - COMPLETE_IN_NETWORK
      - MODIFYING
      - MODIFICATION_FAILED
      type: string
      description: Represents the Intent LifeCycle owned by IFD
    IntentLifeCyclePhase:
      title: IntentLifeCyclePhase
      enum:
      - WAITING_TO_DEPLOY
      - DEPLOYING
      - ASSURING
      - RETIRING
      - ADOPTING_DISCOVERED
      type: string
      description: Represents the intent life cycle stage that the FRE is at in the construction/deployment/discovery life cycle
    IntentLifeCyclePhaseString:
      title: IntentLifeCyclePhaseString
      enum:
      - SCHEDULED
      - DEPLOYING
      - DEPLOYED
      - DELETING
      - DISCOVERED
      type: string
      description: Represents the different phases of the service intent through its life cycle
    InterfaceStatus:
      title: InterfaceStatus
      enum:
      - UP
      - DOWN
      type: string
      description: 'interface status: Up or Down'
    InterfaceType:
      title: InterfaceType
      enum:
      - UNI
      type: string
      description: Convenient instruction to identify the endpoint role.
    InternalStructure:
      title: InternalStructure
      enum:
      - SIMPLE
      - SIMPLE_SWITCHED
      - PROTECTED_ONE_END
      - MULTI_SIMPLE
      - MULTIPLE
      - PROTECTED_BOTH_ENDS
      - MULTIPOINT
      - HUB_AND_SPOKE
      - EXPLICIT
      - INTERCONNECT_ONE_END
      - INTERCONNECT_BOTH_ENDS
      - DUAL_HOMED_ONE_END
      - DUAL_HOMED_BOTH_ENDS
      - MULTIPOINT_DC
      - FULL_MESH
      - PARTIAL_MESH
      - UNKNOWN
      - MULTI_HOMED_ONE_END
      - MULTI_HOMED_BOTH_END
      - HVPLS
      type: string
      description: Visible abstraction of the internal structure of the FRE
    IntraCluster:
      title: IntraCluster
      enum:
      - enabled
      - disabled
      type: string
      description: A flag to check if cluster is intra-cluster.
    IPAddress:
      title: IPAddress
      type: object
      properties:
        data:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/ipaddressdatum'
    ipaddressdatum:
      title: ipaddressdatum
      type: object
      properties:
        ipaddress:
          type: string
    IPSubnet2:
      title: IPSubnet2
      type: object
      properties:
        ipsubnet:
          type: array
          items:
            $ref: '#/components/schemas/Ipsubnet3'
          description: ''
    Ipsubnet3:
      title: Ipsubnet3
      type: object
      properties:
        usage:
          type: string
        subnetId:
          type: string
        ospfArea:
          type: string
        shelfIP:
          type: array
          items:
            type: object
          description: ''
    Ipv4LabeledUnicast:
      title: Ipv4LabeledUnicast
      enum:
      - DISABLED
      - ENABLED
      type: string
      description: Frr state for ipv4LabeledUnicast on Node/ Equipment Group.
    Ipv4Unicast:
      title: Ipv4Unicast
      enum:
      - DISABLED
      - ENABLED
      type: string
      description: Frr state for ipv4Unicast on Node/ Equipment Group.
    Job1:
      title: Job1
      enum:
      - auto_assign
      - clear_auto_assign
      - propagate
      - write_to_network
      - propagate_share_srlg
      - clear_propagated_share_srlg
      - assign_external_srlg
      - release_external_srlg
      - reset_external_srlg
      - audit_fb_profile
      - clear_manual_assign
      type: string
    JobType:
      title: JobType
      enum:
      - auto_assign
      - clear_auto_assign
      - propagate
      - write_to_network
      - propagate_share_srlg
      - clear_propagated_share_srlg
      - assign_external_srlg
      - release_external_srlg
      - reset_external_srlg
      - audit_fb_profile
      - clear_manual_assign
      type: string
    Key:
      title: Key
      enum:
      - RACK
      - SHELF
      - SUBSHELF
      - SLOT
      - SUBSLOT
      - PORT
      type: string
      description: The type of the address location.
    L2NodeRole:
      title: L2NodeRole
      enum:
      - AN
      - AGN
      - NID
      type: string
      description: L2 Node Role.
    Label:
      title: Label
      type: object
      properties:
        value:
          type: string
    LastHopBehavior:
      title: LastHopBehavior
      enum:
      - EXPLICIT_NULL
      - NO_PHP
      - PHP
      - N_FLAG_CLEAR
      type: string
      description: Last-Hop behavior.
    Layer:
      title: Layer
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    Layer2:
      title: Layer2
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    Layer4:
      title: Layer4
      enum:
      - PHASE
      - FREQUENCY
      type: string
      description: The definition of all TimingLayer enumerations
    LayerProtocolQualifier:
      title: LayerProtocolQualifier
      enum:
      - ODU2
      - ODU2e
      - ODU4
      - ODU3
      - ETHERNET
      - DSR_10GE
      - DSR_40GE
      - DSR_100GE
      - OC192
      - STM64
      - OC768
      - STM256
      - DSR_1GE
      - OC48
      - STM16
      - ODU1
      - FC100
      - FC200
      - FC400
      - FC800
      - FC1200
      - FC1600
      - FC3200
      - FICON1G
      - FICONEXPRESS2G
      - FICON4G
      - FICON8G
      - FICON16G
      type: string
    LayerRate:
      title: LayerRate
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    LayerRate2:
      title: LayerRate2
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    LayerRateQualifier:
      title: LayerRateQualifier
      enum:
      - ODUC1
      - ODUC2
      - ODUC2_25
      - ODUC2_30
      - ODUC3
      - ODUC4
      - ODUC4_60
      - ODUC4_70
      - ODUC5
      - ODUC5_90
      - ODUC6
      - ODUC6_110
      - ODUC7
      - ODUC8
      - ODUC9
      - ODUC10
      - ODUC11
      - ODUC12
      - ODUC13
      - ODUC14
      - ODUC15
      - ODUC16
      - OTUC1
      - OTUC2
      - OTUC2_25
      - OTUC2_30
      - OTUC3
      - OTUC3_50
      - OTUC4
      - OTUC4_60
      - OTUC4_70
      - OTUC5
      - OTUC5_90
      - OTUC6
      - OTUC6_110
      - OTUC7
      - OTUC8
      - OTUC9
      - OTUC10
      - OTUC11
      - OTUC12
      - OTUC13
      - OTUC14
      - OTUC15
      - OTUC16
      - OC3
      - OC12
      - OC48
      - OC192
      - OC768
      - STM1
      - STM4
      - STM16
      - STM64
      - STM256
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - _1GE
      - _10GE
      - _40GE
      - _100GE
      - _400GE
      - _2G5
      - _1G25
      - _10G
      - _40G
      - _100G
      - _150G
      - _200G
      - _250G
      - _300G
      - _350G
      - _400G
      - _450G
      - _500G
      - _550G
      - _600G
      - _650G
      - _700G
      - _750G
      - _800G
      - ETHFLEX
      - _10GE_ODUFLEX
      - _100GE_ODUFLEX
      - FICON1G
      - FICONEXPRESS2G
      - FICON4G
      - FICON8G
      - FICON16G
      - FC100
      - FC200
      - FC400
      - FC800
      - FC1200
      - FC1600
      - FC3200
      - _2G5_CBR
      - _10G_CBR
      - UNKNOWN
      type: string
      description: Provides a means to provide additional qualification attributes for a Layer Rate. For example, for beyond 100G rates OTUCn and ODUCn, the value of n, where n is a multiple of 100. For example, for beyond 100G rates with sub rate potential (i.e. OTUCn-M), this includes the n-M options where n is the number of OxUC overhead instances and M is the number of 5G tributary slots. For example, OTUC4-60 implies 4 instances of OxUC overhead, and 300G capacity (5G x 60).
    LayerRateStack:
      title: LayerRateStack
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
    LdpIgpSyncLevelType:
      title: LdpIgpSyncLevelType
      enum:
      - LEVEL_1
      - LEVEL_2
      - LEVEL_1_2
      type: string
      description: enable MPLS LDP synchronization for an ISIS level
    Leg:
      title: Leg
      enum:
      - trunk
      - a1
      - a2
      type: string
    Level:
      title: Level
      enum:
      - DEBUG
      - INFO
      - WARNING
      - ERROR
      - PANIC
      type: string
      description: The log level [DEBUG,INFO,WARNING,ERROR,PANIC]
    Level1:
      title: Level1
      enum:
      - WARNING
      - CRITICAL
      - OK
      type: string
      description: Disk space is filled up
    Level2:
      title: Level2
      enum:
      - WARNING
      - CRITICAL
      - OK
      type: string
      description: Kafka is up or down
    Level3:
      title: Level3
      enum:
      - WARNING
      - CRITICAL
      - OK
      type: string
      description: Pithos is up or down
    LevelType:
      title: LevelType
      enum:
      - LEVEL_1
      - LEVEL_2
      - LEVEL_1_2
      type: string
      description: level of an ISIS instance
    LIM:
      title: LIM
      type: object
      properties:
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '5'
    LinkAttributes1:
      title: LinkAttributes1
      type: object
      properties:
        userLabel:
          type: string
    Links1:
      title: Links1
      type: object
      properties:
        nextPage:
          type: string
          description: A relative URL pointing to the next page of results.
        self:
          type: string
          description: A relative URL pointing to the current page.
    Links2:
      title: Links2
      type: object
      properties:
        nextInterval:
          type: string
          description: A relative URL pointing to the next interval of datapoints for the time series in the current response. The interval returned for a single page can be specified as 'interval' in the request.
        nextPage:
          type: string
          description: A relative URL pointing to the next page of time series matching the request filter. The maximum amount of time series on a single page can be specified as 'pageSize' in the request.
        previousInterval:
          type: string
          description: A relative URL pointing to the previous interval of datapoints for the time series in the current response. The interval returned for a single page can be specified as 'interval' in the request.
        previousPage:
          type: string
          description: A relative URL pointing to the previous page of time series matching the request filter. The maximum amount of time series on a single page can be specified as 'pageSize' in the request.
        self:
          type: string
          description: A relative URL pointing to the current page
    Links4:
      title: Links4
      type: object
      properties:
        next:
          type: string
          description: Token for next page request along with resource path
        current:
          type: string
          description: Current resource path and URL query string
    Links14:
      title: Links14
      type: object
      properties:
        self:
          type: string
          description: Self resource path and URL query string
    Location1:
      title: Location1
      enum:
      - self
      - intent
      - farEnd
      - immediateClientTpe
      type: string
      description: If an input, where to find the attribute. If an output, where to set the attribute.
    LocationType:
      title: LocationType
      enum:
      - EXTERNAL
      - INTERNAL
      type: string
    LogicalRule:
      title: LogicalRule
      enum:
      - xOR
      - OR
      type: string
      description: Restrict the number of active poolAdapters could be xOR or OR - default is OR
    LowerBoundaryRule:
      title: LowerBoundaryRule
      enum:
      - mustSnapTo6_25GHzGrid_0_768
      - mustSnapTo37_5GHzGrid_0_96
      - snapTo6_25GHzGrid
      - snapTo50GHzGrid
      - snapTo100GHzGrid
      - snapTo75GHzGrid
      type: string
      description: Rule that the boundary of the range must follow. Can point to a specific algorithm to be executed.
    lqsData.fiber.method:
      title: lqsData.fiber.method
      enum:
      - totalPower
      - osc
      type: string
    lqsData.fiber.reconciled:
      title: lqsData.fiber.reconciled
      enum:
      - 'true'
      - 'false'
      type: string
    lqsData.margin.valid:
      title: lqsData.margin.valid
      enum:
      - 'true'
      - 'false'
      type: string
    lqsData.status:
      title: lqsData.status
      enum:
      - good
      - high
      - low
      - upgrade
      type: string
    ManagementType:
      title: ManagementType
      enum:
      - tl1
      - saos
      - netconf
      - rest
      - corba
      - submarineConf
      type: string
    Mapping:
      title: Mapping
      enum:
      - FIXED
      - FLEXIBLE
      - FLEXIBLE_GROUPED
      - FIXED_GROUP_FLEXIBLE_RANGE
      - ALL
      type: string
      description: Identifies namespace to capacity mapping.
    MatchingScope:
      title: MatchingScope
      enum:
      - e2e
      - local
      type: string
    Md5Authentication:
      title: Md5Authentication
      enum:
      - enabled
      - disabled
      type: string
      description: If MD5 authentication is enabled or disabled for the neighbor.
    MemberFunction:
      title: MemberFunction
      enum:
      - ILA
      - DGE
      - ROADM
      - TOADM
      - PASSIVE
      type: string
      description: Member function of the network construct.
    MepAdminState:
      title: MepAdminState
      enum:
      - ENABLED
      - DISABLED
      type: string
      description: The administrative state (enabled/disabled) of the MEP
    MepType:
      title: MepType
      enum:
      - UP
      - DOWN
      type: string
      description: The type of the MEP, up or down
    Meta:
      title: Meta
      type: object
      properties:
        count:
          type: string
    Meta1:
      title: Meta1
      type: object
      properties:
        count:
          type: string
        total:
          type: string
    Meta2:
      title: Meta2
      required:
      - context-total
      - total-series
      type: object
      properties:
        context-total:
          type: number
        total-series:
          type: number
    Meta3:
      title: Meta3
      type: object
      properties:
        totalMatchingResources:
          type: integer
          format: int32
        totalResources:
          type: integer
          format: int32
    Method:
      title: Method
      enum:
      - totalPower
      - osc
      - ramanTelemetry
      - rls
      type: string
    method1:
      title: method1
      enum:
      - PATCH
      - PUT
      type: string
    method2:
      title: method2
      enum:
      - PATCH
      - PUT
      - DELETE
      type: string
    MetricStyle:
      title: MetricStyle
      enum:
      - wide
      type: string
      description: Metric style global configuration
    Mode:
      title: Mode
      enum:
      - LEGACY
      - MEF_35_1
      type: string
      description: The Y1731 session is to be provisioned in MEF35.1 Mode.
    Mode2:
      title: Mode2
      enum:
      - Collect
      - Upload
      - Schedule
      type: string
    ModelType:
      title: ModelType
      enum:
      - controlPlane
      - regenService
      - resiliency
      type: string
      description: The model type of network construct, TPE, FRE.
    Mon:
      title: Mon
      enum:
      - ON
      - OFF
      type: string
    Month:
      title: Month
      enum:
      - JANUARY
      - FEBRUARY
      - MARCH
      - APRIL
      - MAY
      - JUNE
      - JULY
      - AUGUST
      - SEPTEMBER
      - OCTOBER
      - NOVEMBER
      - DECEMBER
      type: string
    MultiHighestStackLayerRate:
      title: MultiHighestStackLayerRate
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    MultiHomingMode:
      title: MultiHomingMode
      enum:
      - SINGLE_ACTIVE
      - ALL_ACTIVE
      type: string
      description: mode of multiHoming
    Name:
      title: Name
      enum:
      - IPV4_UNICAST
      - IPV4_LABELED_UNICAST
      type: string
      description: Supported afi-safi names.
    Name1:
      title: Name1
      enum:
      - CRITICAL
      - NETWORK
      - PREMIUM
      - PLATINUM
      - GOLD
      - SILVER
      - BRONZE
      - STANDARD
      type: string
      description: Name of the class of service
    Name4:
      title: Name4
      enum:
      - RISK_TYPE
      - RISK_VALUE
      - SUB_NETWORK
      type: string
    NativeLayerRate:
      title: NativeLayerRate
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    NativeLayerRate1:
      title: NativeLayerRate1
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    NeContactState:
      title: NeContactState
      enum:
      - IN
      - OUT
      type: string
      description: The connection status of a shelf
    NeDetails:
      title: NeDetails
      type: object
      properties:
        neType:
          type: string
          default: '6500'
        neName:
          type: string
          default: TID-1
        ncId:
          type: string
          default: 3983102e-9d66-3820-xxx-9b7a042c6539
    NeDetails1:
      title: NeDetails1
      type: object
      properties:
        facilityAid:
          type: string
        scanId:
          type: string
        rptrSysFamily:
          type: string
        ncId:
          type: string
    NetworkConstruct:
      title: NetworkConstruct
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ConnectionAttributesData'
    networkConstruct.id.operator:
      title: networkConstruct.id.operator
      enum:
      - or
      - and
      type: string
    networkConstruct.idQualifier:
      title: networkConstruct.idQualifier
      enum:
      - or
      - and
      type: string
    NetworkConstructType:
      title: NetworkConstructType
      enum:
      - networkElement
      - shelf
      - osrpNode
      - manual
      - branchingUnit
      - submarineRepeater
      - foreignNode
      - unknown
      type: string
      description: The type of network construct. It is used to represent the physical hierarchy of a network element.
    networkConstructType3:
      title: networkConstructType3
      enum:
      - networkElement
      - shelf
      - osrpNode
      type: string
    NetworkElementNames:
      title: NetworkElementNames
      type: object
      properties:
        LOA_NEs:
          type: array
          items:
            type: string
          description: ''
        failureOrDelayed:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FailureOrDelayed'
        success:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Success'
    NetworkElements:
      title: NetworkElements
      required:
      - facilityType
      - networkElementList
      type: object
      properties:
        facilityType:
          $ref: '#/components/schemas/FacilityType'
        networkElementList:
          type: array
          items:
            type: string
          description: The list of network elements from which to query all SDMON or CHMON or OPM facilities.
      description: A list of network element names from which to query correlated metrics from ALL SDMON or CHMON or OPM facilities.
    NetworkRole:
      title: NetworkRole
      enum:
      - IFRE
      - FREAP
      - FREhAP
      - ROADMLINE
      - IFRECP
      - EFRE
      type: string
      description: Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
    networkRole3:
      title: networkRole3
      enum:
      - IFRE
      - FREAP
      - FREhAP
      - ROADMLINE
      - IFRECP
      type: string
    networkRole4:
      title: networkRole4
      enum:
      - IFRE
      - FREAP
      - ROADMLINE
      - IFRECP
      type: string
    NMCCdetails:
      title: NMCCdetails
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data51'
          description: ''
    Node:
      title: Node
      required:
      - nodeType
      - shelves
      - deviceType
      - nodeName
      - scriptLinks
      type: object
      properties:
        nodeType:
          type: string
          description: Node type of the node.
        shelves:
          type: array
          items:
            $ref: '#/components/schemas/Shelf'
          description: Shelves available in the node.
        deviceType:
          type: string
          description: Device type
        nodeName:
          type: string
          description: Node name
        scriptLinks:
          type: array
          items:
            $ref: '#/components/schemas/ScriptLink1'
          description: The URLs array to get the commissioning script for a node.
    Node1:
      title: Node1
      type: object
      properties:
        nodeType:
          type: string
        nodeName:
          type: string
        shelves:
          type: array
          items:
            $ref: '#/components/schemas/Shelf2'
          description: ''
    NodeType:
      title: NodeType
      enum:
      - OADM
      - ILA
      - DGE
      type: string
      description: The type of node this equipment exists on. OADM nodes contain the add/drop banks while ILA and DGE nodes are used for amplification between OADMs.
    NotFound1:
      title: NotFound1
      type: object
      properties:
        statuscode:
          type: string
        message:
          type: string
    Op:
      title: Op
      enum:
      - EQUALS
      - CONTAINS
      - STARTSWITH
      - ENDSWITH
      type: string
    Op1:
      title: Op1
      enum:
      - ADD
      - REPLACE
      - DELETE
      - AUDIT
      type: string
      description: The supported operation on the audit.
    Op2:
      title: Op2
      enum:
      - srlgPatch
      - externalSrlgRemove
      type: string
      description: supported operation on an Equipment resource
    Op3:
      title: Op3
      enum:
      - create
      - enable
      - disable
      - delete
      type: string
      description: supported operation on a Client Port
    Op4:
      title: Op4
      enum:
      - replace
      - delete
      - add
      type: string
      description: supported operation on a Group resource
    Op5:
      title: Op5
      enum:
      - ADD
      - REMOVE
      type: string
    Op6:
      title: Op6
      enum:
      - replace
      - enroll
      - reconnect
      - resync
      - useNewEnrollmentFlow
      - useOldEnrollmentFlow
      - changeToPending
      - inMaintenance
      - outMaintenance
      type: string
      description: supported operation on management session resources
    Op7:
      title: Op7
      enum:
      - replace
      - update
      - delete
      - add
      - srlgPatch
      - externalSrlgRemove
      type: string
      description: Supported operation on a network construct resource
    Op8:
      title: Op8
      enum:
      - set
      - clear
      type: string
      description: The alarm operation
    Op9:
      title: Op9
      enum:
      - srlgPatch
      - externalSrlgRemove
      - replace
      type: string
      description: supported operation on an Tpe resource
    Op10:
      title: Op10
      enum:
      - REPLACE
      type: string
      description: supported operation on an smo service resource
    Op11:
      title: Op11
      enum:
      - replace
      - validateDiscovered
      - delete
      - add
      - srlgPatch
      - externalSrlgRemove
      type: string
      description: supported operation on an fre resource
    Op12:
      title: Op12
      enum:
      - ADD
      - REMOVE
      - REPLACE
      - NONE
      type: string
    Op13:
      title: Op13
      enum:
      - auto_assign
      - clear_auto_assign
      - propagate
      - write_to_network
      - propagate_share_srlg
      - clear_propagated_share_srlg
      - assign_external_srlg
      - release_external_srlg
      - reset_external_srlg
      - audit_fb_profile
      - clear_manual_assign
      type: string
    Op15:
      title: Op15
      enum:
      - replace
      type: string
      description: supported operation on an Auto-assignable Entity Config resource
    Op16:
      title: Op16
      enum:
      - assign
      - release
      - reset
      type: string
      description: Operation to be performed on SRLG Pool
    Op17:
      title: Op17
      enum:
      - replace
      type: string
      description: supported operation on an Propagatable Service Config resource
    Op18:
      title: Op18
      enum:
      - replace
      type: string
      description: supported operation on an SrlgFormat resource
    Operation1:
      title: Operation1
      enum:
      - UPDATE
      - REMOVE
      - ADD
      type: string
      description: The type of operation to apply. This attribute must present if inProvRealizations is not applicable
    operation2:
      title: operation2
      enum:
      - manualSwitchToWork
      - manualSwitchToProtect
      - forcedSwitchToWork
      - forcedSwitchToProtect
      - clear
      - clearProtect
      type: string
    operation4:
      title: operation4
      enum:
      - revert
      - regroom
      - makeCurrentToHome
      - addProtection
      - removeProtection
      - resize
      - updateHomePreemptionLevel
      - updateRestorationPreemptionLevel
      type: string
    OperationalDfElectionMethod:
      title: OperationalDfElectionMethod
      enum:
      - DEFAULT
      - HIGHEST_RANDOM_WEIGHT
      - PREFERENCE
      type: string
      description: The operational DF election method - default, highest-random-weight, or preference-based
    OperationalState:
      title: OperationalState
      enum:
      - up
      - down
      type: string
      description: The operational state of BFD for this endpoint
    OperationalState2:
      title: OperationalState2
      enum:
      - up
      - down
      - link_flapping
      - abnormal
      type: string
      description: The operational (actual) state of the layer termination.
    OperationalState5:
      title: OperationalState5
      enum:
      - UP
      - DOWN
      type: string
      description: state of EVPN Instance
    OperationMode:
      title: OperationMode
      enum:
      - normal
      - simulated
      - displayonly
      type: string
      description: Operation mode of this domain
    OperationState:
      title: OperationState
      enum:
      - FULLY_OPERATING
      - NOT_OPERATING
      - DEGRADED_OPERATION
      - NOT_APPLICABLE
      - UNDETERMINED
      - IN_SERVICE
      - DEGRADED
      - OUT_OF_SERVICE_EXTERNAL
      - OUT_OF_SERVICE
      type: string
      description: Represents the total traffic carrying capability of the FRE. Relates to flow of traffic across the FRE between endpoints.
    OperationState1:
      title: OperationState1
      enum:
      - Up
      - Down
      type: string
      description: Policy operation state
    OperationType:
      title: OperationType
      enum:
      - ENABLE
      - DISABLE
      type: string
    OperQualLevel:
      title: OperQualLevel
      enum:
      - PRC
      - SSU_A
      - SSU_B
      - SEC
      - EEC1
      - DNU
      - PRS
      - STU
      - ST2
      - TNC
      - ST3E
      - EEC2
      - SMC
      - PROV
      - DUS
      - UNKNOWN
      type: string
      description: Timing reference quality level enumeration
    OperState:
      title: OperState
      enum:
      - registered
      - configured
      - deregistered
      - unknown
      type: string
      description: Operational state of the ONU.
    OperState1:
      title: OperState1
      enum:
      - UP
      - QUALITY_LEVEL_BELOW_THRESHOLD
      - QUALITY_LEVEL_INVALID
      - DOWN
      - SIGNAL_FAILURE
      - NO_CONNECTION
      - ANNOUNCE_RX_TIMEOUT
      - ESMC_RX_TIMEOUT
      - RX_TIMEOUT
      - NOT_READY
      - UNKNOWN
      type: string
      description: The operational state of the timing reference
    OpmCurrent:
      title: OpmCurrent
      type: object
      properties:
        parameterNative:
          type: string
        values:
          type: string
    OpStatus:
      title: OpStatus
      enum:
      - success
      - skipped
      - ignored
      - failed
      type: string
    Optimization:
      title: Optimization
      enum:
      - on
      - off
      type: string
      description: A flag indicating if tunnel optimization should be attempted by the control-plane
    OptimizationAlgorithmMetric:
      title: OptimizationAlgorithmMetric
      enum:
      - Shortest_TE_metric
      - Shortest_IGP_metric
      - Lowest_delay
      - Lowest_performance_delay
      - Lowest_number_of_hops
      type: string
      description: Metric for optimization algorithm
    OrchState:
      title: OrchState
      enum:
      - unknown
      - unspecified
      - requested
      - scheduled
      - promoting
      - assembling
      - assembled
      - activating
      - failed
      - active
      - inactive
      - terminating
      - terminated
      type: string
      description: Current state of the resource in the orchestrator
    OsrpCommChannel:
      title: OsrpCommChannel
      enum:
      - GCC0
      - GCC1
      - GCC2
      - GCC12
      type: string
      description: communication carrier.
    osTypeString:
      title: osTypeString
      enum:
      - ccStatus
      - lspOperationalStatus
      - pwOperationalStatus
      - tdmStatus
      type: string
    OTDRentities:
      title: OTDRentities
      type: object
      properties:
        data:
          type: object
    OTDRParseSORtraces:
      title: OTDRParseSORtraces
      type: object
      properties:
        data:
          type: array
          items:
            type: object
          description: ''
        results:
          $ref: '#/components/schemas/Results'
    OTDRSORtraces:
      title: OTDRSORtraces
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data36'
          description: ''
    OTDRSORtraces3:
      title: OTDRSORtraces3
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data38'
    OtsSubtype:
      title: OtsSubtype
      enum:
      - ROADM
      - AMP
      type: string
      description: The OTS subtype of a particular piece of equipment.
    OutputX:
      title: OutputX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    OutputY:
      title: OutputY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    OwningServerTpeListType:
      title: OwningServerTpeListType
      enum:
      - uniDecomposed
      - inverseMux
      - none
      type: string
      description: Owning server tpe list type.
    Parameters:
      title: Parameters
      type: object
      properties:
        trace_entities:
          type: array
          items:
            $ref: '#/components/schemas/TraceEntity'
          description: ''
    Parameters1:
      title: Parameters1
      type: object
      properties:
        trace_id:
          type: string
          default: OTDRCFG-1-1-8
        trace_tag:
          type: string
          default: current
        trace_type:
          type: string
          default: long
        direction:
          type: string
          default: tx
    Parameters2:
      title: Parameters2
      type: object
      properties:
        pulse_short:
          type: string
          default: '1000'
        distance_short:
          type: string
          default: '20000'
        pulse_long:
          type: string
          default: '40000'
        distance_long:
          type: string
          default: '128000'
        pulse_office:
          type: string
          default: '100'
        distance_office:
          type: string
          default: '8000'
        event_range:
          type: string
          default: N/A
        max_aquisition_time:
          type: string
          default: '60'
    Parameters3:
      title: Parameters3
      type: object
      properties:
        description:
          type: string
          default: profile description
        max_aquisition_time:
          type: integer
          format: int32
        pulse_width:
          type: integer
          format: int32
        distance:
          type: integer
          format: int32
    Parent:
      title: Parent
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Relationship'
          description: ''
    PathType:
      title: PathType
      enum:
      - ipsh
      - ipmh
      type: string
      description: Single-hop BFD or Multi-hop BFD
    PathType1:
      title: PathType1
      enum:
      - home
      - target
      type: string
      description: The path type of this FRE/TPE expectation.
    PeerRole:
      title: PeerRole
      enum:
      - client
      - routeReflector
      type: string
      description: Role of the peer
    PeerRole2:
      title: PeerRole2
      enum:
      - WORKING
      - PROTECT
      type: string
    PeerState:
      title: PeerState
      enum:
      - idle
      - connect
      - active
      - opensent
      - openconfirm
      - established
      type: string
      description: BGP states
    PeerType:
      title: PeerType
      enum:
      - internal
      - external
      type: string
      description: internal/external depending on peerAs number is same as local or different.
    PermittedOperation:
      title: PermittedOperation
      enum:
      - writeAtCreationTime
      - readWrite
      - readOnly
      type: string
    physicalNeName.operator:
      title: physicalNeName.operator
      enum:
      - or
      - and
      type: string
    PlannedEndpointRole:
      title: PlannedEndpointRole
      enum:
      - drop
      - source
      type: string
      description: The role that this end point plays for multicast FRE.
    PmType:
      title: PmType
      enum:
      - PREFEC_BER
      - PM_RESET_UNTIMED
      - PM_RESET_BASELINE
      type: string
    PmType2:
      title: PmType2
      enum:
      - CHANNEL_POWER
      - TOTAL_POWER
      - OSC_POWER
      - PREFEC_BER
      - SPECTRUM
      - OPER_MEASMNT
      type: string
    Policiesdata:
      title: Policiesdata
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data33'
          description: ''
    Policy1:
      title: Policy1
      enum:
      - plannedOverDiscovered
      - discoveredOverPlanned
      type: string
    PolicyData:
      title: PolicyData
      type: object
      properties:
        description:
          type: string
        policy_name:
          type: string
        state:
          type: string
        policy_type:
          type: string
        policy_id:
          type: string
        customer_name:
          type: string
    PolicyTypesData:
      title: PolicyTypesData
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data34'
          description: ''
    PollingMode:
      title: PollingMode
      enum:
      - listOnly
      - getOnly
      - noPolling
      type: string
      description: Resource polling mode
    PortDir:
      title: PortDir
      enum:
      - IN
      - OUT
      type: string
    PortDirection:
      title: PortDirection
      enum:
      - east
      - west
      type: string
      description: the direction of the port.
    PortState:
      title: PortState
      enum:
      - disabled
      - forwarding
      - blocked
      - localManualSwitch
      - localForceSwitch
      - unknown
      type: string
      description: the state of the port
    PortState2:
      title: PortState2
      enum:
      - INITIALIZING
      - FAULTY
      - DISABLED
      - LISTENING
      - PRE_MASTER
      - MASTER
      - PASSIVE
      - UNCALIBRATED
      - SLAVE
      - UNKNOWN
      type: string
      description: The port state
    PortStatus:
      title: PortStatus
      enum:
      - ok
      - down
      - CCMFailure
      - localForceSwitch
      - remoteForceSwitch
      - remoteSignalFailure
      - unknown
      type: string
      description: the status of the port
    PowerType:
      title: PowerType
      enum:
      - TOTAL
      - CHANNEL
      - OSC
      - FIBERLOSS
      type: string
      description: Power Type
    PowerType1:
      title: PowerType1
      enum:
      - TOTAL
      - CHANNEL
      - OSC
      - FIBERLOSS
      - SPECTRUM
      type: string
      description: Power Type
    preemptiveSync:
      title: preemptiveSync
      enum:
      - IN
      - OUT
      - ALL
      type: string
    PrefixType:
      title: PrefixType
      enum:
      - INDEX
      - ABSOLUTE
      type: string
      description: Describes how sid value must be interpreted.
    ProcessState1:
      title: ProcessState1
      type: object
      properties:
        totalLogSize:
          type: integer
          format: int64
        totalCommittedSize:
          type: integer
          format: int64
        logRate:
          type: integer
          format: int64
        processRate:
          type: integer
          format: int64
    Profile:
      title: Profile
      enum:
      - TPT_Port_6500
      - TPT_Eqpt_6500
      - OPS_6500
      - CP_SNCP
      - NCP_SNCP
      - APS
      type: string
      description: The Group resource type
    ProfileType:
      title: ProfileType
      enum:
      - DEFAULT
      - CUSTOM
      type: string
    ProfileType1:
      title: ProfileType1
      enum:
      - backup_restore
      - upgrade
      type: string
    ProtectCostPreference:
      title: ProtectCostPreference
      enum:
      - Mandatory
      - BestEffort
      - Disable
      type: string
      description: Available Cost Preferences for home and protect path of SNC
    ProtectionClass:
      title: ProtectionClass
      enum:
      - UNPROTECTED_HIGH
      - UNPROTECTED_LOW
      type: string
      description: service class of protection for the SNC.
    ProtectionRole:
      title: ProtectionRole
      enum:
      - primary
      - backup
      type: string
    ProtectionRole1:
      title: ProtectionRole1
      enum:
      - primary
      - backup
      type: string
      description: Role of the MPLS protection primary or backup
    ProtectionScheme:
      title: ProtectionScheme
      enum:
      - ONE_PLUS_ONE
      - ONE_FOR_ONE
      - LAG
      - TPT
      - OPS
      - CP_SNCP
      - NCP_SNCP
      - NONE
      type: string
      description: protectionScheme
    ProtectionSchemeQualifier:
      title: ProtectionSchemeQualifier
      enum:
      - ptpt
      - eqtpt
      - cp_sncp
      - ncp_sncp
      - aps
      type: string
      description: protectionScheme
    ProtectionType:
      title: ProtectionType
      enum:
      - none
      - link_protect
      - node_protect
      type: string
      description: The FB protection type on this hop for this unidirectional tunnel
    ProtocolOrigin:
      title: ProtocolOrigin
      enum:
      - local
      - bgp
      - pcep
      type: string
      description: Instantiation mechanism used to create the candidate path
    ProtocolType:
      title: ProtocolType
      enum:
      - sftp
      - ftp
      - https
      type: string
    ProtocolType1:
      title: ProtocolType1
      enum:
      - cli
      - tl1
      - netconf
      type: string
    ProtocolVersion2:
      title: ProtocolVersion2
      enum:
      - v1
      - v2
      - built-in
      type: string
      description: Identifies the protocol version supported by the resource provider
    provisionSpectrumData:
      title: provisionSpectrumData
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data50'
    PumpCurrentX:
      title: PumpCurrentX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    PumpCurrentY:
      title: PumpCurrentY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    QualLevel:
      title: QualLevel
      enum:
      - PRC
      - SSU_A
      - SSU_B
      - SEC
      - EEC1
      - DNU
      - PRS
      - STU
      - ST2
      - TNC
      - ST3E
      - EEC2
      - SMC
      - PROV
      - DUS
      - UNKNOWN
      type: string
      description: Timing reference quality level enumeration
    Range1:
      title: Range1
      required:
      - type
      type: object
      properties:
        endTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/requestTypeEnum'
        unit:
          $ref: '#/components/schemas/timeUnitEnum'
        value:
          maximum: 2147483646
          minimum: 1
          type: integer
          format: int32
      description: Defines the time range to be queried. Supports 'absolute' with RFC3339 compatible start and end date or 'relative' with a 'unit' (SECONDS, MINUTES, etc) and 'value'.
    Range2:
      title: Range2
      required:
      - type
      type: object
      properties:
        endTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/requestTypeEnum'
        unit:
          $ref: '#/components/schemas/timeUnitEnum'
        value:
          maximum: 2147483646
          minimum: 1
          type: integer
          format: int32
      description: Defines the time range to be queried. Supports 'absolute' with RFC3339 compatible start and end date or 'relative' with a 'unit' (SECONDS, MINUTES, etc) and 'value'
    RawHexX:
      title: RawHexX
      type: object
      properties:
        value:
          type: string
    RawHexY:
      title: RawHexY
      type: object
      properties:
        value:
          type: string
    RawPumpCurrentX:
      title: RawPumpCurrentX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    RawPumpCurrentY:
      title: RawPumpCurrentY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    RawRllX:
      title: RawRllX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    RawRllY:
      title: RawRllY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    RawSllX:
      title: RawSllX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    RawSllY:
      title: RawSllY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    RecoverCharacteristicsOnHome:
      title: RecoverCharacteristicsOnHome
      enum:
      - ACTIVE
      - NOT_ACTIVE
      type: string
      description: Flag indicating if currently on the home path
    RecoveryPriority:
      title: RecoveryPriority
      enum:
      - high
      - low
      type: string
      description: Indicates the priority level
    RegenerationRestrictionType:
      title: RegenerationRestrictionType
      enum:
      - DO_NOT_PROPOSE
      type: string
      description: Regeneration Restriction type
    Relationship1:
      title: Relationship1
      enum:
      - networkConstructs
      - tpes
      - fres
      type: string
      description: The association relationship resource type
    Relationships1:
      title: Relationships1
      type: object
      properties:
        networkConstruct:
          $ref: '#/components/schemas/NetworkConstruct'
    Relationships2:
      title: Relationships2
      type: object
      properties:
        children:
          $ref: '#/components/schemas/Children'
        parent:
          $ref: '#/components/schemas/Parent'
      description: Relationship object in describing inventory relationship
    RelationshipType:
      title: RelationshipType
      enum:
      - concrete
      - owningServer
      - physical
      type: string
      description: The type of association. Each value indicates what type of relationship this association is representing.
    RelationType:
      title: RelationType
      enum:
      - ONE_TO_ONE
      - ONE_TO_MANY
      type: string
      description: Relation type
    Reliability:
      title: Reliability
      enum:
      - MANUAL
      - AUTO
      type: string
      description: Stitcher attribute to set reliability on FRE
    RemoteMepAging:
      title: RemoteMepAging
      enum:
      - on
      - off
      type: string
      description: Cfm remote mep aging (on/off)
    RepeaterAddress:
      title: RepeaterAddress
      type: object
      properties:
        value:
          type: string
    RepeaterAttributes:
      title: RepeaterAttributes
      type: object
      properties:
        cable_system_name:
          type: string
        file_name:
          type: string
    RepeaterSystem:
      title: RepeaterSystem
      type: object
      properties:
        value:
          type: string
    RequestFailed161:
      title: RequestFailed161
      type: object
      properties:
        status:
          type: string
          default: FAILED
        errors:
          type: array
          items:
            type: string
          description: ''
    ReservationState:
      title: ReservationState
      enum:
      - UNKNOWN
      - NOT_RESERVED
      - RESERVED_FOR_MAINTENANCE
      - RESERVED_FOR_FACILITY
      - RESERVED_FOR_REVERSION
      type: string
      description: The reservation state of the equipment
    ReservedIPAddressofShelvesorcrafts:
      title: ReservedIPAddressofShelvesorcrafts
      type: object
      properties:
        reservedIPdata:
          type: array
          items:
            $ref: '#/components/schemas/ReservedIPdatum'
          description: ''
    reservedIP:
      title: reservedIP
      type: object
      properties:
        ospfArea:
          type: string
        ospfAreaV3:
          type: string
        projectId:
          type: string
        projectName:
          type: string
        IP:
          type: string
        IP6:
          type: string
        shelfNumber:
          type: string
        tid:
          type: string
        type:
          type: string
    ReservedIPdatum:
      title: ReservedIPdatum
      type: object
      properties:
        type:
          type: string
        projectId:
          type: string
        ospfArea:
          type: string
        shelfNumber:
          type: string
        tid:
          type: string
        projectName:
          type: string
        IP:
          type: string
    ResilienceLevel:
      title: ResilienceLevel
      enum:
      - UNPROTECTED
      - PARTIAL
      - PROTECTED
      - PROTECTED_IN_JEOPARDY
      type: string
      description: Indicates the general level of resiliency under this given FRE.
    ResiliencyType:
      title: ResiliencyType
      enum:
      - TPT
      - OPS
      type: string
      description: resiliencyType
    ResourceState:
      title: ResourceState
      enum:
      - root
      - planned
      - discovered
      - plannedAndDiscovered
      - unknown
      type: string
      description: Nsi Resource State.
    ResourceType:
      title: ResourceType
      enum:
      - NETWORK_CONSTRUCTS
      - FRES
      - EQUIPMENT
      - EQUIPMENTS
      - TPES
      type: string
    ResourceType2:
      title: ResourceType2
      enum:
      - FRE
      - TPE
      - NODE
      - EQUIPMENT
      type: string
      description: Type of the resource.
    ResourceType4:
      title: ResourceType4
      enum:
      - NETWORK_CONSTRUCTS
      - TPES
      - FRES
      - EQUIPMENTS
      type: string
    ResourceType6:
      title: ResourceType6
      enum:
      - networkConstructs
      - tpes
      - fres
      - equipment
      - equipments
      type: string
      description: Resource Type
    resourceType7:
      title: resourceType7
      enum:
      - fres
      type: string
    ResourceTypes:
      title: ResourceTypes
      enum:
      - networkConstructs
      type: string
      description: The type of the resources.
    RestrictionScope:
      title: RestrictionScope
      enum:
      - SERVICE_CREATE
      - SERVICE_CREATE_BULK
      - TEMP_SERVICE_CREATE
      - TEMP_SERVICE_CREATE_BULK
      - SERVICE_FEASIBILITY_CHECK
      - SERVICE_FEASIBILITY_CHECK_BULK
      - SERVICE_ROLL
      - SERVICE_RECONFIGURE
      - SERVICE_RESTORATION
      - SERVICE_REROUTE
      - NETWORK_RE_OPTIMIZATION
      - ALL
      type: string
    RestrictionType:
      title: RestrictionType
      enum:
      - ADD_DROP
      - PASS_THROUGH
      - BOTH
      type: string
      description: Restriction type
    Results:
      title: Results
      type: object
      properties:
        success:
          type: array
          items:
            type: string
          description: ''
        failure:
          type: array
          items:
            type: string
          description: ''
    ResultTime:
      title: ResultTime
      type: object
      properties:
        value:
          type: string
    ReversionMode:
      title: ReversionMode
      enum:
      - REVERTIVE
      - NON_REVERTIVE
      - UNKNOWN
      type: string
      description: The reversion mode
    ReversionState:
      title: ReversionState
      enum:
      - enable
      - disable
      type: string
      description: Specifies reversion state as enable or disable
    RingState:
      title: RingState
      enum:
      - initializing
      - ok
      - adminDisabled
      - operationalDisabled
      - protecting
      - recovering
      - manualSwitch
      - forceSwitch
      - unknown
      type: string
      description: the state of the ring
    RingStatus:
      title: RingStatus
      enum:
      - ok
      - localSignalFailure
      - localForceSwitch
      - remoteOtherPortSignalFailure
      - remoteOtherPortForceSwitch
      - provisioningMismatch
      - notReceivingPDUS
      - noRPLOwnerDetected
      - unknown
      type: string
      description: the status of the ring
    RingType:
      title: RingType
      enum:
      - majorRing
      - subRing
      type: string
      description: the type of ring
    RiskType:
      title: RiskType
      enum:
      - ADD_DROP_BANK
      - LINE_MODULE
      - PHOTONIC_NODE
      - CONDUIT
      - FIBER_MANAGEMENT
      - SITE
      - POWER_SUPPLY
      - CUSTOM
      - ROADM_DEGREE
      - OTU_LINK
      - PACKET_LINK
      - OTN_NODE
      - PACKET_NODE
      - MULTI_SERVICE_NODE
      - SHELF
      - OTN_SUB_SYSTEM
      - PACKET_SUB_SYSTEM
      type: string
    Role1:
      title: Role1
      enum:
      - passive
      - active
      - any
      type: string
      description: The role of BFD for this endpoint
    Role3:
      title: Role3
      enum:
      - client
      - routeReflector
      type: string
      description: self role
    Role4:
      title: Role4
      enum:
      - ingress
      - transit
      type: string
      description: The role at this point of the MPLS tunnel protected by this FB tunnel
    Role5:
      title: Role5
      enum:
      - A
      - Z
      type: string
      description: The role of the endpoint
    Role10:
      title: Role10
      enum:
      - DF
      - NDF
      type: string
      description: Designated Forwarder or not
    Role12:
      title: Role12
      enum:
      - Working
      - Protecting
      type: string
      description: the role of the fre
    Role13:
      title: Role13
      enum:
      - Protected
      - Working
      - Protecting
      type: string
      description: the role of the tpe
    RouteCharacteristic:
      title: RouteCharacteristic
      enum:
      - coRouted
      - maximumDiversity
      type: string
      description: If multiple routes need to be defined, what's the relationship between the routes.
    RouteExclusivity:
      title: RouteExclusivity
      enum:
      - Working
      - WorkingProtect
      - Preferred
      - No
      - Yes
      - Disable
      type: string
      description: Specifies type of route exclusivity
    RouteObjectType:
      title: RouteObjectType
      enum:
      - TERMINATION_POINT_NAME
      - ROADM_LINE_NAME
      - NODE_NAME
      - SITE_NAME
      - CONTROL_PLANE
      - FREQUENCY
      - SNCG
      - SNC
      - SNCG_STATE
      type: string
      description: The attribute defining the route type.
    Rule:
      title: Rule
      enum:
      - mustConnectInternally
      - clientExternalFGRule
      - connectsExternally
      - toServerUsingClientExternalFGRule
      - externalFGRule
      - externalFGRuleViaImmediateClientPotential
      - toDualPortPeerUsingClientExternalFGRule
      - transitionalAtCreationTime
      type: string
      description: toServerUsingClientExternalFGRule matchers server's clientExternalFGRule
    Sat:
      title: Sat
      enum:
      - ON
      - OFF
      type: string
    ScanDatum:
      title: ScanDatum
      type: object
      properties:
        result_time:
          $ref: '#/components/schemas/ResultTime'
        familyType:
          $ref: '#/components/schemas/FamilyType'
        span_loss_x:
          $ref: '#/components/schemas/SpanLossX'
        span_loss_y:
          $ref: '#/components/schemas/SpanLossY'
        status:
          $ref: '#/components/schemas/Status5'
        iff_y:
          $ref: '#/components/schemas/IffY'
        iff_x:
          $ref: '#/components/schemas/IffX'
        raw_hex_x:
          $ref: '#/components/schemas/RawHexX'
        raw_hex_y:
          $ref: '#/components/schemas/RawHexY'
        scan_id:
          $ref: '#/components/schemas/ScanId'
        pump_current_x:
          $ref: '#/components/schemas/PumpCurrentX'
        label:
          $ref: '#/components/schemas/Label'
        raw_pump_current_x:
          $ref: '#/components/schemas/RawPumpCurrentX'
        raw_pump_current_y:
          $ref: '#/components/schemas/RawPumpCurrentY'
        direction:
          $ref: '#/components/schemas/Direction17'
        pump_current_y:
          $ref: '#/components/schemas/PumpCurrentY'
        output_x:
          $ref: '#/components/schemas/OutputX'
        output_y:
          $ref: '#/components/schemas/OutputY'
        raw_sll_x:
          $ref: '#/components/schemas/RawSllX'
        raw_sll_y:
          $ref: '#/components/schemas/RawSllY'
        RepeaterSystem:
          $ref: '#/components/schemas/RepeaterSystem'
        input_y:
          $ref: '#/components/schemas/InputY'
        raw_rll_y:
          $ref: '#/components/schemas/RawRllY'
        raw_rll_x:
          $ref: '#/components/schemas/RawRllX'
        input_x:
          $ref: '#/components/schemas/InputX'
        repeater_address:
          $ref: '#/components/schemas/RepeaterAddress'
    ScanDetailsData:
      title: ScanDetailsData
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data40'
    ScanHistoryData:
      title: ScanHistoryData
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data41'
          description: ''
    ScanId:
      title: ScanId
      type: object
      properties:
        value:
          type: string
    ScheduleScandata:
      title: ScheduleScandata
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data42'
          description: ''
    ScheduleDetails1:
      title: ScheduleDetails1
      type: object
      properties:
        scheduleTime:
          type: string
          default: 2030-09-30T06:46:43+05:30
        scheduleFrequency:
          type: string
          default: ONCE
        dayofMonth:
          type: string
          default: '20'
        scheduleWeeklyDays:
          $ref: '#/components/schemas/ScheduleWeeklyDays1'
    ScheduleDetails2:
      title: ScheduleDetails2
      type: object
      properties:
        dayofMonth:
          type: string
        nextExecutionTime:
          type: string
        scheduleFrequency:
          type: string
        scheduleTime:
          type: string
        scheduleWeeklyDays:
          $ref: '#/components/schemas/ScheduleWeeklyDays1'
    ScheduleFrequency:
      title: ScheduleFrequency
      enum:
      - ONCE
      - DAILY
      - WEEKLY
      - MONTHLY
      type: string
    SchedulerAlgorithm:
      title: SchedulerAlgorithm
      enum:
      - strict
      - weighted_fair_queuing
      - round_robin
      - weighted_round_robin
      - weighted_deficit_round_robin
      - sp
      - rr
      - wrr
      - wfq
      type: string
    ScheduleWeeklyDays1:
      title: ScheduleWeeklyDays1
      type: object
      properties:
        mon:
          type: string
          default: OFF
        tue:
          type: string
          default: OFF
        wed:
          type: string
          default: OFF
        thu:
          type: string
          default: OFF
        fri:
          type: string
          default: OFF
        sat:
          type: string
          default: OFF
        sun:
          type: string
          default: OFF
    Scope:
      title: Scope
      enum:
      - SCOPE
      - GLOBAL
      type: string
      description: Scope of label range.
    Scope1:
      title: Scope1
      enum:
      - APPLICATION
      - TENANT
      - COMMON
      type: string
      description: Scope of the sub-domain
    ScopeType:
      title: ScopeType
      enum:
      - network
      - subNetwork
      type: string
    Script1:
      title: Script1
      type: object
      properties:
        release:
          type: string
        sequenceId:
          type: string
        deviceType:
          type: string
        scriptId:
          type: string
        commands:
          type: array
          items:
            $ref: '#/components/schemas/Command'
          description: ''
    ScriptLink:
      title: ScriptLink
      required:
      - link
      - format
      type: object
      properties:
        link:
          type: string
          description: A URL to get the commissioning scripts for a device type.
        format:
          type: string
          description: Format of the commissioning scripts data, for example - json, cli, ztpScripts
    ScriptLink1:
      title: ScriptLink1
      required:
      - link
      - format
      type: object
      properties:
        link:
          type: string
          description: The URL to get the commissioning script for a node name.
        format:
          type: string
          description: Format of the commissioning scripts data, for example - json, cli, ztpScripts
    Scriptssummarydata1:
      title: Scriptssummarydata1
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/scriptsSummaryData'
          description: ''
    searchType:
      title: searchType
      enum:
      - wildCard
      - match
      - matchCase
      type: string
    SegmentationRule:
      title: SegmentationRule
      enum:
      - oneSegementInGroup
      type: string
      description: Whether the segment can be fragmented.
    SegmentBoundaryRule:
      title: SegmentBoundaryRule
      enum:
      - mustNotOverlap
      type: string
      description: The default is mustNotOverlap.
    SegmentType:
      title: SegmentType
      enum:
      - A
      - C
      - F
      type: string
      description: Types of segments
    SelectionReason:
      title: SelectionReason
      enum:
      - normal
      - manual
      - protection
      type: string
    Server:
      title: Server
      required:
      - id
      - type
      type: object
      properties:
        id:
          type: string
          description: The node ID, is a ManagementSessionId from a 6500, used in alarm to service correlation
        type:
          type: string
          description: The node type. E.g. 6500
      description: Information about the alarming node
    ServiceAffecting:
      title: ServiceAffecting
      enum:
      - UNKNOWN
      - SERVICE_AFFECTING
      - NON_SERVICE_AFFECTING
      type: string
      description: The service impact of the alarm
    ServiceAffecting3:
      title: ServiceAffecting3
      enum:
      - SERVICE_AFFECTING
      - NON_SERVICE_AFFECTING
      - UNKNOWN
      type: string
    ServiceClass:
      title: ServiceClass
      enum:
      - EVC
      - E_TRANSIT
      - E_ACCESS
      - VLAN
      - TDM
      - PSEUDOWIRE_LINK
      - TRANSPORT_CLIENT
      - PHOTONIC
      - TUNNEL
      - IP
      - LLDP
      - LAG
      - OTU
      - OSRP_LINK
      - OSRP_LINE
      - ROADM_LINE
      - OMS
      - FIBER
      - SNC
      - SNCP
      - ICL
      - RING
      - BGP_SESSION
      - EMBEDDED_ETHERNET_LINK
      - L_3_VPN
      - OT_SI
      - MEDIA
      - FLEXE_GROUP
      - FLEXE_LINK
      - FLEX_E
      - PATH
      - EVPN_VPWS
      type: string
      description: Represents the type of FRE service
    ServiceClass3:
      title: ServiceClass3
      enum:
      - IP
      - OTU
      - LAG
      type: string
      description: Define type of service class
    ServiceClass4:
      title: ServiceClass4
      enum:
      - IP
      - OTU
      - LAG
      type: string
    serviceClass5:
      title: serviceClass5
      enum:
      - EVC
      - ETransit
      - EAccess
      - VLAN
      - TDM
      - Transport Client
      - Photonic
      - Tunnel
      - IP
      - LLDP
      - LAG
      - OTU
      - ROADM Line
      - Fiber
      - SNC
      - OSRP Link
      - OSRP Line
      - SNCP
      - L3VPN
      type: string
    ServiceClassQualifier:
      title: ServiceClassQualifier
      enum:
      - VISIBLE
      - HIDDEN
      type: string
      description: Represents the visibility of FRE service
    ServiceIntentOperation:
      title: ServiceIntentOperation
      enum:
      - CREATE
      - DELETE
      - DEPLOY
      - UNDEPLOY
      type: string
      description: The type of operation being peformed on service intent
    ServiceTypeConstraint:
      title: ServiceTypeConstraint
      enum:
      - SWITCHED
      - NON_SWITCHED
      type: string
      description: For L1 service specifies whether the service should be switched or non-switched service
    SessionState:
      title: SessionState
      enum:
      - IDLE
      - CONNECT
      - ACTIVE
      - OPENSENT
      - OPENCONFIRM
      - ESTABLISHED
      type: string
      description: BGP states
    SessionType:
      title: SessionType
      enum:
      - IBGP
      - EBGP
      type: string
      description: IBGP/EBGP depending on peerAs number is same as local or different.
    SessionType1:
      title: SessionType1
      enum:
      - gatewayNE
      - remoteNE
      - subtendedDevice
      type: string
      description: type of management session type
    Severity:
      title: Severity
      enum:
      - CRITICAL
      - MAJOR
      - MINOR
      type: string
      description: The state
    Severity1:
      title: Severity1
      enum:
      - CRITICAL
      - MAJOR
      - MINOR
      - WARNING
      - INDETERMINATE
      - INFO
      - CONFIG
      - DEBUG
      type: string
    Severity2:
      title: Severity2
      enum:
      - CRITICAL
      - MAJOR
      - MINOR
      - WARNING
      - INDETERMINATE
      - INFO
      - CONFIG
      - DEBUG
      type: string
      description: The severity of alarm to raise for threshold crossing
    Shelf:
      title: Shelf
      required:
      - release
      - shelfId
      - primary
      type: object
      properties:
        release:
          type: string
          description: Release of the node.
        shelfId:
          type: string
          description: Shelf id or Shelf number
        primary:
          type: string
          description: Inform if primary is enabled or not.
    Shelf1:
      title: Shelf1
      type: object
      properties:
        ncExpID:
          type: string
          description: Network construct expectation ID of the shelf in the NSI.
        fic:
          type: string
          description: Frame identification code of the shelf.
        ospfarea:
          type: string
          description: OSPF area of the shelf.
        siteId:
          type: string
          description: site id of the shelf.
        ncID:
          type: string
          description: Network construct id of the shelf in NSI.
        shelfNumber:
          type: string
          description: Shelf number.
        shelfIPAddress:
          type: string
          description: IP address of the shelf.
        colanA:
          $ref: '#/components/schemas/ColanA2'
        colanX:
          $ref: '#/components/schemas/ColanX2'
        6500_in:
          type: array
          items: {}
          description: 6500 IN properties of the shelf.
        6500_out:
          type: array
          items: {}
          description: 6500 OUT properties of the shelf.
    Shelf2:
      title: Shelf2
      type: object
      properties:
        shelfId:
          type: string
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/Script1'
          description: ''
    ShelfType:
      title: ShelfType
      enum:
      - ILA
      - DGE
      type: string
      description: Shelf type of the network construct.
    SignalConditioning:
      title: SignalConditioning
      enum:
      - LASERSHUTOFF
      - NONE
      - NA
      type: string
    SignalingType:
      title: SignalingType
      enum:
      - ISIS_SR
      - OSPF_SR
      type: string
      description: Signaling type of SR policy
    SignalingType1:
      title: SignalingType1
      enum:
      - PM
      - TCMLEVEL1
      - TCMLEVEL2
      - TCMLEVEL3
      - TCMLEVEL4
      - TCMLEVEL5
      - TCMLEVEL6
      type: string
      description: Signaling type for the automatic protection switching.
    SignalPattern:
      title: SignalPattern
      enum:
      - adjacent
      type: string
      description: If photonic route type, specifies the frequency or wavelength pattern to choose for the routes.
    SlmState:
      title: SlmState
      enum:
      - ENABLED
      - DISABLED
      - PARTIAL
      type: string
      description: SLM Measurement State (enabled/disabled/partial)
    SlteAttributes:
      title: SlteAttributes
      type: object
      properties:
        cable_system_name:
          type: string
        customer_name:
          type: string
    SMD:
      title: SMD
      type: object
      properties:
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '2'
    SMD1:
      title: SMD1
      type: object
      properties:
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '2'
        port:
          type: string
          default: '10'
    SMD2:
      title: SMD2
      type: object
      properties:
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '2'
        rxChcIndex:
          type: string
          default: '7'
        txChcIndex:
          type: string
          default: '6'
        switchSelector:
          type: string
          default: '16'
    SMD3:
      title: SMD3
      type: object
      properties:
        chcAid:
          type: array
          items:
            type: string
          description: ''
    SMD4:
      title: SMD4
      type: object
      properties:
        aid:
          type: string
          default: CHC-1-2-9-1
        targetMaxFrequency:
          type: string
          default: '193.625000'
        targetMinFrequency:
          type: string
          default: '193.675000'
        minFrequencyDeadBand:
          type: string
          default: '0.000'
        maxFrequencyDeadBand:
          type: string
          default: '0.000'
        maxFrequency:
          type: string
          default: '193.625000'
        minFrequency:
          type: string
          default: '193.675000'
        tidName:
          type: string
          default: SSTSite3
        minFrequencyLimit:
          type: string
          default: '191.325000'
        maxFrequencyLimit:
          type: string
          default: '196.125000'
        switchSelector:
          type: string
          default: '12'
        targetSwitchSelector:
          type: string
          default: '11'
        opaque:
          type: string
          default: YES
        chcMode:
          type: string
          default: OPENLOOPLOSS
        primaryState:
          type: string
          default: IS
        wavelength:
          type: string
          default: '1532.00'
        channelWidth:
          type: string
          default: '50.00'
    SmdSwitchSelector:
      title: SmdSwitchSelector
      type: object
      properties:
        currentSwSelectorRx:
          type: string
          default: '11'
        currentSwSelectorTx:
          type: string
          default: '11'
        chcAid:
          type: array
          items:
            type: string
          description: ''
    SmdToLim:
      title: SmdToLim
      type: object
      properties:
        SMD:
          $ref: '#/components/schemas/SMD'
        LIM:
          $ref: '#/components/schemas/LIM'
    SmdToLim1:
      title: SmdToLim1
      type: object
      properties:
        localTag:
          type: string
          default: SMD-1-2-16
        remoteTag:
          type: string
          default: LIM-1-5-6
    SmdToLim2:
      title: SmdToLim2
      type: object
      properties:
        port:
          type: string
          default: '12'
    SmdToWss:
      title: SmdToWss
      type: object
      properties:
        SMD:
          $ref: '#/components/schemas/SMD1'
        WSSOPM:
          $ref: '#/components/schemas/WSSOPM'
    SmdTowss1:
      title: SmdTowss1
      type: object
      properties:
        localTag:
          type: string
          default: SMD-1-2-10
        remoteTag:
          type: string
          default: WSSOPM-1-10-3
    SncgState:
      title: SncgState
      enum:
      - IS
      - OOS
      type: string
      description: Attribute defining the SNCG State.
    SncRole:
      title: SncRole
      enum:
      - WORKING
      - PROTECT
      type: string
      description: Role of SNC i.e WORKING or PROTECT
    SncType:
      title: SncType
      enum:
      - DYNAMIC
      - PERMANENT
      type: string
    SnrStatus:
      title: SnrStatus
      enum:
      - good
      - bad
      - neutral
      type: string
    SoftPreemption:
      title: SoftPreemption
      enum:
      - enable
      - disable
      type: string
      description: If true, soft preemption is enabled. Applicable to dynamic TE unidirectional tunnels only.
    SORdownloadprofiles:
      title: SORdownloadprofiles
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data35'
          description: ''
    SpanLossX:
      title: SpanLossX
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    SpanLossY:
      title: SpanLossY
      type: object
      properties:
        value:
          type: string
        alarmSeverity:
          type: string
    SpectralAssignOption:
      title: SpectralAssignOption
      enum:
      - SPECTRUM_SPREAD
      - PACK_LOW
      - PACK_HIGH
      type: string
    SpectrumSharingTerminalData:
      title: SpectrumSharingTerminalData
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data48'
    SpectrumSharingTerminalDetails:
      title: SpectrumSharingTerminalDetails
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data49'
    SrlgJobStatus:
      title: SrlgJobStatus
      enum:
      - requested
      - in_progress
      - completed
      - failed
      type: string
    SrlgJobType:
      title: SrlgJobType
      enum:
      - clear_auto_assign
      - clear_propagated_share_srlg
      - auto_assign
      - propagate_share_srlg
      - propagate
      - write_to_network
      - audit_fb_profile
      - clear_manual_assign
      - manual_assign
      - assign_external_srlg
      - release_external_srlg
      - reset_external_srlg
      type: string
    SrlgMode:
      title: SrlgMode
      enum:
      - maximal
      - strict
      - ignore
      type: string
      description: Represents if srlg needs to be considered in path computation by CP
    SSTAdjacencyPackage:
      title: SSTAdjacencyPackage
      type: object
      properties:
        smdTowss:
          $ref: '#/components/schemas/SmdTowss1'
        wssToLim:
          $ref: '#/components/schemas/WssToLim'
    StackDirection:
      title: StackDirection
      enum:
      - client_to_server
      - server_to_client
      - bidirectional
      - horizontal_unidirectional
      - unknown
      type: string
    State:
      title: State
      enum:
      - ACTIVE
      - CLEARED
      - SUPERSEDED
      type: string
      description: The alarm state
    State1:
      title: State1
      enum:
      - UNKNOWN
      - NOT_FIXED
      - FIX_REQUESTED
      - FIXING
      - FIXED
      - FIX_CANCEL_REQUESTED
      - FIX_CANCELLED
      - PARTIALLY_FAILED
      - FAILED
      - FIX_REQUESTED_FAILED
      - FIX_CANCEL_REQUESTED_FAILED
      - PARTIALLY_FIXED
      - REQUIRE_MANUAL_FIX
      type: string
      description: The fix state
    State2:
      title: State2
      enum:
      - CREATED
      - STARTED
      - AUDITING
      - COMPLETED
      - FAILED
      - CANCEL_REQUESTED
      - CANCEL_REQUEST_FAILED
      - CANCELLED
      - PARTIALLY_COMPLETED
      - PARTIALLY_FAILED
      - STALE
      type: string
      description: The state
    State3:
      title: State3
      enum:
      - IS
      - OOS
      - OOS_AU
      - OOS_MA
      - OOS_AUMA
      type: string
      description: The primary state of the equipment
    State4:
      title: State4
      enum:
      - EMPTY
      - INSTALLED_AND_EXPECTED
      - EXPECTED_AND_NOT_INSTALLED
      - INSTALLED_AND_NOT_EXPECTED
      - MISMATCH_OF_INSTALLED_AND_EXPECTED
      - UNAVAILABLE
      type: string
    State5:
      title: State5
      enum:
      - PENDING
      - FAILED
      - CALCULATING_DTLS
      - FOUND_DTLS
      - NO_DTLS_FOUND
      - UNSUPPORTED
      - PROVISIONING_DTLSET
      - DTLSET_PROVISIONED
      - PROVISIONING_DTLSET_FAILED
      - UPDATING_SNCG
      - UPDATE_SNCG_FAILED
      - SNC_REFRESH_COMPLETED
      type: string
      description: Enumeration of the various FRE refresh life cycle states
    State6:
      title: State6
      enum:
      - IS
      - OOS
      - OOS_AUMA
      type: string
      description: TO BE REMOVED. Use adminState.
    State7:
      title: State7
      enum:
      - NOT_SYNCHRONIZED
      - SYNCHRONIZING
      - SYNCHRONIZED
      - FAILED
      - ABORTED
      - DELETING
      - DELETE_FAILED
      - TIMEOUT
      type: string
    State9:
      title: State9
      enum:
      - IS
      - OOS
      - OOS_AUMA
      type: string
      description: State of the TPE.
    State10:
      title: State10
      enum:
      - Primary
      - Backup
      type: string
    State11:
      title: State11
      enum:
      - unclaimed
      - executing
      - successful
      - failed
      - cancelled
      - suspended
      type: string
      description: Job state
    State13:
      title: State13
      enum:
      - passed
      - failed
      type: string
      description: Status of the validation report
    State14:
      title: State14
      enum:
      - requested
      - pending
      - scheduled
      - executing
      - successful
      - failed
      - cancelled
      type: string
      description: Current state of the operation
    State15:
      title: State15
      enum:
      - IDLE
      - INPROGRESS
      - SCHEDULED
      - ABORTED
      - COMPLETED
      type: string
    State17:
      title: State17
      enum:
      - USED
      - RESERVED
      type: string
    State18:
      title: State18
      enum:
      - uploadPending
      - uploading
      - queued
      - collecting
      - generating
      - completed
      - deleting
      - failed
      type: string
    State19:
      title: State19
      enum:
      - PENDING
      - RECALCULATE_PATH
      - PENDING_PATH_CALCULATION
      - CALCULATING_PATH
      - FOUND_PATH
      - NO_PATH_FOUND
      - UNSUPPORTED
      - REVERT
      - REVERTING
      - REVERTED
      - REVERT_FAILED
      - RESTORE
      - RESTORING
      - RESTORED
      - RESTORE_FAILED
      - DELETING
      type: string
      description: Enumeration of the various SMO Service move life cycle states
    State20:
      title: State20
      enum:
      - WAITING_FOR_ACTIVATED_SERVICE
      - WAITING_FOR_SERVICE_TRAFFIC
      - IN_PROGRESS
      - ERROR
      - PASS
      - FAIL
      - MARGINAL
      type: string
      description: State of the Diagnostic Test
    State23:
      title: State23
      enum:
      - IS
      - OOS
      - OOS_AUMA
      type: string
    state26:
      title: state26
      enum:
      - executing
      - suspended
      type: string
    Status:
      title: Status
      enum:
      - pending
      - failed
      - successful
      type: string
      description: The status of this upgrade request
    Status1:
      title: Status1
      enum:
      - low
      - good
      - upgrade
      - high
      type: string
    Status2:
      title: Status2
      enum:
      - Online
      - Offline
      type: string
    Status3:
      title: Status3
      enum:
      - IN_PROGRESS
      - COMPLETED
      - FAILED
      - DELETING
      - FAILED_TO_DELETE
      type: string
    Status4:
      title: Status4
      enum:
      - inProgress
      - completed
      - error
      type: string
    Status5:
      title: Status5
      type: object
      properties:
        value:
          type: string
    StickyLsp:
      title: StickyLsp
      enum:
      - on
      - off
      type: string
      description: A flag indicating a dynamic tunnel stays on the same path after change in required resources. Applicable to dynamic coRouted tunnels only.
    StitchingConstraint:
      title: StitchingConstraint
      enum:
      - otnRegen
      type: string
      description: stitchingConstraint values
    StorageMethod:
      title: StorageMethod
      enum:
      - filesystem
      - database
      type: string
    StrategyType:
      title: StrategyType
      enum:
      - async
      - sync
      type: string
      description: Discovery strategy type
    StructureSubType:
      title: StructureSubType
      enum:
      - osrpLink
      - osrpLine
      - regen
      type: string
    StructureType:
      title: StructureType
      enum:
      - dual_port
      - dual_port_client_mapping
      - exposed_lone_cp
      - lone_adapter
      - full_layer_optional_exposed_cp
      - full_layer_optional_exposed_cp_and_tcp
      - full_layer_fixed
      - exposed_tcp
      - concatenating_adapter
      - concatenatable_exposed_tcp
      - layer_termination_structure_type_unknown
      - concatenatable_fixed
      - exposed_TCP_and_CP
      type: string
      description: Identifies the internal structure of the layer termination.
    StructureType2:
      title: StructureType2
      enum:
      - PTP
      - FTP
      - CTP_SERVER_TO_CLIENT
      - CTP_CLIENT_TO_SERVER
      - CTP_CLIENT_TO_CLIENT
      - CTP_SERVER_TO_DOMAIN
      type: string
    SubOp:
      title: SubOp
      enum:
      - ADD_PROTECTION
      - REMOVE_PROTECTION
      type: string
    SubType:
      title: SubType
      enum:
      - TP
      - TE
      type: string
      description: TP refers to Transport Profile; TE refers to Traffic Engineering
    Success:
      title: Success
      type: object
      properties:
        lastCollection:
          type: string
        previousCollection:
          type: string
    Sun:
      title: Sun
      enum:
      - ON
      - OFF
      type: string
    supportedByQualifier:
      title: supportedByQualifier
      enum:
      - one
      - all
      type: string
    Suppress:
      title: Suppress
      enum:
      - ZERO
      - NONE
      - ZERO_VALID
      type: string
      description: Monitoring Level
    SwitchFabricType:
      title: SwitchFabricType
      enum:
      - XC
      - CTM
      - EMOTR
      - PTS
      - EMOTR_STANDARD
      - EMOTR_EXTENDED
      - L_2_MOTR_STANDARD
      - L_2_MOTR_EXTENDED
      - L_2_MOTR_STANDARD_EXT_OM
      type: string
      description: Optional field.  It represents a switch fabric where XC (PTKOTN on S-series), CTM (PTKOTN on T-series)
    SwitchingProtocol:
      title: SwitchingProtocol
      enum:
      - SNC_I
      - SNC_N
      - SNC_S
      type: string
      description: Indicates whether the switching criteria applied to the protection group is SNC-I (Subnetwork Connection protection with Inherent monitoring), SNC-N (Subnetwork Connection protection with Non-intrusive monitoring), SNC-S (Subnetwork Connection protection with Sublayer monitoring).
    SwitchRule:
      title: SwitchRule
      enum:
      - nodalClientTPT
      type: string
      description: switch (eg TPT) vs configuration (eg SNC)
    SyncComponent:
      title: SyncComponent
      enum:
      - ALL_COMPONENT
      - INVENTORY
      - ALARM
      type: string
      description: type of component to be synced. Only to be used when op=resync
    SyncFailedReason:
      title: SyncFailedReason
      enum:
      - RA
      - TRIGGER
      - SYNC
      - ALARM
      type: string
    SyncState:
      title: SyncState
      enum:
      - DELETED
      - SYNC_TRIGGERED
      - SYNCHRONIZING
      - SYNCHRONIZED
      - SYNC_FAILED
      - SYNC_PENDING
      - DELETE_FAILED
      type: string
    SyncState1:
      title: SyncState1
      enum:
      - NOT_SYNCHRONIZED
      - SYNCHRONIZING
      - SYNCHRONIZED
      - FAILED
      - ABORTED
      - DELETING
      - DELETE_FAILED
      - TIMEOUT
      type: string
    tapi.connectivity.ConnectionEndPointUuids:
      title: tapi.connectivity.ConnectionEndPointUuids
      type: object
      properties:
        topology-uuid:
          type: string
          description: none
        node-uuid:
          type: string
          description: none
        node-edge-point-uuid:
          type: string
          description: none
        connection-end-point-uuid:
          type: string
          description: none
      description: none
    tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList:
      title: tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList
      type: object
      properties:
        connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ceplist.ConnectionEndPoint'
          description: ''
    tapi.oam.Oam:
      title: tapi.oam.Oam
      type: object
      properties:
        oam-job-ciena:
          $ref: '#/components/schemas/tapi.oam.OamJobCiena'
    tapi.oam.OamJobCiena:
      title: tapi.oam.OamJobCiena
      type: object
      properties:
        measurement-data-format:
          type: string
          description: Format of oam-job
        measurement-type:
          type: string
          description: Type of oam-job(Can be latency, powerattributes or trailtrace)
        oam-job-type:
          type: string
          description: Type of oam-job-type
        job-details:
          type: array
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
          description: List of job details in the form of name and value.
        connection-end-point:
          type: array
          items:
            $ref: '#/components/schemas/tapi.connectivity.ConnectionEndPointUuids'
          description: Provides the connection end point uuids
    tapi.streaming.context.StreamContext:
      title: tapi.streaming.context.StreamContext
      type: object
      properties:
        supported-stream-type:
          type: array
          items:
            $ref: '#/components/schemas/tapi.streaming.streamcontext.SupportedStreamType'
          description: none
        available-stream:
          type: array
          items:
            $ref: '#/components/schemas/tapi.streaming.AvailableStream'
          description: none
      description: none
    TargetLayer:
      title: TargetLayer
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    TargetLayer1:
      title: TargetLayer1
      enum:
      - ETHERNET
      - OTU1
      - OTU2
      - OTU2e
      - OTU3
      - OTU4
      - OTUCn
      - OTSi
      - OMS
      - OS
      - PHY
      - OTS
      - FICON
      - FC
      - ODU
      - ODU0
      - ODU1
      - ODU2
      - ODU2e
      - ODU3
      - ODU4
      - ODUCn
      - DSR
      - DSR_10GE
      - DSR_100GE
      - DSR_ETHERNET
      - ENCAPSULATION
      - MPLS
      - MPLS_PROTECTION
      - MEDIA
      - LAG
      - RS
      - E0
      - E1
      - E3
      - E1_2M
      - EC1
      - DSR_2M
      - LINE_OC3_STS3_AND_MS_STM1
      - SECTION_OC3_STS3_AND_RS_STM1
      - DSR_OC3_STM1
      - DSR_OC12_STM4
      - DSR_OC48_STM16
      - DSR_OC192_STM64
      - CES_IWF
      - T1
      - DSR_1_5M
      - STS1
      - STS3C
      - STS12C
      - STS24C
      - STS48C
      - STS192C
      - DS0
      - DS1
      - DS3
      - VT15
      - VT2
      - NOT_APPLICABLE
      - ODUFLEX
      - OTUg
      - ODUg
      - BGP
      - G8032
      - FLEXE_GROUP
      - FLEXE
      - VC3
      - VC4
      - VC4_4C
      - VC4_8C
      - VC4_16C
      - VC4_64C
      - VC11
      - VC12
      - IP
      - ES
      - CBR
      type: string
      description: The transmission layer rate.
    TerminationState:
      title: TerminationState
      enum:
      - layer_termination_cannot_terminate
      - layer_termination_not_terminated
      - terminated_server_to_client_flow
      - terminated_client_to_server_flow
      - terminated_bidirectional
      - layer_termination_permanently_terminated
      - termination_state_unknown
      type: string
      description: Whether and how this LayerTermination is terminated.
    TestStatus:
      title: TestStatus
      enum:
      - CANCELLED
      - CANCELLING
      - COMPLETED
      - COMPLETING
      - FAILED
      - IN_PROGRESS
      - PENDING
      - STARTED
      - CANCELED
      - CANCELING
      type: string
    TestType:
      title: TestType
      enum:
      - BENCHMARK
      - CFM_LINKTRACE
      - CFM_LOOPBACK
      - LOOPBACK
      - LSP_PING
      - LSP_TRACEROUTE
      - PW_PING
      - PW_TRACEROUTE
      - TDM_LOOPBACK
      - RACE_TRACK
      - TEST_SET
      - NETWORK_MODE
      - VRF_PING
      - SR_TUNNEL_PING
      - SR_OPERATIONS
      - LDP_PING
      - LDP_OPERATIONS
      - SR_POLICY_PING
      - SR_POLICY_OPERATIONS
      - CLIENT_PORT_LOOPBACK
      type: string
    testType1:
      title: testType1
      enum:
      - benchmark
      - cfmLinktrace
      - cfmLoopback
      - loopback
      - clientPortLoopback
      - lspPing
      - lspTraceroute
      - tdmLoopback
      - pwPing
      - raceTrack
      - testSet
      - networkMode
      - Vrf Ping
      - SrTunnelPing
      type: string
    ThresholdType:
      title: ThresholdType
      enum:
      - min
      - max
      - deviation
      type: string
    Thu:
      title: Thu
      enum:
      - ON
      - OFF
      type: string
    TimeDefinition:
      title: TimeDefinition
      enum:
      - UTC
      - WALL
      - STANDARD
      type: string
    topologyDataorattributesorrepeaters:
      title: topologyDataorattributesorrepeaters
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data45'
          description: ''
    TopologySource:
      title: TopologySource
      enum:
      - discovered
      - adjacency
      - stitched
      - connection_rule
      - connection_rule_nodal
      - backpropagated
      - connection_rule_snc
      - connection_rule_sncp
      - manual
      - retained
      - connection_rule_aps
      type: string
    tpe.id.operator:
      title: tpe.id.operator
      enum:
      - or
      - and
      type: string
    tpeIdQualifier:
      title: tpeIdQualifier
      enum:
      - or
      - and
      type: string
    TraceEntity:
      title: TraceEntity
      type: object
      properties:
        entityid:
          type: string
          default: OTDRCFG-1-5-8
        trace_type:
          type: string
          default: short
        operation:
          type: string
          default: start
        direction:
          type: string
          default: tx
    TraceFailedMode:
      title: TraceFailedMode
      enum:
      - 'NULL'
      - ALARM
      - ALARM_FAIL_LINE
      type: string
    TraceType:
      title: TraceType
      enum:
      - SHORT
      - LONG
      - OFFICE
      type: string
    TrafficProfileMode:
      title: TrafficProfileMode
      enum:
      - GLOBAL_L_2_L_3
      - PORT
      type: string
      description: Traffic Profile Mode
    TrendReading:
      title: TrendReading
      type: object
      properties:
        parameterNative:
          type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/Values2'
          description: ''
        power:
          type: string
    trendsData:
      title: trendsData
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data46'
          description: ''
    TriggerType:
      title: TriggerType
      enum:
      - MANUAL
      - SCHEDULED
      type: string
    ts:
      title: ts
      enum:
      - ms
      - rfc3339
      type: string
    Tue:
      title: Tue
      enum:
      - ON
      - OFF
      type: string
    TunnelRole:
      title: TunnelRole
      enum:
      - headEnd
      - tailEnd
      - transit
      type: string
    TunnelRole1:
      title: TunnelRole1
      enum:
      - headEnd
      - tailEnd
      - transit
      type: string
      description: The role at this point in the MPLS tunnel
    TunnelRole3:
      title: TunnelRole3
      enum:
      - headEnd
      - tailEnd
      type: string
      description: Role of the MPLS tunnel headEnd or tailEnd
    TunnelType:
      title: TunnelType
      enum:
      - rsvp_ingress_corout
      - rsvp_egress_corout
      - rsvp_transit_corout
      - static_ingress_corout
      - static_egress_corout
      - static_transit_corout
      - static_ingress_unidir
      - static_egress_unidir
      - static_transit_unidir
      - rsvp_ingress_unidir
      - rsvp_transit_unidir
      - static_ingress_assoc
      - rsvp_ingress
      - rsvp_transit
      - rsvp_egress
      type: string
      description: Tunnel type (static/dynamic, ingress/egress, corouted/unidrectional)
    Type:
      title: Type
      enum:
      - ActiveAlarm
      type: string
    Type1:
      title: Type1
      enum:
      - AdditionalTextsAggregation
      type: string
    Type2:
      title: Type2
      enum:
      - deviceAttributes
      type: string
      description: Device attributes type
    Type3:
      title: Type3
      enum:
      - DeviceNamesAggregation
      type: string
    Type4:
      title: Type4
      enum:
      - Filter
      type: string
    Type5:
      title: Type5
      enum:
      - FilteredAlarm
      type: string
    Type6:
      title: Type6
      enum:
      - HistoricalAlarm
      type: string
      description: The Network Construct Enrollment Task resource type
    Type7:
      title: Type7
      enum:
      - IpAddressesAggregation
      type: string
    Type8:
      title: Type8
      enum:
      - MacAddressesAggregation
      type: string
    Type9:
      title: Type9
      enum:
      - NativeConditionTypesAggregation
      type: string
    Type10:
      title: Type10
      enum:
      - ResourcesAggregation
      type: string
    Type11:
      title: Type11
      enum:
      - SubnetNamesAggregation
      type: string
    Type12:
      title: Type12
      enum:
      - alarmRecordsCount
      type: string
    Type13:
      title: Type13
      enum:
      - audits
      type: string
      description: The audit type
    Type14:
      title: Type14
      enum:
      - AUDIT_FINDINGS
      type: string
      description: The audit findings
    Type15:
      title: Type15
      enum:
      - auditProfiles
      type: string
      description: The test type
    Type16:
      title: Type16
      enum:
      - auditRuns
      type: string
      description: The audit run type
    Type17:
      title: Type17
      enum:
      - auditTargets
      type: string
      description: The audit type
    Type18:
      title: Type18
      enum:
      - testTypes
      type: string
      description: The test type
    Type19:
      title: Type19
      enum:
      - weekly
      type: string
    Type20:
      title: Type20
      enum:
      - SCHEDULES
      type: string
      description: The backup resource type
    Type21:
      title: Type21
      enum:
      - BACKUPS
      type: string
      description: The backup resource type
    Type22:
      title: Type22
      enum:
      - SETTINGS
      type: string
      description: The backup resource type
    Type23:
      title: Type23
      enum:
      - equipment
      type: string
      description: The equipment resource type
    Type24:
      title: Type24
      enum:
      - equipmentExpectations
      type: string
      description: The equipment resource type
    Type25:
      title: Type25
      enum:
      - srlg
      - shareSrlg
      type: string
      description: The SRLG Attribute type
    Type26:
      title: Type26
      enum:
      - equipmentPlanned
      type: string
      description: The equipment resource type
    Type27:
      title: Type27
      enum:
      - equipmentGroup
      type: string
      description: The equipmentGroup resource type
    Type28:
      title: Type28
      enum:
      - equipmentGroupExpectations
      type: string
      description: The equipment group expectation resource type
    Type29:
      title: Type29
      enum:
      - equipmentHolders
      type: string
      description: The equipment holder resource type
    Type30:
      title: Type30
      enum:
      - LIST
      - RANGE
      - POOL
      - PERCENTAGE
      type: string
      description: Identifies Pattern type
    Type31:
      title: Type31
      enum:
      - OTS
      - SLOTSEQUENCE
      - OTNBBPAIRING
      - REGEN
      type: string
      description: The type of the equipment group.
    Type32:
      title: Type32
      enum:
      - STRICT
      - GROUP
      type: string
      description: The vlan-range-type parameter
    Type33:
      title: Type33
      enum:
      - photonic
      type: string
      description: The route type i.e. photonic. In the future, other types may be supported.
    Type34:
      title: Type34
      enum:
      - equipmentStaticSpec
      type: string
      description: The equipment Static Spec resource type
    Type35:
      title: Type35
      enum:
      - site
      type: string
    Type36:
      title: Type36
      enum:
      - group
      type: string
      description: The Group resource type
    Type37:
      title: Type37
      enum:
      - groupPlanned
      type: string
      description: The Group resource type
    Type39:
      title: Type39
      enum:
      - INHERIT_SERVICE_LEVEL
      - CATALOG
      - COLOR
      - DEFAULT_NETWORK_ROUTING
      type: string
      description: Transport policy type
    Type40:
      title: Type40
      enum:
      - VPWS
      - VPWS_FXC
      type: string
      description: service type
    Type41:
      title: Type41
      enum:
      - Strict
      - Loose
      type: string
      description: Node Type
    Type42:
      title: Type42
      enum:
      - fres
      - relatedFres
      type: string
      description: The FRE resource type
    Type45:
      title: Type45
      enum:
      - networkConstructs
      type: string
      description: The Network Construct resource type
    Type46:
      title: Type46
      enum:
      - tpes
      type: string
      description: The TPE resource type
    Type47:
      title: Type47
      enum:
      - bpmn
      - bpmncaller
      - rp
      - script
      - remote
      type: string
      description: Job Type
    Type48:
      title: Type48
      enum:
      - JobSuccess
      - JobFailure
      - JobCancelled
      type: string
      description: Type of job result
    Type49:
      title: Type49
      enum:
      - BACKUP
      - PRE_UPGRADE
      - UPGRADE
      - POST_UPGRADE
      - SCRIPT
      - CUSTOM_SCRIPT
      type: string
    Type50:
      title: Type50
      enum:
      - batchRemovalRequests
      type: string
    Type52:
      title: Type52
      enum:
      - bindingSid
      type: string
    Type53:
      title: Type53
      enum:
      - neConnectionProfile
      type: string
      description: The NE Connection Profile resource type
    Type54:
      title: Type54
      enum:
      - managementSessions
      type: string
      description: The management session resource type
    Type55:
      title: Type55
      enum:
      - networkConstructExpectations
      type: string
      description: The network construct expectation type
    Type56:
      title: Type56
      enum:
      - networkConstructPlanned
      type: string
      description: The network construct planned type
    Type57:
      title: Type57
      enum:
      - physicalLocation
      type: string
      description: The physical location type
    Type58:
      title: Type58
      enum:
      - physicalLocationExpectations
      type: string
      description: The physical location expectation type
    Type59:
      title: Type59
      enum:
      - FREQ_REF
      type: string
      description: The type of the frequency timing reference
    Type60:
      title: Type60
      enum:
      - PHASE_REF
      type: string
      description: The type of the phase timing reference
    Type61:
      title: Type61
      enum:
      - timingLink
      type: string
      description: Defines the TimingLink resource type.
    Type62:
      title: Type62
      enum:
      - TIMING_NODE
      type: string
      description: Defines the TimingNode resource type.
    Type63:
      title: Type63
      enum:
      - config
      type: string
    Type65:
      title: Type65
      enum:
      - metrics
      type: string
    Type66:
      title: Type66
      enum:
      - results
      type: string
    Type67:
      title: Type67
      enum:
      - trace
      type: string
      description: The active trace resource type
    Type68:
      title: Type68
      enum:
      - distancecoordinate
      type: string
      description: The DistanceCoordinate resource type
    Type69:
      title: Type69
      enum:
      - fiberpath
      type: string
      description: The fiberpath resource type
    Type70:
      title: Type70
      enum:
      - kmlfile
      type: string
      description: The placemark resource type
    Type71:
      title: Type71
      enum:
      - link
      type: string
      description: The link resource type
    Type72:
      title: Type72
      enum:
      - ne
      type: string
      description: The network element resource type
    Type73:
      title: Type73
      enum:
      - otdr
      type: string
      description: The otdr resource type
    Type74:
      title: Type74
      enum:
      - placemark
      type: string
      description: The placemark resource type
    Type75:
      title: Type75
      enum:
      - sor
      type: string
      description: The sor trace resource type
    Type76:
      title: Type76
      enum:
      - spool
      - waypoint
      type: string
      description: The spool/waypoint resource type
    Type77:
      title: Type77
      enum:
      - bp.v1.AlarmEvent
      type: string
      description: The alarm event type
    Type78:
      title: Type78
      enum:
      - tpeExpectations
      type: string
      description: The tpe expectation type
    Type79:
      title: Type79
      enum:
      - tpePlanned
      type: string
      description: The tpe planned type
    Type80:
      title: Type80
      enum:
      - report
      type: string
    Type82:
      title: Type82
      enum:
      - reportSchedule
      type: string
    Type83:
      title: Type83
      enum:
      - controllers
      - resiliencyController
      type: string
      description: The Controller resource type
    Type84:
      title: Type84
      enum:
      - controllerExpectations
      type: string
      description: The controller expectation type
    Type85:
      title: Type85
      enum:
      - controllerPlanned
      type: string
      description: The controller planned type
    Type86:
      title: Type86
      enum:
      - SMO_PROJECTS
      type: string
      description: The SMO project resource type
    Type87:
      title: Type87
      enum:
      - SMO_SERVICES
      type: string
      description: The SMO service resource type
    Type88:
      title: Type88
      enum:
      - FRE_EXPECTATIONS
      type: string
      description: The fre expectation type
    Type89:
      title: Type89
      enum:
      - frePlanned
      type: string
      description: The fre planned type
    Type90:
      title: Type90
      enum:
      - provisioningOperation
      type: string
      description: The provisioningOperation resource type
    Type91:
      title: Type91
      enum:
      - EQUIPMENT_LAYOUTS
      type: string
    Type92:
      title: Type92
      enum:
      - EQUIPMENT_GRAPHICS
      type: string
    Type93:
      title: Type93
      enum:
      - SHELF_GRAPHICS
      type: string
    Type94:
      title: Type94
      enum:
      - SHELF_LAYOUTS
      type: string
    Type95:
      title: Type95
      enum:
      - externalSRLGs
      type: string
    Type96:
      title: Type96
      enum:
      - srlgJob
      type: string
      description: The job type
    Type97:
      title: Type97
      enum:
      - srlgScheduleModels
      type: string
      description: The Srlg Schedule Models type
    Type98:
      title: Type98
      enum:
      - externalSRLGs
      type: string
      description: Type string
    Type99:
      title: Type99
      enum:
      - assignableEntityConfiguration
      type: string
      description: The Srlg Assignable Entity Configuration Type
    Type100:
      title: Type100
      enum:
      - STRUCTURED
      - OPAQUE
      type: string
      description: 'Format type of schema : structured or opaque'
    Type101:
      title: Type101
      enum:
      - SRLG_FORMAT
      type: string
    Type102:
      title: Type102
      enum:
      - propagatableServiceConfiguration
      type: string
      description: The Srlg Propagation Configuration Type
    Type103:
      title: Type103
      enum:
      - srlg
      type: string
      description: Type of data i.e. srlg
    Type105:
      title: Type105
      enum:
      - BER_COMPLEX
      type: string
    Type106:
      title: Type106
      enum:
      - PM_DIAGNOSTICS
      type: string
    Type107:
      title: Type107
      enum:
      - benchmark
      type: string
    Type108:
      title: Type108
      enum:
      - linktrace
      - loopback
      type: string
    Type109:
      title: Type109
      enum:
      - fiberLossData
      type: string
    Type110:
      title: Type110
      enum:
      - measuredFiberLossResults
      type: string
    Type111:
      title: Type111
      enum:
      - raceTrack
      - testSet
      - networkMode
      type: string
    Type112:
      title: Type112
      enum:
      - loopback
      - clientPortLoopback
      type: string
    Type113:
      title: Type113
      enum:
      - ping
      type: string
    Type114:
      title: Type114
      enum:
      - ping
      - traceroute
      type: string
    Type115:
      title: Type115
      enum:
      - OPER_MEASUREMENTS
      - POWER_PMS
      type: string
    Type117:
      title: Type117
      enum:
      - OPERATIONAL_STATUS
      type: string
    Type119:
      title: Type119
      enum:
      - PROPERTY_DATA
      - DELETED_PROP_DATA
      type: string
    Type120:
      title: Type120
      enum:
      - create
      - delete
      type: string
    Type121:
      title: Type121
      enum:
      - spectralData
      type: string
    Type122:
      title: Type122
      enum:
      - spectralResults
      type: string
    Type125:
      title: Type125
      enum:
      - tdmLoopback
      type: string
    Type126:
      title: Type126
      enum:
      - TEST_CAPABILITIES
      type: string
    Type127:
      title: Type127
      enum:
      - TEST_DESCRIPTIONS
      type: string
    Type128:
      title: Type128
      enum:
      - TEST_RESULTS
      type: string
    Type130:
      title: Type130
      enum:
      - consumerState
      type: string
    Type131:
      title: Type131
      enum:
      - topicState
      type: string
    Type132:
      title: Type132
      enum:
      - consumerProcessState
      type: string
    type133:
      title: type133
      enum:
      - ROADM
      - COADM
      - DIAOADM
      - SLOTSEQUENCE
      - OTS
      - OTNBBPAIRING
      type: string
    type136:
      title: type136
      enum:
      - hard
      - soft
      type: string
    Unit:
      title: Unit
      enum:
      - bps
      - kbps
      - mbps
      - gbps
      type: string
      description: 'The bandwidth unit that applies to all bandwidth attributes in this package. E.g.: bps, kbps, mbps, gbps'
    Unit1:
      title: Unit1
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      - DAYS
      type: string
    Unit2:
      title: Unit2
      enum:
      - days
      - minutes
      - months
      - weeks
      type: string
    units:
      title: units
      enum:
      - SNR total [dB]
      - SNR ASE [dB]
      - SNR NLI [dB]
      - NSR total [mw/mW]
      - NSR ASE [mw/mW]
      - NSR NLI [mw/mW]
      type: string
    UpdateRequest:
      title: UpdateRequest
      required:
      - application
      - name
      type: object
      properties:
        application:
          maxLength: 64
          type: string
          description: The application or service to whom this configuration value belongs. (eg nsi,   chronos, stasis)
        instance:
          maxLength: 2
          type: string
          description: The instance identifier of the application. If not provided, the instance will default to the instance agnostic identifier ("-").
        partition:
          maxLength: 64
          type: string
          description: The partition to under which the configuration is found.
        group:
          type: array
          items:
            maxLength: 64
            type: string
          description: Groupings of configurations within a configuration partition. Used to further sort and identify configurations.
        name:
          maxLength: 64
          type: string
          description: The name of the configuration.
        title:
          maxLength: 64
          type: string
          description: A descriptive title of the configuration value for UI readability.
        description:
          maxLength: 256
          type: string
          description: A description of the configuration value for UI readability.
        tags:
          type: array
          items:
            maxLength: 64
            type: string
          description: A list of the tags associated with this configuraiton value.
        value:
          maxLength: 256
          type: string
          description: The value of the configuration.
        default:
          maxLength: 256
          type: string
          description: The default value of the configuration.
        callbacks:
          type: array
          items:
            maxLength: 256
            type: string
          description: A list of URLs specifying the callback location.
        password:
          maxLength: 64
          type: string
          description: The optional password for the configuration
    UpdateState:
      title: UpdateState
      enum:
      - unset
      - updating
      - successful
      - failed
      type: string
      description: Current state of updating the resource, or `unset`
    UpperBoundaryRule:
      title: UpperBoundaryRule
      enum:
      - mustSnapTo6_25GHzGrid_0_768
      - mustSnapTo37_5GHzGrid_0_96
      - snapTo6_25GHzGrid
      - snapTo50GHzGrid
      - snapTo100GHzGrid
      - snapTo75GHzGrid
      type: string
      description: Rule that the boundary of the range must follow. Can point to a specific algorithm to be executed.
    UsedSpectrum:
      title: UsedSpectrum
      type: object
      properties:
        frequencyRange:
          type: string
          default: 193.625000-193.675000
        smdSwitchSelector:
          $ref: '#/components/schemas/SmdSwitchSelector'
        wssSwitchSelector:
          $ref: '#/components/schemas/WssSwitchSelector'
        switchSelectorState:
          type: string
          default: Normal
        serviceName:
          type: string
          default: SiteA to SiteB
        centerFrequency:
          type: string
          default: '193.650000'
        deploymentState:
          type: string
          default: Discovered
    ValidationState:
      title: ValidationState
      enum:
      - UNSET
      - VALID
      - INVALID
      type: string
      description: Validation state is used by RNC to denote that this equipment has either not been examined by RNC, or been examined by RNC and found to match (valid) or not match (invalid) customer expectations
    Value:
      title: Value
      enum:
      - TYPE3_MAC
      type: string
      description: ESI type
    Values:
      title: Values
      required:
      - value
      type: object
      properties:
        value:
          type: number
    Values1:
      title: Values1
      required:
      - binState
      - value
      type: object
      properties:
        binState:
          type: string
        value:
          type: number
    Values2:
      title: Values2
      type: object
      properties:
        value:
          type: string
        startTime:
          type: string
    ValueType:
      title: ValueType
      enum:
      - INDEX
      - ABSOLUTE
      type: string
      description: Describes how sid value must be interpreted.
    WaitToBlockUnit:
      title: WaitToBlockUnit
      enum:
      - min
      - sec
      - msec
      type: string
      description: Unit of time
    WaitToRestoreUnit:
      title: WaitToRestoreUnit
      enum:
      - min
      - sec
      - msec
      type: string
      description: Unit of time
    Wed:
      title: Wed
      enum:
      - ON
      - OFF
      type: string
    wetplantData:
      title: wetplantData
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data47'
    WidthRule:
      title: WidthRule
      enum:
      - mediaChannelWidthRule
      - nmcWidthRule
      type: string
      description: How wide the range can be. Can point to a specific algorithm to be executed.
    WSSOPM:
      title: WSSOPM
      type: object
      properties:
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '10'
        port:
          type: string
          default: '3'
    WSSOPM1:
      title: WSSOPM1
      type: object
      properties:
        shelf:
          type: string
          default: '1'
        slot:
          type: string
          default: '10'
        chcIndex:
          type: string
          default: '12'
        switchSelector:
          type: string
          default: '3'
    WSSOPM2:
      title: WSSOPM2
      type: object
      properties:
        chcAid:
          type: array
          items:
            type: string
          description: ''
    WSSOPM3:
      title: WSSOPM3
      type: object
      properties:
        aid:
          type: string
          default: CHC-1-2-9-1
        targetMaxFrequency:
          type: string
          default: '193.625000'
        targetMinFrequency:
          type: string
          default: '193.675000'
        minFrequencyDeadBand:
          type: string
          default: '0.000'
        maxFrequencyDeadBand:
          type: string
          default: '0.000'
        maxFrequency:
          type: string
          default: '193.625000'
        minFrequency:
          type: string
          default: '193.675000'
        tidName:
          type: string
          default: SSTSite3
        minFrequencyLimit:
          type: string
          default: '191.325000'
        maxFrequencyLimit:
          type: string
          default: '196.125000'
        switchSelector:
          type: string
          default: '12'
        targetSwitchSelector:
          type: string
          default: '11'
        opaque:
          type: string
          default: YES
        chcMode:
          type: string
          default: OPENLOOPLOSS
        primaryState:
          type: string
          default: IS
        wavelength:
          type: string
          default: '1532.00'
        channelWidth:
          type: string
          default: '50.00'
    WssSwitchSelector:
      title: WssSwitchSelector
      type: object
      properties:
        currentSwSelector:
          type: string
          default: '3'
        targetSwSelector:
          type: string
          default: '3'
        chcAid:
          type: string
          default: CHC-1-10-22-3
    WssToAse:
      title: WssToAse
      type: object
      properties:
        port:
          type: string
          default: '5'
    WssToLim:
      title: WssToLim
      type: object
      properties:
        localTag:
          type: string
          default: WSSOPM-1-10-22
        remoteTag:
          type: string
          default: LIM-1-13-6
    WssToSmd:
      title: WssToSmd
      type: object
      properties:
        port:
          type: string
          default: '3'
    Action4:
      title: Action4
      required:
      - alarmAlert
      type: object
      properties:
        alarmAlert:
          $ref: '#/components/schemas/AlarmAlert'
    active1:
      title: active1
      enum:
      - 'true'
      - 'false'
      type: string
      description: (Optional) The active state of the resource
    AdditionalAttributes1:
      title: AdditionalAttributes1
      type: object
      properties:
        additionalProperties:
          type: string
    Address1:
      title: Address1
      type: object
      properties:
        city:
          type: string
          description: City
        zip:
          type: string
          description: Postal/zip code
        street:
          type: string
          description: Street
        state:
          type: string
          description: State/province
        country:
          type: string
          description: Country
        latitude:
          type: number
          description: Latitude
        longitude:
          type: number
          description: Longitude
    AlarmAlert:
      title: AlarmAlert
      required:
      - severity
      type: object
      properties:
        severity:
          $ref: '#/components/schemas/Severity2'
    ApiSettings:
      title: ApiSettings
      type: object
      properties:
        serverTimeoutMs:
          type: integer
          description: Timeout for HTTP client when connecting to a server
          format: int64
        maxConnections:
          type: integer
          description: Maximum concurrent http connections
          format: int32
        maxHttpRetries:
          type: integer
          description: Maximum retries when an http request fails
          format: int32
        maxRedirections:
          type: integer
          description: Maximum redirections for http request
          format: int32
        idleTimeoutMs:
          type: integer
          description: Time to keep an idle connection open before disconnecting it
          format: int64
    assignmentType:
      title: assignmentType
      enum:
      - index
      type: string
      description: assignmentType of segment identifier
    Attributes42:
      title: Attributes42
      type: object
      properties:
        name:
          type: string
        solutionName:
          type: string
        label:
          type: string
        state:
          type: string
        lastExecutionTime:
          type: string
        schedule:
          $ref: '#/components/schemas/Schedule'
        force:
          type: boolean
          default: false
        entityType:
          type: string
    Attributes43:
      title: Attributes43
      type: object
      properties:
        locations:
          type: array
          items:
            $ref: '#/components/schemas/location'
          description: The list of locations associated with the equipment
        category:
          type: string
          description: The equipment category
        nativeName:
          type: string
          description: The native name of the equipment
        provisionedSpec:
          $ref: '#/components/schemas/ProvisionedSpec'
        installedSpec:
          $ref: '#/components/schemas/InstalledSpec'
        state:
          type: string
          description: The primary state of the equipment
        secondaryState:
          type: string
          description: The secondary state of the equipment
        availabilityState:
          type: string
          description: The availability state of the equipment
        reservationState:
          type: string
          description: The reservation state of the equipment
        cardType:
          type: string
          description: The card type
        siteName:
          type: string
          description: The site name associated with the equipment
        siteId:
          type: string
          description: The site identifier associated with the equipment
        maintenanceMode:
          type: boolean
          description: Maintenance mode to indicate if the equipment is available or not to MCP. While in maintenance mode, MCP will not provision anything against this equipment (including TPE information)
        syncScopes:
          type: array
          items:
            $ref: '#/components/schemas/syncScope'
          description: The sync scope for the equipment
        additionalAttributes:
          $ref: '#/components/schemas/AdditionalAttributes1'
    Attributes52:
      title: Attributes52
      type: object
      properties:
        planning:
          $ref: '#/components/schemas/Planning'
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/networkConstructData'
          description: ''
        expectations:
          type: array
          items:
            $ref: '#/components/schemas/networkConstructExpectationsData'
          description: ''
    Attributes62:
      title: Attributes62
      type: object
      properties:
        userData:
          type: object
          description: Userdata for a network construct
        ipaddress:
          type: string
        name:
          type: string
        accessIdentifier:
          type: string
    Attributes72:
      title: Attributes72
      type: object
      properties:
        siteState:
          $ref: '#/components/schemas/site_state'
        siteType:
          $ref: '#/components/schemas/site_type'
        siteId:
          pattern: '[a-zA-Z0-9_-]{3,}$'
          type: string
          description: Each site should have unique string. Supports length>=3 strings of alphanumeric characters plus '_' and '-'.
        siteIndex:
          type: integer
          description: The index of the site
          format: int32
        siteAddress:
          type: string
          description: Network address at which remote site can be reached.
        connectionStatus:
          $ref: '#/components/schemas/connection_status'
        siteRecovery:
          $ref: '#/components/schemas/SiteRecovery'
        siteActivation:
          $ref: '#/components/schemas/SiteActivation2'
        lastConnectedTime:
          type: string
          description: The last time the site was connected, in format 2018-05-10T15:00:00.000Z
          format: date-time
        lastDisconnectedTime:
          type: string
          description: The last time the site was disconnected, in format 2018-05-10T15:00:00.000Z
          format: date-time
        lastResyncTime:
          type: string
          description: The last time the site was resynchronized, in format 2018-05-10T15:00:00.000Z
          format: date-time
        processState:
          type: array
          items:
            $ref: '#/components/schemas/processState'
          description: The processing states of Inventory, Alarm and PM
    Attributes82:
      title: Attributes82
      type: object
      properties:
        taskType:
          $ref: '#/components/schemas/task_type'
        status:
          $ref: '#/components/schemas/task_status'
        startTime:
          type: string
          description: The time at which the task was started
        duration:
          type: string
          description: The elapsed time of the task
        progress:
          type: string
          description: The progress of the task, e.g. step 3 of 8
        currentStepNum:
          type: string
          description: The number of the current task step
        currentStep:
          type: string
          description: The name of the current step
        previousStep:
          type: string
          description: The name of the previous step
        error:
          type: string
          description: The error in event of failure
    Attributes152:
      title: Attributes152
      required:
      - measurementPoints
      type: object
      properties:
        criteria:
          $ref: '#/components/schemas/Criteria'
        measurementPoints:
          type: array
          items:
            $ref: '#/components/schemas/measurementPoint'
          description: ''
    Attributes210:
      title: Attributes210
      type: object
      properties:
        archive:
          type: boolean
          default: false
        numberOfRetainedLocalBackups:
          type: integer
          format: int32
        numberOfRetainedArchivedBackups:
          type: integer
          format: int32
        timeoutInHours:
          type: integer
          format: int32
        raiseAlarmOnBackupFailure:
          type: boolean
          default: false
    Attributes232:
      title: Attributes232
      required:
      - nodeId
      - thresholdGroupId
      type: object
      properties:
        nodeId:
          uniqueItems: true
          type: array
          items:
            type: string
          description: The IDs for nodes containing the specified resource(s)
        tags:
          type: array
          items:
            type: string
          description: Specific tags to match on. Currently only the facilityNameNative tag is supported. Regexp match supported
        thresholdGroupId:
          uniqueItems: true
          type: array
          items:
            type: string
          description: The threshold group(s) to associate with the resource profile
    Attributes242:
      title: Attributes242
      required:
      - action
      - pmParameter
      - thresholdType
      type: object
      properties:
        action:
          $ref: '#/components/schemas/Action4'
        deviation:
          $ref: '#/components/schemas/Deviation1'
        maxValue:
          $ref: '#/components/schemas/MaxValue1'
        minValue:
          $ref: '#/components/schemas/MinValue1'
        name:
          type: string
          description: The threshold name
        pmParameter:
          type: string
          description: The PM parameter to apply the threshold to
        tags:
          type: object
          additionalProperties:
            type: string
          description: A key-value hash of tags to be matched upon, all tags must match for a positive match. Supports regexp matching
        thresholdType:
          $ref: '#/components/schemas/ThresholdType'
    Attributes262:
      title: Attributes262
      required:
      - thresholdId
      type: object
      properties:
        thresholdId:
          uniqueItems: true
          type: array
          items:
            type: string
          description: The threshold ID(s) to group
    Attributes310:
      title: Attributes310
      type: object
      properties:
        planning:
          $ref: '#/components/schemas/Planning'
        networkConstruct:
          $ref: '#/components/schemas/networkConstructData'
        equipment:
          $ref: '#/components/schemas/Equipment'
    band1:
      title: band1
      enum:
      - C
      - L
      type: string
      description: Band Type, Required for FAMILY_D
    batchType1:
      title: batchType1
      enum:
      - BACKUP
      - PRE_UPGRADE
      - UPGRADE
      - POST_UPGRADE
      - SCRIPT
      - CUSTOM_SCRIPT
      type: string
      description: Retrieve all NEs details by batch type
    bookingData.lockout1:
      title: bookingData.lockout1
      enum:
      - 'true'
      - 'false'
      type: string
      description: (Optional)  Flag that enables/disables a link from having additional tunnel BW being consumed
    BpocoreAssetManagerApiV1AreasPullrequestsRequest:
      title: BpocoreAssetManagerApiV1AreasPullrequestsRequest
      type: object
      properties:
        branch:
          type: string
          description: Branch or commit hash from which the pull request is to be made
        title:
          type: string
          description: Title
        comment:
          type: string
          description: Optional comment
    BpocoreAssetManagerApiV1KeysRequest:
      title: BpocoreAssetManagerApiV1KeysRequest
      type: object
      properties:
        id:
          type: string
          description: Fingerprint (per ssh-keygen) of the key (without colons).  Not used on Create.
        key:
          type: string
          description: Authorized key (e.g., content of the id_rsa.pub file generated by ssh-keygen)
    BpocoreMarketApiV1ApplicationSlicesRequest:
      title: BpocoreMarketApiV1ApplicationSlicesRequest
      type: object
      properties:
        name:
          type: string
          description: Name of the application slice
        description:
          type: string
          description: Description of the application slice
        extendable:
          type: boolean
          description: Whether the application slice is extendable
        holderTenantId:
          type: string
          description: The id of the tenant holding the slice
        ownerTenantId:
          type: string
          description: The id of the tenant owning the slice
        parentId:
          type: string
          description: The id of the parent application slice
          format: uuid
        isDefault:
          type: boolean
          description: Whether the application slice is the default slice of the owner tenant
        requiredAppSlicesIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Application slices this slice depends on
        sliceRole:
          type: object
    BpocoreMarketApiV1DomainsRequest:
      title: BpocoreMarketApiV1DomainsRequest
      type: object
      properties:
        title:
          type: string
          description: Descriptive name/title of domain
        description:
          type: string
          description: Detailed description
        accessUrl:
          type: string
          description: Access URL to the domain
        properties:
          $ref: '#/components/schemas/JObject'
        address:
          $ref: '#/components/schemas/Address1'
        rpId:
          type: string
          description: Resource provider managing this domain
        operationMode:
          $ref: '#/components/schemas/OperationMode'
        tenantId:
          type: string
          description: Orchestrator tenant ID for the domain owner (if unspecified defaults to requester)
        onlyEnableTypes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: When non-empty, only enable these resource types in the domain
    BpocoreMarketApiV1DomainsValidateRequest:
      title: BpocoreMarketApiV1DomainsValidateRequest
      type: object
      properties:
        title:
          type: string
          description: Descriptive name/title of domain
        description:
          type: string
          description: Detailed description
        accessUrl:
          type: string
          description: Access URL to the domain
        properties:
          $ref: '#/components/schemas/JObject'
        address:
          $ref: '#/components/schemas/Address1'
        rpId:
          type: string
          description: Resource provider managing this domain
        operationMode:
          $ref: '#/components/schemas/OperationMode'
        tenantId:
          type: string
          description: Orchestrator tenant ID for the domain owner (if unspecified defaults to requester)
        onlyEnableTypes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: When non-empty, only enable these resource types in the domain
    BpocoreMarketApiV1JobsClaimRequest:
      title: BpocoreMarketApiV1JobsClaimRequest
      type: object
      properties:
        executorUrl:
          type: string
          description: URL that implements the Executor API for this job
        capabilities:
          type: array
          items:
            type: string
          description: Array of strings that expresses the capabilities supported by the job executor
    BpocoreMarketApiV1JobsProgressRequest:
      title: BpocoreMarketApiV1JobsProgressRequest
      type: object
      properties:
        progress:
          type: object
    BpocoreMarketApiV1JobsResultRequest:
      title: BpocoreMarketApiV1JobsResultRequest
      type: object
      properties:
        _type:
          $ref: '#/components/schemas/Type48'
        result:
          $ref: '#/components/schemas/JObject'
        reason:
          type: string
          description: For JobFailure, a String description of the failure
    BpocoreMarketApiV1JobsSuspendedRequest:
      title: BpocoreMarketApiV1JobsSuspendedRequest
      type: object
      properties:
        suspended:
          type: boolean
          description: Job suspension state
    BpocoreMarketApiV1ProductsRequest:
      title: BpocoreMarketApiV1ProductsRequest
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the product (ignored during create request)
        resourceTypeId:
          type: string
          description: The type of resource provided by the product
        title:
          type: string
          description: Name or title describing the product
        description:
          type: string
          description: Detailed description of the product
        active:
          type: boolean
          description: State of the product (active or inactive)
        domainId:
          type: string
          description: Identifier of the domain that advertises the product
        providerProductId:
          type: string
          description: Identifier within the provider's context or scope for the product
        constraints:
          $ref: '#/components/schemas/JObject'
        providerData:
          $ref: '#/components/schemas/JObject'
    BpocoreMarketApiV1RelationshipsRequest:
      title: BpocoreMarketApiV1RelationshipsRequest
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the relationship (optional/ignored on calls to create)
        relationshipTypeId:
          type: string
          description: URI of relationship type
        properties:
          $ref: '#/components/schemas/JObject'
        sourceId:
          type: string
          description: UUID of source resource
        requirementName:
          type: string
          description: Requirement name in source resource
        targetId:
          type: string
          description: UUID of target resource
        capabilityName:
          type: string
          description: Capability name in target resource
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        providerData:
          $ref: '#/components/schemas/JObject'
    BpocoreMarketApiV1ResourceProvidersRequest:
      title: BpocoreMarketApiV1ResourceProvidersRequest
      type: object
      properties:
        id:
          type: string
          description: Unique identifier to address the resource provider
        domainType:
          type: string
          description: Type of domain managed by the resource provider
        uri:
          type: string
          description: Address to contact the resource provider
        resourceTypes:
          type: array
          items:
            $ref: '#/components/schemas/ResourceTypeSetting'
          description: List of resource types managed by the resource provider
        domainSettings:
          $ref: '#/components/schemas/DomainSettings2'
        properties:
          $ref: '#/components/schemas/JObject'
        title:
          type: string
          description: Name of the resource provider
        description:
          type: string
          description: Description of the resource provider
        providerId:
          type: string
          description: Identifier of the resource provider in provider's context
        protocolVersion:
          $ref: '#/components/schemas/ProtocolVersion2'
        asyncProtocolVersion:
          $ref: '#/components/schemas/AsyncProtocolVersion'
        relationships:
          type: array
          items:
            $ref: '#/components/schemas/RelationshipSetting'
          description: Settings to declare how relationships should be identified for resource types managed by this resource provider
        lastUpsertTime:
          type: string
          description: Last time the resource provider is upserted in the database
          format: date-time
    BpocoreMarketApiV1ResourcesObservedRequest:
      title: BpocoreMarketApiV1ResourcesObservedRequest
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
    BpocoreMarketApiV1ResourcesOperationsRequest:
      title: BpocoreMarketApiV1ResourcesOperationsRequest
      type: object
      properties:
        interface:
          type: string
          description: ID of the interface
        title:
          type: string
          description: Title of the operation
        description:
          type: string
          description: Description of the operation
        inputs:
          $ref: '#/components/schemas/JObject'
        resourceStateConstraints:
          $ref: '#/components/schemas/JObject'
    BpocoreMarketApiV1ResourcesOperationsValidateRequest:
      title: BpocoreMarketApiV1ResourcesOperationsValidateRequest
      type: object
      properties:
        interface:
          type: string
          description: ID of the interface
        title:
          type: string
          description: Title of the operation
        description:
          type: string
          description: Description of the operation
        inputs:
          $ref: '#/components/schemas/JObject'
        resourceStateConstraints:
          $ref: '#/components/schemas/JObject'
    BpocoreMarketApiV1ResourcesPromoteRequest:
      title: BpocoreMarketApiV1ResourcesPromoteRequest
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource (optional/ignored on calls to create)
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        domainId:
          type: string
          description: The domain for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        updatedAt:
          type: string
          description: Time of last update
          format: date-time
        createdAt:
          type: string
          description: Time of creation
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update including observed update
          format: int64
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        updateState:
          $ref: '#/components/schemas/UpdateState'
        updateReason:
          type: string
          description: Reason for the update state
        updateCount:
          type: integer
          description: Monotonically increasing count of updates applied to this resource
          format: int64
    BpocoreMarketApiV1ResourcesRequest:
      title: BpocoreMarketApiV1ResourcesRequest
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
    BpocoreMarketApiV1ResourcesSubDomainRequest:
      title: BpocoreMarketApiV1ResourcesSubDomainRequest
      type: object
      properties:
        subDomainId:
          type: string
          description: The ID of the sub-domain
          format: uuid
    BpocoreMarketApiV1ResourcesValidateRequest:
      title: BpocoreMarketApiV1ResourcesValidateRequest
      type: object
      properties:
        productId:
          type: string
          description: The type of product for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission of the resource
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        providerData:
          $ref: '#/components/schemas/JObject'
        subDomainId:
          type: string
          description: Sub-domain ID
          format: uuid
    BpocoreMarketApiV1SharingPermissionsRequest:
      title: BpocoreMarketApiV1SharingPermissionsRequest
      type: object
      properties:
        id:
          type: string
          description: Unique id of the permission
        label:
          type: string
          description: Label of the permission
        description:
          type: string
          description: Description of the permission
        visibleToSubTenants:
          type: boolean
          description: Whether subject is visible to subtenants if shared
        updatableBySubTenants:
          type: boolean
          description: Whether subject is updatable by subtenants if shared
        deletableBySubTenants:
          type: boolean
          description: Whether subject is deletable by subtenants if shared
    BpocoreMarketApiV1SubDomainsRequest:
      title: BpocoreMarketApiV1SubDomainsRequest
      type: object
      properties:
        name:
          type: string
          description: Name of the sub-domain
        description:
          type: string
          description: Description of the sub-domain
        domainId:
          type: string
          description: ID of the domain this sub-domain belongs to
        scope:
          $ref: '#/components/schemas/Scope1'
        decomposable:
          type: boolean
          description: Whether the sub-domain can be decomposped
        assignable:
          type: boolean
          description: Whether the sub-domain can be re-assigned
        applicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices this sub-domain is in
        extendedApplicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices for which this sub-domain acts as an extended sub-domain
        parentId:
          type: string
          description: The ID of the container sub-domain, if applicable
          format: uuid
    BpocoreMarketApiV1TagKeysRequest:
      title: BpocoreMarketApiV1TagKeysRequest
      type: object
      properties:
        key:
          type: string
          description: Tag key
        description:
          type: string
          description: Textual description of tag key
        autoIndexed:
          type: boolean
          description: Are tag value for this key auto-indexed?
    BpocoreMarketApiV1TagKeysTagValuesRequest:
      title: BpocoreMarketApiV1TagKeysTagValuesRequest
      type: object
      properties:
        value:
          type: string
          description: Tag value
        key:
          type: string
          description: Tag key
        description:
          type: string
          description: Description of the meaning of a tag value
    BpocoreMarketApiV1ApplicationSlicesRequest1:
      title: BpocoreMarketApiV1ApplicationSlicesRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the application slice
          format: uuid
        name:
          type: string
          description: Name of the application slice
        description:
          type: string
          description: Description of the application slice
        extendable:
          type: boolean
          description: Whether the application slice is extendable
        holderTenantId:
          type: string
          description: The id of the tenant holding the slice
        ownerTenantId:
          type: string
          description: The id of the tenant owning the slice
        parentId:
          type: string
          description: The id of the parent application slice
          format: uuid
        isDefault:
          type: boolean
          description: Whether the application slice is the default slice of the owner tenant
        requiredAppSlicesIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Application slices this slice depends on
        sliceRole:
          type: object
    BpocoreMarketApiV1DomainsRequest1:
      title: BpocoreMarketApiV1DomainsRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique id of the domain
        title:
          type: string
          description: Descriptive name/title of domain
        description:
          type: string
          description: Detailed description
        domainType:
          type: string
          description: Type of the domain
        accessUrl:
          type: string
          description: Access URL to the domain
        properties:
          $ref: '#/components/schemas/JObject'
        address:
          $ref: '#/components/schemas/Address1'
        tenantId:
          type: string
          description: Orchestrator tenant
        rpId:
          type: string
          description: Resource provider that creates this domain
        operationMode:
          $ref: '#/components/schemas/OperationMode'
        lastConnected:
          type: string
          description: Last time domain was connected to southbound
          format: date-time
        reason:
          type: string
          description: Reason message for connection failure
        connectionStatus:
          type: object
        initialDiscoveryStatus:
          type: object
        onlyEnableTypes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: When non-empty, only enable these resource types in the domain
    BpocoreMarketApiV1ResourcesRequest1:
      title: BpocoreMarketApiV1ResourcesRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource (optional/ignored on calls to create)
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        domainId:
          type: string
          description: The domain for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        updatedAt:
          type: string
          description: Time of last update
          format: date-time
        createdAt:
          type: string
          description: Time of creation
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update including observed update
          format: int64
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        updateState:
          $ref: '#/components/schemas/UpdateState'
        updateReason:
          type: string
          description: Reason for the update state
        updateCount:
          type: integer
          description: Monotonically increasing count of updates applied to this resource
          format: int64
    BpocoreMarketApiV1ResourcesOperationsRequest1:
      title: BpocoreMarketApiV1ResourcesOperationsRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the operation
        resourceId:
          type: string
          description: ID of the resource
        interface:
          type: string
          description: ID of the interface
        title:
          type: string
          description: Title of the operation
        description:
          type: string
          description: Description of the operation
        inputs:
          $ref: '#/components/schemas/JObject'
        outputs:
          $ref: '#/components/schemas/JObject'
        state:
          $ref: '#/components/schemas/State14'
        reason:
          type: string
          description: Reason for the operation state
        progress:
          $ref: '#/components/schemas/JArray'
        providerData:
          $ref: '#/components/schemas/JObject'
        createdAt:
          type: string
          description: When the operation was created
          format: date-time
        updatedAt:
          type: string
          description: When the operation was last updated
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update
          format: int64
        resourceStateConstraints:
          $ref: '#/components/schemas/JObject'
        executionGroup:
          type: string
          description: Execution group of the operation
    BpocoreMarketApiV1ResourcesOperationsValidateRequest1:
      title: BpocoreMarketApiV1ResourcesOperationsValidateRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the operation
        resourceId:
          type: string
          description: ID of the resource
        interface:
          type: string
          description: ID of the interface
        title:
          type: string
          description: Title of the operation
        description:
          type: string
          description: Description of the operation
        inputs:
          $ref: '#/components/schemas/JObject'
        outputs:
          $ref: '#/components/schemas/JObject'
        state:
          $ref: '#/components/schemas/State14'
        reason:
          type: string
          description: Reason for the operation state
        progress:
          $ref: '#/components/schemas/JArray'
        providerData:
          $ref: '#/components/schemas/JObject'
        createdAt:
          type: string
          description: When the operation was created
          format: date-time
        updatedAt:
          type: string
          description: When the operation was last updated
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update
          format: int64
        resourceStateConstraints:
          $ref: '#/components/schemas/JObject'
        executionGroup:
          type: string
          description: Execution group of the operation
    BpocoreMarketApiV1ResourcesObservedRequest1:
      title: BpocoreMarketApiV1ResourcesObservedRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource (optional/ignored on calls to create)
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        domainId:
          type: string
          description: The domain for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        updatedAt:
          type: string
          description: Time of last update
          format: date-time
        createdAt:
          type: string
          description: Time of creation
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update including observed update
          format: int64
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        updateState:
          $ref: '#/components/schemas/UpdateState'
        updateReason:
          type: string
          description: Reason for the update state
        updateCount:
          type: integer
          description: Monotonically increasing count of updates applied to this resource
          format: int64
    BpocoreMarketApiV1ResourcesValidateRequest1:
      title: BpocoreMarketApiV1ResourcesValidateRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource (optional/ignored on calls to create)
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        resourceTypeId:
          type: string
          description: The type of this resource
        productId:
          type: string
          description: The type of product for this resource
        domainId:
          type: string
          description: The domain for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        tenantId:
          type: string
          description: Owner tenant of the resource?
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission associated with the resource
        subDomainId:
          type: string
          description: Identifier of the resource's sub-domain
          format: uuid
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        differences:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: Differences represent the difference between desired and observed state
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        providerData:
          $ref: '#/components/schemas/JObject'
        updatedAt:
          type: string
          description: Time of last update
          format: date-time
        createdAt:
          type: string
          description: Time of creation
          format: date-time
        revision:
          type: integer
          description: Strictly increasing revision number, incremented every update including observed update
          format: int64
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        updateState:
          $ref: '#/components/schemas/UpdateState'
        updateReason:
          type: string
          description: Reason for the update state
        updateCount:
          type: integer
          description: Monotonically increasing count of updates applied to this resource
          format: int64
    BpocoreMarketApiV1SharingPermissionsRequest1:
      title: BpocoreMarketApiV1SharingPermissionsRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique id of the permission
        label:
          type: string
          description: Label of the permission
        description:
          type: string
          description: Description of the permission
        visibleToSubTenants:
          type: boolean
          description: Whether subject is visible to subtenants if shared
        updatableBySubTenants:
          type: boolean
          description: Whether subject is updatable by subtenants if shared
        deletableBySubTenants:
          type: boolean
          description: Whether subject is deletable by subtenants if shared
        isBuiltIn:
          type: boolean
          description: Whether this is a built-in permission
    BpocoreMarketApiV1SubDomainsRequest1:
      title: BpocoreMarketApiV1SubDomainsRequest1
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the sub-domain
          format: uuid
        name:
          type: string
          description: Name of the sub-domain
        description:
          type: string
          description: Description of the sub-domain
        ownerTenantId:
          type: string
          description: The ID of the owner tenant
        domainId:
          type: string
          description: ID of the domain this sub-domain belongs to
        scope:
          $ref: '#/components/schemas/Scope1'
        decomposable:
          type: boolean
          description: Whether the sub-domain can be decomposed
        assignable:
          type: boolean
          description: Whether the sub-domain can be re-assigned
        applicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices this sub-domain is in
        extendedApplicationSlices:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Set of application slices for which this sub-domain acts as an extended sub-domain
        parentId:
          type: string
          description: The ID of the container sub-domain, if applicable
          format: uuid
        isDefault:
          type: boolean
          description: Whether this sub-domain is its domain's default sub-domain
    BpocoreMarketApiV1ResourcesRequest2:
      title: BpocoreMarketApiV1ResourcesRequest2
      type: object
      properties:
        productId:
          type: string
          description: The type of product for this resource
        orderId:
          type: string
          description: If applicable, the order containing this resource
        label:
          type: string
          description: Textual label
        description:
          type: string
          description: Detailed description of this resource
        properties:
          $ref: '#/components/schemas/JObject'
        providerResourceId:
          type: string
          description: Identifier of the resource in provider's context
        discovered:
          type: boolean
          description: Is this resource discovered
        shared:
          type: boolean
          description: Is resource shared?
        sharingPermissionId:
          type: string
          description: The sharing permission of the resource
        desiredOrchState:
          $ref: '#/components/schemas/DesiredOrchState'
        nativeState:
          type: string
          description: Native (type specific) state
        orchState:
          $ref: '#/components/schemas/OrchState'
        reason:
          type: string
          description: Reason for the orchestration state
        tags:
          type: object
          additionalProperties: {}
          description: Tags
        autoClean:
          type: boolean
          description: Free up any resources automatically upon any activation failure
        providerData:
          $ref: '#/components/schemas/JObject'
        subDomainId:
          type: string
          description: Sub-domain ID
          format: uuid
    BpocorePoliciesApiV1ConditionsRequest:
      title: BpocorePoliciesApiV1ConditionsRequest
      type: object
      properties:
        id:
          type: string
          description: UUID of the condition. An UUID will be assigned if not specified
        name:
          type: string
          description: Condition name
        tenantId:
          type: string
          description: UUID for the tenant for whom this condition applies
        description:
          type: string
          description: Optional description of the condition
        definition:
          type: string
          description: Boolean expression that used to define the matching condition
    BpocorePoliciesApiV1PoliciesRequest:
      title: BpocorePoliciesApiV1PoliciesRequest
      type: object
      properties:
        id:
          type: string
          description: UUID of the policy. An UUID will be assigned if not specified
        policyType:
          type: object
        name:
          type: string
          description: Policy name
        authRealm:
          type: string
          description: Authentication realm to which the policy applies
        tenantId:
          type: string
          description: UUID for the tenant for whom this policy applies
        description:
          type: string
          description: Optional description of the policy
        conditionId:
          type: string
          description: Identifier for the logical condition used to determine applicability of this policy
        policyActions:
          type: object
        filter:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Set of filters to apply in this policy
        monitoredTopic:
          type: string
          description: Message bus topic for a monitor policy type
        actionInfo:
          $ref: '#/components/schemas/JObject'
    BpocorePoliciesApiV1RealmsRequest:
      title: BpocorePoliciesApiV1RealmsRequest
      type: object
      properties:
        name:
          type: string
          description: Realm name
        description:
          type: string
          description: Optional description of the realm
    calculation1:
      title: calculation1
      enum:
      - ThroughputWithOctets
      - ThroughputWithOctetsAndFrames
      type: string
      description: Type of rollup calculation
    CardType1:
      title: CardType1
      required:
      - shortName
      type: object
      properties:
        longName:
          type: string
          description: CTYPE of card such as the full name of card reported by NE
        partNumber:
          type: string
          description: 'PEC code of the card. Ex: NTK553MA'
        shortName:
          type: string
          description: Card name such as 100g MUX, OTR, OTNFLEX
    ChildrenNetworkConstruct:
      title: ChildrenNetworkConstruct
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/relationshipData'
          description: The one-to-many relationship
    ColanA2:
      title: ColanA2
      type: object
      properties:
        defaultGateway:
          type: string
          description: Default gateway of the shelf.
        override:
          type: string
          description: Override property of the shelf.
        usage:
          type: string
          description: Usage of the shelf.
        subnetMask:
          type: string
          description: Subnet mask of the shelf.
        ipAddress:
          type: string
          description: IP address of the colan A.
        topology:
          type: string
          description: Network topology of the shelf in the network.
    ColanX2:
      title: ColanX2
      type: object
      properties:
        defaultGateway:
          type: string
          description: Default gateway of the shelf.
        override:
          type: string
          description: Override property of the shelf.
        usage:
          type: string
          description: Usage of the shelf.
        subnetMask:
          type: string
          description: Subnet mask of the shelf.
        ipAddress:
          type: string
          description: IP address of the colan X.
        topology:
          type: string
          description: Network topology of the shelf in the network.
    Concrete:
      title: Concrete
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/relationshipData'
          description: The one-to-many relationship
    configuration1:
      title: configuration1
      enum:
      - 15_MINUTES
      - 24_HOURS
      type: string
      description: The name of the configuration, representing the desired metric bin (i.e. 15_MINUTES or 24_HOURS)
    content1:
      title: content1
      enum:
      - summary
      - detail
      type: string
      description: (Optional) The TPE content level
    content21:
      title: content21
      enum:
      - file
      - json
      type: string
      description: (Optional) The Script profile output content
    Content-Type:
      title: Content-Type
      enum:
      - application/json
      type: string
    Content-Type37:
      title: Content-Type37
      enum:
      - application/x-www-form-urlencoded
      type: string
    Content-Type65:
      title: Content-Type65
      enum:
      - application/vnd.api+json
      type: string
    Content-Type67:
      title: Content-Type67
      enum:
      - application/octet-stream
      type: string
    Criteria:
      title: Criteria
      type: object
      properties:
        granularity:
          type: array
          items:
            $ref: '#/components/schemas/Granularity'
          description: '[6500 only] The granularity of the desired binTypes'
        monVal:
          maximum: 2147483646
          minimum: -2147483646
          type: integer
          description: Value of the monitored PM parameter
          format: int32
          default: 0
        powerType:
          $ref: '#/components/schemas/PowerType'
    Data37:
      title: Data37
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes52'
    Data92:
      title: Data92
      type: object
      properties:
        id:
          type: string
          description: the unique site ID
        type:
          $ref: '#/components/schemas/Type35'
        attributes:
          $ref: '#/components/schemas/Attributes72'
    Data102:
      title: Data102
      type: object
      properties:
        id:
          type: string
          description: the unique site ID
        type:
          $ref: '#/components/schemas/task_type'
        attributes:
          $ref: '#/components/schemas/Attributes82'
    Data112:
      title: Data112
      required:
      - attributes
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes310'
    Data213:
      title: Data213
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes232'
        id:
          type: string
          description: The unique resource profile identifer
        type:
          enum:
          - resourceProfile
          type: string
    Data222:
      title: Data222
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes242'
        id:
          type: string
          description: the unique threshold ID
        type:
          enum:
          - threshold
          type: string
    Data232:
      title: Data232
      required:
      - attributes
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes262'
        id:
          type: string
          description: The unique threshold group identifer
        type:
          enum:
          - thresholdGroup
          type: string
    Data292:
      title: Data292
      required:
      - id
      - type
      - attributes
      type: object
      properties:
        id:
          type: string
          description: The topic name
        type:
          enum:
          - topic
          type: string
        attributes:
          $ref: '#/components/schemas/Attributes26'
    DctApiV1BpiCredentialsRequest:
      title: DctApiV1BpiCredentialsRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data8'
    Deviation1:
      title: Deviation1
      required:
      - baseValue
      - value
      type: object
      properties:
        baseValue:
          type: number
          description: the base value from which the deviation occurs
        value:
          type: number
          description: the absolute value of the deviation for the alert to be triggered
    dir1:
      title: dir1
      enum:
      - Tx
      - Rx
      type: string
      description: 'Tx or Rx termination end of the OTSi service. The allowed values are: Tx, Rx'
    directionality51:
      title: directionality51
      enum:
      - unidirectional
      - bidirectional
      type: string
      description: (Optional) Indicates if unidirectional or bidirectional FREs should be returned
    DiscoveryStrategy1:
      title: DiscoveryStrategy1
      type: object
      properties:
        strategyType:
          $ref: '#/components/schemas/StrategyType'
        pollingMode:
          $ref: '#/components/schemas/PollingMode'
        pollingSettings:
          $ref: '#/components/schemas/PollingSettings'
    DisplayLabels:
      title: DisplayLabels
      type: object
      properties:
        additionalProperties:
          type: string
    DomainSettings2:
      title: DomainSettings2
      type: object
      properties:
        connection_status:
          type: boolean
          description: Specifies if maintenance of domain's connection status is supported
        initial_discovery_status:
          type: boolean
          description: Specifies if maintenance of domain's initial discovery status is supported
        metaInfoDiscoveryStrategy:
          type: object
        minInterUpsertIntervalMs:
          type: number
          description: Specifies the minimal inter-call interval bpocore should honor when upserting the Domain
        rpType:
          type: object
        asyncDeviceTypes:
          type: array
          items:
            type: string
          description: Specifies the Resource Type IDs that use async discovery strategy
    duration11:
      title: duration11
      enum:
      - 15 MINUTES
      - 30 MINUTES
      - 1 HOURS
      - 2 HOURS
      - 3 HOURS
      - 6 HOURS
      - 24 HOURS
      - 48 HOURS
      type: string
      description: The interval for which count need to fetch. For 24_HOURS configuration, only 24 Hour and 48 Hour duration supported
    Equipment:
      title: Equipment
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the equipment resource
        type:
          type: string
          description: The equipment resource type
        attributes:
          $ref: '#/components/schemas/Attributes43'
        relationships:
          $ref: '#/components/schemas/Relationships3'
    EquipmentExpectations:
      title: EquipmentExpectations
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/relationshipData'
          description: The one-to-many relationship
    EquipmenttopologyplanningApiV1GlobalConfigurationDataRequest:
      title: EquipmenttopologyplanningApiV1GlobalConfigurationDataRequest
      type: object
      properties:
        Key:
          type: string
          description: Gets or sets the Key
        Value:
          type: string
          description: Gets or sets the Value
    Error12:
      title: Error12
      required:
      - code
      - detail
      - title
      type: object
      properties:
        code:
          type: string
          description: Error code
        detail:
          type: string
          description: Error description
        title:
          type: string
          description: Error Title
    exclude1:
      title: exclude1
      enum:
      - actual
      - expectation
      type: string
      description: (Optional) The given type would be excluded from get parents call, only combine with childFreId
    facilityBypass1:
      title: facilityBypass1
      enum:
      - exclude
      type: string
      description: (Optional) Allow filtering of FRE's with facilityBypass tunnels.
    fillratio1:
      title: fillratio1
      enum:
      - current
      - full
      type: string
      description: Fill Ratio
    Filter12:
      title: Filter12
      type: object
      properties:
        networkElements:
          $ref: '#/components/schemas/NetworkElements2'
        networkElementsAndFacilities:
          type: object
          additionalProperties: {}
          description: A map of network element names to lists of facilities from which to query correlated metrics. In order for paging to behave correctly, only include one facility type in your query, either SDMON or CHMON or OPM. Ensure that the facility name does NOT include the subport value, only use the shelf-slot-port.
    filter21:
      title: filter21
      enum:
      - all
      - max
      - min
      - mean
      type: string
      description: type of SNR
    FilterParam:
      title: FilterParam
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            type: string
    function1:
      title: function1
      enum:
      - ISIS
      type: string
    GeoLocation2:
      title: GeoLocation2
      type: object
      properties:
        zone:
          type: string
          description: Zone of the device location
        longitude:
          type: string
          description: Longitude of the device location
        latitude:
          type: string
          description: Latitude of the device location
    granularity51:
      title: granularity51
      enum:
      - 1_Day
      - 7_Days
      type: string
      description: Calculation granularity
    group1:
      title: group1
      enum:
      - dwa
      - infrastructure
      - packet
      - packet_infrastructure
      - tdm
      type: string
      description: (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
    group6:
      title: group6
      enum:
      - dwa
      - infrastructure
      - packet
      - packet_infrastructure
      - tdm
      type: string
      description: FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
    group41:
      title: group41
      enum:
      - dwa
      - infrastructure
      - packet
      type: string
      description: FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4<li>infrastructure for all FRE-APs representing forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level FREs in ETHERNET including infrastructure</ul>
    Identifiers2:
      title: Identifiers2
      type: object
      properties:
        type:
          type: string
          description: type of network construct, shelf, networkElement, osrpNode
        ncId:
          type: string
          description: Network construct id
        ncExpectationId:
          type: string
          description: Network construct expectation id.What about multiple expectations for a NC?
    include1:
      title: include1
      enum:
      - expectations
      - physicalLocation
      - parentNetworkConstruct
      - networkConstructDiscovered
      - networkConstructPlanned
      type: string
      description: 'List of comma separated resources to be side-loaded. The allowed values are: expectations, physicalLocation, parentNetworkConstruct, networkConstructDiscovered, networkConstructPlanned'
    InstalledSpec:
      title: InstalledSpec
      type: object
      properties:
        hardwareVersion:
          type: string
          description: The hardware version
        serialNumber:
          type: string
          description: The serial number
        manufacturer:
          type: string
          description: The manufacturer
        type:
          type: string
          description: The type of equipment
        partNumber:
          type: string
          description: The part number
        version:
          type: string
          description: The software version
        displayLabels:
          $ref: '#/components/schemas/DisplayLabels'
        additionalAttributes:
          $ref: '#/components/schemas/AdditionalAttributes1'
    Location2:
      title: Location2
      type: object
      properties:
        baynum:
          type: string
        mcId:
          type: string
          description: chcIdx of NMCC AID
        port:
          type: string
        shelf:
          type: string
        slot:
          type: string
        subport:
          type: string
        subslot:
          type: string
    lqsData.fiber.method1:
      title: lqsData.fiber.method1
      enum:
      - totalPower
      - osc
      type: string
      description: (Optional) Allow filtering on the LQS fiber method. This parameter accepts a list of comma separated values
    lqsData.fiber.reconciled1:
      title: lqsData.fiber.reconciled1
      enum:
      - 'true'
      - 'false'
      type: string
      description: (Optional) The LQS fiber reconciled state
    lqsData.margin.valid1:
      title: lqsData.margin.valid1
      enum:
      - 'true'
      - 'false'
      type: string
      description: (Optional) The LQS margin validity state
    lqsData.status1:
      title: lqsData.status1
      enum:
      - good
      - high
      - low
      - upgrade
      type: string
      description: (Optional) Allow filtering on the LQS status. This parameter accepts a list of comma separated values
    MaxValue1:
      title: MaxValue1
      required:
      - value
      type: object
      properties:
        value:
          type: number
          description: the value that if the parameter goes above will trigger the alert
    method11:
      title: method11
      enum:
      - PATCH
      - PUT
      type: string
      description: The HTTP method for the resource operation to be validated against
    method21:
      title: method21
      enum:
      - PATCH
      - PUT
      - DELETE
      type: string
      description: The HTTP method for the resource to be validated against
    MinValue1:
      title: MinValue1
      required:
      - value
      type: object
      properties:
        value:
          type: number
          description: the value that if the parameter goes below will trigger the alert
    networkConstruct.id.operator1:
      title: networkConstruct.id.operator1
      enum:
      - or
      - and
      type: string
      description: (Optional) The logical operator to use when searching Network Construct identifiers
    networkConstruct.id.operator2:
      title: networkConstruct.id.operator2
      enum:
      - or
      - and
      type: string
      description: (Optional) The logical operator to use when searching Network Construct identifier
    networkConstruct.idQualifier1:
      title: networkConstruct.idQualifier1
      enum:
      - or
      - and
      type: string
      description: (Optional) The logical operator to use when searching Network Construct identifiers
    NetworkConstructExpectations:
      title: NetworkConstructExpectations
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/relationshipData'
          description: The one-to-many relationship
    networkConstructType31:
      title: networkConstructType31
      enum:
      - networkElement
      - shelf
      - osrpNode
      type: string
      description: (Optional) Network Construct type
    NetworkElements2:
      title: NetworkElements2
      required:
      - facilityType
      - networkElementList
      type: object
      properties:
        facilityType:
          $ref: '#/components/schemas/FacilityType'
        networkElementList:
          type: array
          items:
            type: string
          description: The list of network elements from which to query all SDMON or CHMON or OPM facilities.
    networkRole31:
      title: networkRole31
      enum:
      - IFRE
      - FREAP
      - FREhAP
      - ROADMLINE
      - IFRECP
      type: string
      description: (Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
    networkRole41:
      title: networkRole41
      enum:
      - IFRE
      - FREAP
      - ROADMLINE
      - IFRECP
      type: string
      description: (Optional) Determines if the FRE participates in an internal or external forwarding view or involves access points or connection points
    operation21:
      title: operation21
      enum:
      - manualSwitchToWork
      - manualSwitchToProtect
      - forcedSwitchToWork
      - forcedSwitchToProtect
      - clear
      - clearProtect
      type: string
      description: Controller operation
    operation41:
      title: operation41
      enum:
      - revert
      - regroom
      - makeCurrentToHome
      - addProtection
      - removeProtection
      - resize
      - updateHomePreemptionLevel
      - updateRestorationPreemptionLevel
      type: string
      description: FRE operation
    osTypeString1:
      title: osTypeString1
      enum:
      - ccStatus
      - lspOperationalStatus
      - pwOperationalStatus
      - tdmStatus
      type: string
      description: Type of operational status
    OtdrApiV1EntitiesRequest:
      title: OtdrApiV1EntitiesRequest
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters'
    OtdrApiV1ProfileRequest:
      title: OtdrApiV1ProfileRequest
      type: object
      properties:
        description:
          type: string
          description: Supports alphanumeric characters, space, hyphen and underscore only.
          default: '2000'
        passwd:
          type: string
          description: Supports any character except single/double quotes and @ symbol.
          default: password
        user_name:
          type: string
          description: Supports any character except single/double quotes and @ symbol.
          default: admin
        port:
          type: string
          default: '22'
        profile_name:
          type: string
          description: Supports alphanumeric characters and underscore only.
          default: test
        location:
          type: string
          default: /temp
        ip_address:
          type: string
          default: 1.1.1.1
        protocol_type:
          type: string
          default: sftp
    OtdrApiV1SorParseRequest:
      title: OtdrApiV1SorParseRequest
      required:
      - file_names
      type: object
      properties:
        file_names:
          type: array
          items:
            type: string
          description: ''
    OtdrApiV1SordownloadRequest:
      title: OtdrApiV1SordownloadRequest
      type: object
      properties:
        trace_id:
          type: string
          default: OTDRCFG-1-1-8
        trace_tag:
          type: string
          default: current
        trace_type:
          type: string
          default: long
    OtdrApiV1SortracesRequest:
      title: OtdrApiV1SortracesRequest
      required:
      - network_construct_id
      - trace_id
      - file_name
      - label
      type: object
      properties:
        network_construct_id:
          type: string
          description: Identifier of the Network Construct
        trace_id:
          type: string
          description: OTDR entity id
        file_name:
          type: string
          description: SOR Trace file name
        label:
          type: string
          description: Label for SOR Trace file
    OtdrApiV1TraceprofilesRequest:
      title: OtdrApiV1TraceprofilesRequest
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters3'
    OtdrApiV2SordownloadRequest:
      title: OtdrApiV2SordownloadRequest
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters1'
    OtdrApiV1EntitiesRequest1:
      title: OtdrApiV1EntitiesRequest1
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/Parameters2'
    physicalNeName.operator1:
      title: physicalNeName.operator1
      enum:
      - or
      - and
      type: string
      description: (Optional) The logical operator to use when searching Network Construct name
    Planning:
      title: Planning
      type: object
      properties:
        id:
          type: string
          description: This field maps to the project id field in the RPT. This identifier is used by commissioning to retrieve auto-slat data from RPT.
        name:
          type: string
          description: This field maps to the project name field in the RPT.
    PollingInterval:
      title: PollingInterval
      required:
      - unit
      - value
      type: object
      properties:
        unit:
          $ref: '#/components/schemas/Unit1'
        value:
          type: number
    PollingSettings:
      title: PollingSettings
      type: object
      properties:
        pollingIntervalMs:
          type: integer
          description: Polling interval in milliseconds
          format: int64
        immediateDeletion:
          type: boolean
          description: Whether the deletion is considered done when the API returns
        deletePollingIntervalMs:
          type: integer
          description: Polling interval for delete verification
          format: int64
        deletePollingLimit:
          type: integer
          description: Maximum number of delete verification polling
          format: int32
        delayCreateTimeoutMs:
          type: integer
          description: Timeout value for a delayed creation to be considered failed
          format: int64
        syncTimeoutMs:
          type: integer
          description: Timeout for sync and queries
          format: int64
        verifyMissingList:
          type: boolean
          description: Whether an extra GET will be called to verify a missing resource in LIST
    preemptiveSync1:
      title: preemptiveSync1
      enum:
      - IN
      - OUT
      - ALL
      type: string
      description: Instruction to execute as background tasks pre-emptive sync of adjacent timing nodes based on port types IN, OUT or ALL (default no execution)
    ProfileType11:
      title: ProfileType11
      enum:
      - backup_restore
      - upgrade
      type: string
      description: The NE Maintenance profiles by profile type to be retrieved.
    ProtocolType11:
      title: ProtocolType11
      enum:
      - cli
      - tl1
      - netconf
      type: string
      description: Protocol type of the custom scripts
    ProtocolType12:
      title: ProtocolType12
      enum:
      - cli
      - tl1
      - netconf
      type: string
      description: Protocol type of the custom script file
    ProvisionedSpec:
      title: ProvisionedSpec
      type: object
      properties:
        hardwareVersion:
          type: string
          description: The hardware version
        serialNumber:
          type: string
          description: The serial number
        manufacturer:
          type: string
          description: The manufacturer
        type:
          type: string
          description: The type of equipment
        partNumber:
          type: string
          description: The part number
        version:
          type: string
          description: The software version
        displayLabels:
          $ref: '#/components/schemas/DisplayLabels'
        additionalAttributes:
          $ref: '#/components/schemas/AdditionalAttributes1'
    Range3:
      title: Range3
      required:
      - type
      type: object
      properties:
        endTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/requestTypeEnum'
        unit:
          $ref: '#/components/schemas/timeUnitEnum'
        value:
          maximum: 2147483646
          minimum: 1
          type: integer
          format: int32
    Relationships3:
      title: Relationships3
      type: object
      properties:
        networkConstruct:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        equipmentHolder:
          $ref: '#/components/schemas/OneToOneRelationshipRo1'
        equipmentExpectations:
          $ref: '#/components/schemas/EquipmentExpectations'
    Relationships12:
      title: Relationships12
      type: object
      properties:
        children:
          $ref: '#/components/schemas/Children'
        parent:
          $ref: '#/components/schemas/Parent'
    RequestScope:
      title: RequestScope
      required:
      - domainId
      type: object
      properties:
        domainId:
          type: string
        resourceTypeId:
          type: string
        providerResourceId:
          type: string
    Resolution:
      title: Resolution
      required:
      - unit
      - value
      type: object
      properties:
        unit:
          $ref: '#/components/schemas/Unit1'
        value:
          type: number
    resourceType71:
      title: resourceType71
      enum:
      - fres
      type: string
      description: 'Allowed value : fres'
    searchType1:
      title: searchType1
      enum:
      - wildCard
      - match
      - matchCase
      type: string
      description: '(Optional) Specify the matching criteria for searchText. <ul><li>wildCard: Return all FREs which contain the searchText and is case insensitive<li>match: Return all FREs that matches the exact word from searchText field and is case insensitive<li>matchCase: Return all FREs that matches the exact word from searchText field and is case sensitive</ul>'
    Server2:
      title: Server2
      required:
      - id
      - type
      type: object
      properties:
        id:
          type: string
          description: The node ID, is a ManagementSessionId from a 6500, used in alarm to service correlation
        type:
          type: string
          description: The node type. E.g. 6500
    serviceClass51:
      title: serviceClass51
      enum:
      - EVC
      - ETransit
      - EAccess
      - VLAN
      - TDM
      - Transport Client
      - Photonic
      - Tunnel
      - IP
      - LLDP
      - LAG
      - OTU
      - ROADM Line
      - Fiber
      - SNC
      - OSRP Link
      - OSRP Line
      - SNCP
      - L3VPN
      type: string
      description: (Optional) Allow filtering on the FRE service class. This parameter accepts a list of comma separated values
    SignalIndex12:
      title: SignalIndex12
      required:
      - index_name
      - index_value
      type: object
      properties:
        index_name:
          $ref: '#/components/schemas/IndexName'
        index_value:
          type: string
          description: Value of the signal index
    SiteActivation2:
      title: SiteActivation2
      type: object
      properties:
        taskType:
          $ref: '#/components/schemas/task_type'
        status:
          $ref: '#/components/schemas/task_status'
        startTime:
          type: string
          description: The time at which the task was started
        duration:
          type: string
          description: The elapsed time of the task
        progress:
          type: string
          description: The progress of the task, e.g. step 3 of 8
        currentStepNum:
          type: string
          description: The number of the current task step
        currentStep:
          type: string
          description: The name of the current step
        previousStep:
          type: string
          description: The name of the previous step
        error:
          type: string
          description: The error in event of failure
    SiteRecovery:
      title: SiteRecovery
      type: object
      properties:
        taskType:
          $ref: '#/components/schemas/task_type'
        status:
          $ref: '#/components/schemas/task_status'
        startTime:
          type: string
          description: The time at which the task was started
        duration:
          type: string
          description: The elapsed time of the task
        progress:
          type: string
          description: The progress of the task, e.g. step 3 of 8
        currentStepNum:
          type: string
          description: The number of the current task step
        currentStep:
          type: string
          description: The name of the current step
        previousStep:
          type: string
          description: The name of the previous step
        error:
          type: string
          description: The error in event of failure
    state261:
      title: state261
      enum:
      - executing
      - suspended
      type: string
      description: Optional query parameter to filter to only executing or suspended jobs
    SubmarineApiV1SrsCommitCableSystemRequest:
      title: SubmarineApiV1SrsCommitCableSystemRequest
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data23'
    SubmarineApiV1SrsConfigUbmd2LossRequest:
      title: SubmarineApiV1SrsConfigUbmd2LossRequest
      type: object
      properties:
        ncId:
          type: string
          description: ncId of the network element..
        facilityAid:
          type: string
          description: Facility
        txLoss:
          type: string
          description: Tx loss in db
        rxLoss:
          type: string
          description: Rx loss in db
    SubmarineApiV1SrsScanRepeatersRequest:
      title: SubmarineApiV1SrsScanRepeatersRequest
      type: object
      properties:
        facilityAid:
          type: string
          description: Facility AID of the repeater system on which scan need to be initiated.
        label:
          type: string
          description: scan label.
    SubmarineApiV1SrsScanThresholdRequest:
      title: SubmarineApiV1SrsScanThresholdRequest
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data21'
          description: ''
    SubmarineApiV1SrsScheduleScanRequest:
      title: SubmarineApiV1SrsScheduleScanRequest
      type: object
      properties:
        repeaterAID:
          type: string
          default: OTM2-0-0
        attributes:
          $ref: '#/components/schemas/Attributes21'
    supportedByQualifier1:
      title: supportedByQualifier1
      enum:
      - one
      - all
      type: string
      description: (Optional) Used in conjunction with supportedByFreId and controls if only one-level (default) or all parent FREs with a serviceClass are returned
    testType11:
      title: testType11
      enum:
      - benchmark
      - cfmLinktrace
      - cfmLoopback
      - loopback
      - clientPortLoopback
      - lspPing
      - lspTraceroute
      - tdmLoopback
      - pwPing
      - raceTrack
      - testSet
      - networkMode
      - Vrf Ping
      - SrTunnelPing
      type: string
      description: Optional, test type
    tpe.id.operator1:
      title: tpe.id.operator1
      enum:
      - or
      - and
      type: string
      description: (Optional) The logical operator to use when searching tpeIds
    tpeIdQualifier1:
      title: tpeIdQualifier1
      enum:
      - or
      - and
      type: string
      description: (Optional) The logical operator to use when searching tpeIds
    ts1:
      title: ts1
      enum:
      - ms
      - rfc3339
      type: string
      description: Determines format of timestamp in response. Either milliseconds or RFC3339 formatted timestamp.
    type1331:
      title: type1331
      enum:
      - ROADM
      - COADM
      - DIAOADM
      - SLOTSEQUENCE
      - OTS
      - OTNBBPAIRING
      type: string
      description: (Optional) Equipment group type.
    type1361:
      title: type1361
      enum:
      - hard
      - soft
      type: string
      description: The type of recovery to perform. 'hard' purges all data from the recovered site and re-syncs all data; 'soft' retains and reconciles the data on the recovered site.
    units1:
      title: units1
      enum:
      - SNR total [dB]
      - SNR ASE [dB]
      - SNR NLI [dB]
      - NSR total [mw/mW]
      - NSR ASE [mw/mW]
      - NSR NLI [mw/mW]
      type: string
      description: units of SNR
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    basic:
      type: apiKey
      name: Authorization
      in: header
security: []
tags:
- name: Alarms service information
- name: Retrieve and modify alarms (version 1)
- name: Retrieve and modify alarms (version 2)
- name: Search and filter alarms (version 1)
- name: Search and filter alarms (version 2)
- name: nsa-correlationapiv1correlation
  description: nsa correlation
- name: areas
  description: Asset areas are Git repositories where definitions may be onboarded and accessed
- name: keys
  description: SSH keys authorized for Git access
- name: ping
  description: Asset manager interface to check for readiness
- name: audit logs
  description: Export, Delete audit logs
- name: Retrieves a specific testType
- name: Retrieves and creates auditTargets
- name: Retrieves auditProfiles
- name: Retrieves, creates, updates and deletes audits
- name: Backup Schedule Rest Service V2
- name: Backup Service API V1
- name: Backup Settings Rest Service V2
- name: Backup Snapshot Rest Service V2
- name: Scripts Management
  description: Manage commissioning scripts for shelf and its related equipment projects
- name: Equipment Commissioning
  description: Commission an equipment and its topologies
- name: Policy Management
  description: Manage policies required for commissioning
- name: Policy Defaults Management
  description: Manage default values for each policy
- name: IP Subnet Management
  description: Allocate IPv4 and IPv6 subnet
- name: IPv4 Subnet Management
  description: Allocate IPv4 subnet address for shelf
- name: Reserved IPAddress Management
  description: Load Reserved IPAddress for the Interface
- name: Deployed Network IPv4 Management
  description: Manage deployed IPv4 address for shelf
- name: Retrieval of IPAdress Management
  description: Retrieve IPAddress from given subnet or tid
- name: Service Management
  description: Perform provisioning of services
- name: User Access Privileges Management
  description: Determine 6500 User Access Privileges
- name: Deployment data
  description: Deployment data for the planning project
- name: Configuration Resource v1
  description: Creation, deletion and retrieval of configuration properties
- name: configuration Resource
  description: Creation, deletion and retrieval of configuration properties<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version.WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: Alarm to Service Query
  description: Find related services for alarms
- name: Service to Alarm Query
  description: Find related alarms for services
- name: Debug
  description: Modify logging or elastic search client configuration
- name: credentials
  description: Add credentials for BPI commands
- name: 000 - nsiapiequipment
  description: Retrieve, plan, and manage the equipment resources.<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 994 - nsiapiv6equipment
  description: Retrieve, plan, and manage the equipment resources (version 6).
- name: 995 - nsiapiv5equipment
  description: Retrieve, plan, and manage the equipment resources (version 5).
- name: 996 - nsiapiv4equipment
  description: Retrieve, plan, and manage the equipment resources (version 4).
- name: 997 - nsiapiv3equipment
  description: Retrieve, plan, and manage the equipment resources (version 3).
- name: 998 - nsiapiv2_0equipment
  description: Retrieve, plan, and manage the equipment resources (version 2)
- name: 000 - nsiapiequipmentGroups
  description: Retrieve, plan, and manage the equipment group resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 997 - nsiapiv3equipmentGroups
  description: Retrieve, plan, and manage the equipment group resources (version 3)
- name: 998 - nsiapiv2_0equipmentGroups
  description: Retrieve, plan, and manage the equipment group resources (version 2)
- name: 000 - nsiapiequipmentHolders
  description: Retrieve and manage the equipment holder resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 997 - nsiapiv3equipmentHolders
  description: Retrieve and manage the equipment holder resources (version 3)
- name: 998 - nsiapiv2_0equipmentHolders
  description: Retrieve and manage the equipment holder resources (version 2)
- name: CLIENT PORT Operations
  description: create/enable/disable/delete of Client Port
- name: CLIENT PORT Operations v1
  description: create/enable/disable/delete of Client Port (version 1)
- name: Equipment Intents
  description: Plan equipment, apply planned equipment, or remove planned equipment<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version.WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: Equipment Intents v1
  description: Plan equipment, apply planned equipment, or remove planned equipment (version 1) - deprecated
- name: Equipment Intents v2
  description: Plan equipment, apply planned equipment, or remove planned equipment (version 2)
- name: Equipment Intents v3
  description: Plan equipment, apply planned equipment, or remove planned equipment (version 3)
- name: Equipment State
  description: Update equipment state
- name: Equipment State v1
  description: Update equipment state
- name: REGEN PORTS
  description: Update/Retrieval of Regen Port information
- name: REGEN PORTS v1
  description: Update/Retrieval of Regen Port information (version 1)
- name: Updated Expectations Resource
  description: Retrieval of updated expectations for a given intent id
- name: Updated Expectations Resource v1
  description: Retrieval of updated expectations for a given intent id
- name: controller Parameters Setting
  description: Addition/Retrieval of controllerParametersSetting information
- name: controller Parameters Setting v1
  description: Addition/Retrieval of controller Parameters Setting information (version 1)
- name: 000 - nsiapiequipmentStaticSpecs
  description: Retrieve, plan, and manage the equipment static spec resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 996 - nsiapiv1equipmentStaticSpecs
  description: Retrieve, plan, and manage the equipment static spec resources (version 1).
- name: bootstrap
  description: Configure the site parameters (site ID and ACTIVE / STANDBY state)
- name: site-status
  description: Retrieve site status, perform failover (activate a standby site)
- name: site-remotes
  description: Configure, query, and delete remote sites
- name: site-summary
  description: Retrieve the site status of all sites, including local site, remote sites, and previously active sites
- name: cluster-status
  description: Configure and query application specific parameters for the local site
- name: cluster-remote-status
  description: Query application specific parameters for the remote site
- name: resync
  description: Request a resync of application data from the active site
- name: activation
  description: Request to sever the GR connection and make the standby site active
- name: sync-status
  description: Query application specific diagnostic information
- name: geo-clean
  description: Remove IPSec tunnel configuration
- name: config
  description: Fetch, Create and Modify Configurations
- name: config_v2
  description: Fetch Configurations
- name: 000 - nsiapigroups
  description: Retrieve, plan, and manage the group resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 999 - nsiapiv3groups
  description: Retrieve, and manage the group resources V3.
- name: inventory-historyv1query
- name: 000 - nsiapisearch
  description: Search inventory resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 998 - nsiapiv2search
  description: Search inventory resources (version 2)
- name: 999 - nsiapiv1search
  description: Search inventory resources (version 1)
- name: SRLG
- name: equipment
- name: equipmentGroups
- name: fres
- name: groups
- name: networkConstructs
- name: tpes
- name: Socket
  description: Kafka websocket connections
- name: Clients
- name: Features
- name: Licenses
- name: Load License file to license server
- name: Register
- name: Reports
- name: Status
- name: application-slices
  description: Application slices that subdomains can associate with
- name: domain-types
  description: Types of domains or systems exposing orchestration entities
- name: domains
  description: Organizational units managing products and resources
- name: jobs
  description: Jobs for execution
- name: products
  description: Offerings to instantiate a resource type in a domain
- name: relationships
  description: Relationships are connections between resources
- name: resource-providers
  description: Providers of domains and resources
- name: resource-types
  description: Resource type schema definitions
- name: resources
  description: Resource instances
- name: resyncs
  description: Resync calls to the southbound
- name: sharing-permissions
  description: Sharing permissions
- name: sub-domains
  description: Subdomain instances that associate resources with application-slices
- name: tag-keys
  description: Tag key/values used to label resources
- name: tenants
  description: Tenants for managing resources
- name: type-artifacts
  description: All schema information including resource types and service templates
- name: 000 - configmgmtapiv1bulkOperations
  description: Carry out operations in bulk
- name: Batch Management v1
  description: Manage Batch of Network Elements
- name: Batch Management v2
  description: Manage Batch of Network Elements
- name: Commissioning Functions v1
  description: Manage Commissioning Functions
- name: Commissioning Profiles v1
  description: Manage Commissioning Profiles
- name: Commissioning v1
  description: Commissioning Resource
- name: Configuration Details v1
  description: Information of Configuration Management Operation
- name: Create BFD session v1
  description: Multihop BFD session management
- name: Create?EditDelete a LAG and addremove LAG members.
- name: CreateEdit BGP session v1
  description: BGP session management
- name: CreateUpdateDelete Parent Policer v1
  description: Manage Parent Policer
- name: Custom Scripts v1
  description: Manage Custom Scripts
- name: Custom Scripts v2
  description: Manage Custom Scripts
- name: DOC v1
  description: Manages DOC configuration of NEs
- name: Download v1
  description: Download Ne Backups
- name: Fallback Users v1
  description: Manage Fallback Users
- name: Indexing
  description: Manage ReIndexing
- name: Managing Packet resources v1
  description: Operations to manage packet resources
- name: Network Element Backup v1
  description: Backup for network element
- name: Network Element Configuration Job Management v1
  description: Manage network element configuration jobs
- name: Network Element Restore v1
  description: Network element Restore
- name: Network Elements Maintenance Details Resource v1
  description: Details of Network elements maintenance
- name: Network Elements Upgrade Details Resource v1
  description: Network elements upgrade details
- name: Port Provisioning v1
  description: 'Port Provisioning '
- name: Profiles v1
  description: Manage Configuration NE Maintenance Profiles
- name: Profiles v2
  description: Manage Configuration NE Maintenance Profiles
- name: Provision BGP nodal commissioning
  description: BGP nodal commissioning
- name: Queue provisioning.
- name: Schedule Management v1
  description: Manage schedules of Network Elements
- name: Scheduls Assign NE v1
  description: Scheduls Assign NE v1
- name: Script Execution Details v1
  description: 'View script Execution Details '
- name: Script Management v1
  description: Manage Configuration Management Script
- name: Script Profiles v1
  description: Manage Script Profiles
- name: Script Profiles v2
  description: Manage Script Profiles
- name: Upgrade operation v1
  description: Upgrade information of the NEs
- name: Upgrade operations v1
  description: Upgrade operations V1
- name: transport resources v1
  description: Manage Transport Resources
- name: vpn resources v1
  description: Manage vpn resources
- name: neprofiles
  description: Provision connection parameters for network elements (management sessions)<p>This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: neprofiles v1
  description: Provision connection parameters for network elements (management sessions)
- name: neprofiles v2
  description: Provision connection parameters for network elements (management sessions)
- name: managementSessions
  description: Enroll, resync, de-enroll and retrieve the management sessions that represent the connections to the network elements<p>This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: managementSessions v3
  description: Enroll, resync, de-enroll and retrieve the management sessions that represent the connections to the network elements
- name: managementSessions v4
  description: Enroll, resync, de-enroll and retrieve the management sessions that represent the connections to the network elements
- name: 000 - nsiapinetworkConstructs
  description: Retrieve, plan, and manage the network construct resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 994 - nsiapiv6networkConstructs
  description: Retrieve, plan, and manage the network construct resources (version 6)
- name: 995 - nsiapiv5networkConstructs
  description: Retrieve, plan, and manage the network construct resources (version 5)
- name: 996 - nsiapiv4networkConstructs
  description: Retrieve, plan, and manage the network construct resources (version 4)
- name: 997 - nsiapiv3networkConstructs
  description: Retrieve, plan, and manage the network construct resources (version 3)
- name: 000 - nsiapiphysicalLocations
  description: Retrieve, and manage the physical location resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 996 - nsiapiv4physicalLocations
  description: Retrieve, and manage the physical location resources V4.
- name: 997 - nsiapiv3physicalLocations
  description: Retrieve, and manage the physical location resources V3.
- name: 998 - nsiapiv2_0physicalLocations
  description: Retrieve, and manage the physical location resources (version 2)
- name: TimingNodeV1
- name: Cards
- name: Reporting
- name: SFTP
- name: Scheduling
- name: Snapshots
- name: Trends
- name: TrendsV2
- name: sftp
- name: OTDR entities
  description: 'Retrieve, start/stop trace and edit the OTDR entities '
- name: OTDR SOR tracelist
  description: 'Retrieve SOR trace list associated with an OTDR entity '
- name: OTDR spanlength
  description: 'Retrieve the length of the span associated with an OTDR entity '
- name: OTDR SOR download v1
  description: 'SFTP the SOR file to a specified location '
- name: OTDR SOR download v2
  description: SFTP the SOR file to a specified location
- name: SOR download profiles
  description: 'Create, Retrieve, Update and Delete the SOR download profiles '
- name: OTDR trace profiles
  description: Create, Retrieve, Update and Delete the OTDR trace profiles
- name: OTDR Saved SOR traces
  description: Retrieve, Update or Delete the SOR traces saved in MCP
- name: OTDR Parse SOR traces
  description: Retrieve parsed SOR trace files saved in MCP
- name: cmgapi
  description: Retrieve the channel margin gauge data.<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs
- name: cmgapiV1
  description: Retrieve the channel margin gauge data (Version 1).
- name: cmgapiV2
  description: Retrieve the channel margin gauge data (Version 2).
- name: fiberloss
  description: Retrieve the fiber loss data.<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs
- name: fiberlossV1
  description: Retrieve the fiber loss data (Version 1).
- name: fiberlossV2
  description: Retrieve the fiber loss data (Version 2).
- name: fiberlossV3
  description: Retrieve the fiber loss data (Version 3).
- name: ppgapi
  description: Retrieve the photonic performance gauge data.<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs
- name: ppgapiV1
  description: Retrieve the photonic performance gauge data (Version 1).
- name: resetchannelmarginV1
  description: Reset channel margin data (Version 1).
- name: resetppgdataV1
  description: Reset photonic performance gauge data (Version 1).
- name: Facilities
  description: Reset a collection facility
- name: Real-Time
  description: Retrieve real-time performance metrics
- name: Historical_v1
  description: Search and filter historical performance metrics
- name: Historical_v2
  description: Search and filter historical performance metrics
- name: Historical_v3
  description: Search and filter historical performance metrics
- name: OssQuery_v1
  description: Search and filter historical performance metrics for oss system
- name: Correlated_v1
  description: Search and filter historical performance metrics, correlated based on facility (used for SDMON, CHMON and OPM metrics)
- name: RollupCalculation_v1
  description: Search and filter historical performance metrics, do rollup calculation using the 15 minute bin based on the start and end time
- name: Meta_v2
  description: Metadata for historical performance metrics
- name: Collections_v2
  description: Configure collection intervals and resolution for individual or groups of devices
- name: Collections_v3
  description: Configure collection intervals and resolution for individual or groups of devices
- name: Auto-Complete
  description: Search for all possible values that exist for certain tags
- name: Locations
  description: Get all possible location fields for performance metrics
- name: pinpointapiv1activetraces
  description: Retrieve, manage active trace resource
- name: pinpointapiv1fiberpaths
  description: Retrieve, manage fiberpath resource
- name: pinpointapiv1kml
  description: Retrieve, manage kml resource
- name: pinpointapiv1nes
  description: Retrieve, manage network element resource
- name: pinpointapiv1others
  description: Create spool/waypoint resource
- name: pinpointapiv1sor
  description: Retrieve, manage sor trace resource
- name: Derived Metrics
  description: Derive Metrics from existing ones
- name: Thresholds
  description: Create, update, and delete thresholds
- name: Threshold Groups
  description: Create, update, and delete threshold groups
- name: Resource Profiles
  description: Create, update, and delete resource profiles
- name: conditions
  description: Determine applicability of policies
- name: ping
  description: Policy manager interface to check for readiness
- name: policies
  description: Authorization and event policies
- name: realms
  description: Defines the component scope to which policies apply
- name: 000 - nsiapitpes
  description: Retrieve, plan, and manage the tpe resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 994 - nsiapiv6tpes
  description: Retrieve, plan, and manage the tpe resources (version 6)
- name: 995 - nsiapiv5tpes
  description: Retrieve, plan, and manage the tpe resources (version 5)
- name: 996 - nsiapiv4tpes
  description: Retrieve, plan, and manage the tpe resources (version 4)
- name: 997 - nsiapiv3tpes
  description: Retrieve, plan, and manage the tpe resources (version 3)
- name: 998 - nsiapiv2_0tpes
  description: Retrieve, plan, and manage the tpe resources (version 2).
- name: Problems
- name: 000 - reportingapiv1report
  description: Create/Delete/Fetch, different reports.
- name: 000 - reportingapiv1schedule
  description: Create/Delete/Fetch a schedule for different report type, So that report can be generated at a specific schedule.
- name: 000 - reportingapiv2report
  description: Create/Delete/Fetch, different reports.
- name: 000 - reportingapiv2schedule
  description: Create/Delete/Fetch schedules for report generation. Supports both one time and recurring schedules.
- name: 000 - nsiapicontrollers
  description: Retrieve, plan, and manage the controller resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 995 - nsiapiv2controllers
  description: Retrieve, plan, and manage the controller resources (version 2).
- name: 996 - nsiapiv1controllers
  description: Retrieve, plan, and manage the controller resources (version 1).
- name: RaController V1
  description: Provides data about managed RA instances.
- name: smoapiv1smoProjects
- name: smoapiv1smoServices
- name: Service Intents
  description: Creation, deletion and retrieval of intended L0 (CD Fixed) services<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version.WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: Service Intents v1
  description: Creation, deletion and retrieval of intended L0 (CD Fixed) services (version 1)
- name: Service Intents v2
  description: Creation, deletion and retrieval of intended L0 (CD Fixed) services (version 2)
- name: Service provisioning (flex)
- name: mcp-view v2
- name: mcp-view v1
- name: 000 - nsiapifres
  description: Retrieve, plan, and manage the fre resources<p/>&nbsp;&nbsp;&nbsp;&nbsp;This non-versioned API is meant for use by an end-user as a pass-through to the latest version. WARNING - backwards compatibility is not guaranteed for non-versioned APIs.
- name: 994 - nsiapiv6fres
  description: Retrieve, plan, and manage the fre resources (version 6)
- name: 994 - nsiapiv7fres
  description: Retrieve, plan, and manage the fre resources (version 7)
- name: 995 - nsiapiv5fres
  description: Retrieve, plan, and manage the fre resources (version 5)
- name: 996 - nsiapiv4fres
  description: Retrieve, plan, and manage the fre resources (version 4)
- name: 997 - nsiapiv3fres
  description: Retrieve, plan, and manage the fre resources (version 3)
- name: 998 - nsiapiv2_0fres
  description: Retrieve, plan, and manage the fre resources (version 2)
- name: overlay
- name: slv-supportapiv1equipmentGraphics
  description: Manage the retrieval of equipment graphics
- name: slv-supportapiv1equipmentLayout
  description: Manage the retrieval of equipment layouts
- name: slv-supportapiv1shelfGraphics
  description: Manage the retrieval of shelf graphics
- name: slv-supportapiv1shelfLayouts
  description: Manage the retrieval of shelf layouts
- name: SRLG
  description: Storing/Retrieving of SRLG information on fres/networkConstructs/equipments/tpes
- name: SRLG Jobs
  description: Retrieving/managing SRLG Jobs
- name: SRLG Jobs V3
  description: Retrieving/managing SRLG Jobs
- name: SRLG Schedules
  description: Scheduling of SRLG operations
- name: SRLG Schedules v3
  description: Scheduling of SRLG operations
- name: SRLG v1
  description: storing of SRLG information on roadmlines
- name: SRLG v2
  description: Storing/Retrieving of SRLG information on fres/networkConstructs/equipment/tpes
- name: SRLG v3
  description: SRLG specific operations.
- name: 997 - nsiapisrlgformat
  description: Retrieve, plan, and manage the SrlgFormats resources.
- name: 997 - nsiapiv3srlgformat
  description: Retrieve, plan, and manage the SrlgFormats resources (version 3).
- name: 997 - nsiapiv4srlgformat
  description: Retrieve, plan, and manage the SrlgFormats resources (version 4).
- name: 997 - nsiapisrlgpool
  description: Assign and release srlg to/from External Pool.
- name: 997 - nsiapiv1srlgpool
  description: Assign and release srlg to/from External Pool.
- name: Manage repeaters scan
  description: Starts a new submarine Repeater Scan
- name: History scans
  description: Get history scans
- name: Schedule scans
  description: Schedule a Scan
- name: Configuration loss
  description: Get configuration loss
- name: Set baseline scan
  description: Set baseline scan
- name: Import
  description: Import scan data, cable system, slte system, repeater system files. Delete repeater system, slte system and cable system files
- name: Export
  description: Export data to file
- name: Cable system Details
  description: Get cable system logical view, attributes and repeaters
- name: Commit / Cleanup cable system configuration
  description: Commit / Cleanup cable system configuration for a customer
- name: Trend view
  description: Trend view of scan
- name: Wetplant Components
  description: Get the Wetplant component's optical power details
- name: Spectrum Sharing
  description: Get the spectrum sharing terminals and details of a specific terminal
- name: Provision Spectrum
  description: Provision spectrum for a customer
- name: Spectrum Facility
  description: Get Nmcc facility details and update switch selector
- name: tdcapiv1configProperties
  description: Manage the test and diagnostics configuration properties
- name: tdcapiv1diagfiberloss
  description: Retrieves fiber loss data
- name: tdcapiv1diagpmsprfbers
  description: Test Pre-FEC (Forward Error Correction) Bit Error Rate
- name: tdcapiv1diagspectral
  description: Retrieves spectral data
- name: tdcapiv1operationalStatus
  description: Retrieves operational status
- name: tdcapiv1pageLoad
  description: Perform testing operations
- name: tdcapiv1tests
  description: Perform testing operations
- name: tdcapiv1testsits
  description: Perform Integrated Test Set Configuration related operations
- name: tdcapiv2diagoperMeas
  description: Retrieve or Reset Operational Measurements for a service
- name: Topic Management
- name: Topic Monitoring
- name: Upgrade Rest Service v1
  description: Upgrade Rest Service
- name: Resource to Service Query
  description: ''
- name: AutoSlatData
  description: ''
- name: EqptKitNameMappings
  description: ''
- name: Equipment
  description: ''
- name: EquipmentSummary
  description: ''
- name: EquipmentSummaryV2
  description: ''
- name: FiberRoutes
  description: ''
- name: GlobalConfigurationData
  description: ''
- name: HeatDissipationReport
  description: ''
- name: PlannedDataV2
  description: ''
- name: PlannedDataV3
  description: ''
- name: PlanningPolicy
  description: ''
- name: PostUpgrade
  description: ''
- name: ProjectEquipmentDetails
  description: ''
- name: callback
  description: ''
- name: inheritable
  description: ''
- name: Networks
  description: ''
- name: PlanningProjects
  description: ''
- name: ProjectLists
  description: ''
- name: ProjectListsV1
  description: ''
- name: Service Deploy
  description: ''
- name: Service Undeploy
  description: ''
- name: tapi-connectivity
  description: ''
- name: tapi-connectivity-core
  description: ''
- name: oam
  description: ''
- name: tapi-common
  description: ''
- name: tapi-topology
  description: ''
- name: tapi-equipment
  description: ''
- name: tapi-streaming
  description: ''
- name: tapi-restconf
  description: ''
- name: checkdisk
  description: ''
- name: checkkafka
  description: ''
- name: checkpithos
  description: ''
- name: cleanup
  description: ''
- name: debug
  description: ''
- name: Cable System Details
  description: ''
- name: Delete repeater, slte and cable descriptor files
  description: ''
- name: Add to inventory / Remove from inventory cable system configuration
  description: ''
- name: 'Delete optical power data '
  description: ''
- name: api-keys
  description: ''
- name: applications
  description: ''
- name: auth
  description: ''
- name: current-user
  description: ''
- name: health-check
  description: ''
- name: ldap-configs
  description: ''
- name: login-detail
  description: ''
- name: login-info
  description: ''
- name: login-message
  description: ''
- name: logout
  description: ''
- name: notification-config
  description: ''
- name: oauth2
  description: ''
- name: partitions
  description: ''
- name: passwordpolicies
  description: ''
- name: permissions
  description: ''
- name: radius-configs
  description: ''
- name: register
  description: ''
- name: roles
  description: ''
- name: sessions
  description: ''
- name: tokens
  description: ''
- name: usergroups
  description: ''
- name: users
  description: ''
- name: Cache
  description: ''
- name: ViableRoutes
  description: ''
- name: ViableRoutesV2
  description: ''
- name: Admin
  description: ''
- name: Watchers
  description: ''