@itentialopensource/adapter-ciena_mcp/entities/Fres/schema.json

This adapter integrates with system described as: Ciena Mcp

{
  "$id": "schema.json",
  "type": "object",
  "schema": "http://json-schema.org/draft-07/schema#",
  "translate": true,
  "dynamicfields": true,
  "properties": {
    "ph_request_type": {
      "type": "string",
      "description": "type of request (internal to adapter)",
      "default": "searchFres",
      "enum": [
        "searchFres",
        "searchPostFresV2",
        "getFreById",
        "searchFresV1",
        "getFreByIdV1",
        "searchFresV2",
        "postNsiApiV2SearchFres",
        "getFreByIdV2"
      ],
      "external_name": "ph_request_type"
    },
    "networkConstructId": {
      "type": "string",
      "description": "(Optional) Network Construct identifier",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "networkConstruct\\.id"
    },
    "networkConstructIdOperator": {
      "type": "string",
      "description": "(Optional) The logical operator to use when searching Network Construct identifier",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "networkConstruct\\.id\\.operator"
    },
    "tpeId": {
      "type": "string",
      "description": "(Optional) Comma separated TPE identifiers for endpoints",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "tpe\\.id"
    },
    "tpeIdOperator": {
      "type": "string",
      "description": "(Optional) The logical operator to use when searching tpeIds",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "tpe\\.id\\.operator"
    },
    "physicalNeNameOperator": {
      "type": "string",
      "description": "(Optional) The logical operator to use when searching Network Construct name",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "physicalNeName\\.operator"
    },
    "bookingDataLockout": {
      "type": "string",
      "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 allow...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "bookingData\\.lockout"
    },
    "freExpectationsServiceIntentId": {
      "type": "string",
      "description": "(Optional) The service intent Id. NA results in all Fres with no serviceIntentId. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "freExpectations\\.serviceIntent\\.id"
    },
    "freExpectationsEquipmentIntentId": {
      "type": "string",
      "description": "(Optional) The equipment intent Id. NA results in all Fres with no equipmentIntentId. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "freExpectations\\.equipmentIntent\\.id"
    },
    "freExpectationsIntentId": {
      "type": "string",
      "description": "(Optional) The intent id. NA results in all Fres with no intentId. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "freExpectations\\.intent\\.id"
    },
    "freExpectationsIntentType": {
      "type": "string",
      "description": "(Optional) The intent type. NA results in all Fres with no intentType. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "freExpectations\\.intent\\.type"
    },
    "endpointTpeConcrete": {
      "type": "string",
      "description": "Concrete TPE identifier for endpoints",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "endpoint\\.tpe\\.concrete"
    },
    "lqsDataStatus": {
      "type": "string",
      "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",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.status"
    },
    "lqsDataMarginValid": {
      "type": "string",
      "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",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.margin\\.valid"
    },
    "lqsDataFiberReconciled": {
      "type": "string",
      "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",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.reconciled"
    },
    "lqsDataFiberMethod": {
      "type": "string",
      "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, ...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.method"
    },
    "lqsDataFiberDeltaAvgToPlannedLoss": {
      "type": "string",
      "description": "(Optional) The LQS fiber delta average to planned loss. NA results in all Fres with no lqsFiberDeltaAvgToPlannedLoss. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.deltaAvgToPlannedLoss"
    },
    "lqsDataFiberAvgLoss": {
      "type": "string",
      "description": "(Optional) The LQS fiber average loss. NA results in all Fres with no lqsFiberAvgLoss. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.avgLoss"
    },
    "lqsDataFiberLastCalculationTime": {
      "type": "string",
      "description": "(Optional) The LQS fiber last loss calculation time. NA results in all Fres with no lqsFiberLastCalculationTime. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.lastCalculationTime"
    },
    "lqsDataFiberAvgLossStatus": {
      "type": "string",
      "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...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.avgLossStatus"
    },
    "lqsDataFiberPlannedLoss": {
      "type": "string",
      "description": "(Optional) The LQS fiber planned loss. NA results in all Fres with no lqsFiberPlannedLoss. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.plannedLoss"
    },
    "lqsDataFiberPlannedLossMargin": {
      "type": "string",
      "description": "(Optional) The LQS fiber planned loss margin. NA results in all Fres with no lqsFiberPlannedLossMargin. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.plannedLossMargin"
    },
    "lqsDataFiberCurrentLoss": {
      "type": "string",
      "description": "(Optional) The LQS fiber planned current loss. NA results in all Fres with no lqsFiberCurrentLoss. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.currentLoss"
    },
    "lqsDataFiberCurrentLossTime": {
      "type": "string",
      "description": "(Optional) The LQS fiber current loss time. NA results in all Fres with no lqsFiberCurrentLossTime. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.currentLossTime"
    },
    "lqsDataFiberCurrentLossMethod": {
      "type": "string",
      "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 lqsFiberAvg...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.fiber\\.currentLossMethod"
    },
    "lqsDataMarginViableAtEol": {
      "type": "string",
      "description": "(Optional) A list of LQS margin viable at EOL states. NA results in all Fres with no lqsMarginViableEOL. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.margin\\.viableAtEol"
    },
    "lqsDataPpgSnrStatus": {
      "type": "string",
      "description": "(Optional) A list of LQS PPG snr states. NA results in all Fres with no lqsPpgSnrStatus. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.ppg\\.snrStatus"
    },
    "lqsDataPpgCategorySnrReference": {
      "type": "string",
      "description": "(Optional) A list of LQS PPG category snr reference values. NA results in all Fres with no lqsPpgCategorySnrReference. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.ppg\\.categorySnrReference"
    },
    "lqsDataPpgDeltaSnrReference": {
      "type": "string",
      "description": "(Optional) A list of LQS PPG delta snr reference values. NA results in all Fres with no lqsPpgDeltaSnrReference. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.ppg\\.deltaSnrReference"
    },
    "lqsDataPpgStartDeltaSnrReference": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE lqsData ppg startDeltaSnrReference",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.ppg\\.startDeltaSnrReference"
    },
    "lqsDataPpgEndDeltaSnrReference": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE lqsData ppg endDeltaSnrReference",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "lqsData\\.ppg\\.endDeltaSnrReference"
    },
    "restorationHealthTotalExplicitRoutes": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE restorationHealth totalExplicitRoutes",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.totalExplicitRoutes"
    },
    "restorationHealthAvailableExplicitRoutes": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE restorationHealth availableExplicitRoutes",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.availableExplicitRoutes"
    },
    "restorationHealthUnavailableExplicitRoutes": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE restorationHealth unavailableExplicitRoutes",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.unavailableExplicitRoutes"
    },
    "restorationHealthAvailablePercentage": {
      "type": "string",
      "description": "((Optional) Allow filtering on FRE restorationHealth availablePercentage",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.availablePercentage"
    },
    "restorationHealthUnavailablePercentage": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE restorationHealth unavailablePercentage",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.unavailablePercentage"
    },
    "restorationHealthHomeAvailable": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE restorationHealth homeAvailable",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.homeAvailable"
    },
    "restorationHealthStartAvailablePercentage": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE restorationHealth startAvailablePercentage",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.startAvailablePercentage"
    },
    "restorationHealthEndAvailablePercentage": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE restorationHealth endAvailablePercentage",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "restorationHealth\\.endAvailablePercentage"
    },
    "utilizationDataTotalCapacity": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE utilizationData totalCapacity. NA results in all Fres with no utilizationTotalCapacity. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "utilizationData\\.totalCapacity"
    },
    "utilizationDataUsedCapacity": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE utilizationData usedCapacity. NA results in all Fres with no utilizationUsedCapacity. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "utilizationData\\.usedCapacity"
    },
    "utilizationDataUtilizationPercent": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE utilizationData utilizationPercent. NA results in all Fres with no utilizationPercent. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "utilizationData\\.utilizationPercent"
    },
    "utilizationDataStartUtilizationPercent": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE utilizationData startUtilizationPercent",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "utilizationData\\.startUtilizationPercent"
    },
    "utilizationDataEndUtilizationPercent": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE utilizationData endUtilizationPercent",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "utilizationData\\.endUtilizationPercent"
    },
    "utilizationDataCapacityUnits": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE utilizationData capacityUnits. NA results in all Fres with no utilizationCapacityUnits. NOT query is supported.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "utilizationData\\.capacityUnits"
    },
    "routingConstraintsInclusionConstraintsId": {
      "type": "string",
      "description": "(Optional) Retrieves all FREs that have an inclusion constraint relationship to the specified identifier. NA results in all Fres with no routingInclusionConstraintsId. NO...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "routingConstraints\\.inclusionConstraints\\.id"
    },
    "interfaceNameInterfaceIP": {
      "type": "string",
      "description": "(Optional) Filter support on Interface Name or Interface IP.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "interfaceName/interfaceIP"
    },
    "dailyThroughputAverageUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput averageUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.averageUtilization"
    },
    "dailyThroughputStartAverageUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput startAverageUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.startAverageUtilization"
    },
    "dailyThroughputEndAverageUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput endAverageUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.endAverageUtilization"
    },
    "dailyThroughputMaxUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput maxUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.maxUtilization"
    },
    "dailyThroughputStartMaxUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput startMaxUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.startMaxUtilization"
    },
    "dailyThroughputEndMaxUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput endMaxUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.endMaxUtilization"
    },
    "dailyThroughputNinetyFifthUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput ninetyFifthUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.ninetyFifthUtilization"
    },
    "dailyThroughputStartNinetyFifthUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput startNinetyFifthUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.startNinetyFifthUtilization"
    },
    "dailyThroughputEndNinetyFifthUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE daily throughput endNinetyFifthUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dailyThroughput\\.endNinetyFifthUtilization"
    },
    "weeklyThroughputAverageUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput averageUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.averageUtilization"
    },
    "weeklyThroughputStartAverageUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput startAverageUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.startAverageUtilization"
    },
    "weeklyThroughputEndAverageUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput endAverageUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.endAverageUtilization"
    },
    "weeklyThroughputMaxUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput maxUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.maxUtilization"
    },
    "weeklyThroughputStartMaxUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput startMaxUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.startMaxUtilization"
    },
    "weeklyThroughputEndMaxUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput endMaxUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.endMaxUtilization"
    },
    "weeklyThroughputNinetyFifthUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput ninetyFifthUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.ninetyFifthUtilization"
    },
    "weeklyThroughputStartNinetyFifthUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput startNinetyFifthUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.startNinetyFifthUtilization"
    },
    "weeklyThroughputEndNinetyFifthUtilization": {
      "type": "string",
      "description": "(Optional) Allow filtering on FRE weekly throughput endNinetyFifthUtilization",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "weeklyThroughput\\.endNinetyFifthUtilization"
    },
    "serviceRefreshState": {
      "type": "string",
      "description": "(Optional) Allow filtering support on the server refresh state",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "serviceRefresh\\.state"
    },
    "serviceRefreshStatus": {
      "type": "string",
      "description": "(Optional) Allow filtering support on the server refresh status",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "serviceRefresh\\.status"
    },
    "networkConstructIdQualifier": {
      "type": "string",
      "description": "(Optional) The logical operator to use when searching Network Construct identifiers",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "networkConstruct\\.idQualifier"
    }
  },
  "definitions": {}
}