{ "tags":[ { "description":"REST APIs for Active Topology Automation, Edge.", "name":"Active Topology Automation/Edge" }, { "description":"REST APIs for Active Topology Automation, Graph.", "name":"Active Topology Automation/Graph" }, { "description":"REST APIs for Active Topology Automation, Profile.", "name":"Active Topology Automation/Profile" }, { "description":"REST APIs for Active Topology Automation, Resource Adapter.", "name":"Active Topology Automation/Resource Adapter" }, { "description":"REST APIs for Active Topology Automation, UI.", "name":"Active Topology Automation/UI" }, { "description":"REST APIs for Active Topology Automation, Vertex.", "name":"Active Topology Automation/Vertex" }, { "description":"Operations related to events management.", "name":"Event and Impact Analysis/Event" }, { "description":"Operations related to impacts management.", "name":"Event and Impact Analysis/Impact" }, { "description":"Operations related to impact reports management.", "name":"Event and Impact Analysis/Report" }, { "description":"REST APIs for Fallout Events Resolution.", "name":"Fallout Events Resolution" } ], "components":{ "schemas":{ "AlarmSummary":{ "properties":{ "critical":{ "format":"int32", "type":"integer" }, "major":{ "format":"int32", "type":"integer" }, "warning":{ "format":"int32", "type":"integer" } }, "type":"object" }, "BridgeEdge":{ "properties":{ "layerId":{ "format":"int32", "type":"integer" }, "entityId":{ "format":"int64", "type":"integer" }, "businessObjectClass":{ "type":"string" } }, "type":"object" }, "Capacity":{ "properties":{ "maxBandwidth":{ "type":"number" }, "availableCapacity":{ "type":"boolean" }, "maxContiguousChannels":{ "format":"int32", "type":"integer" }, "unitBitRate":{ "type":"number" } }, "type":"object" }, "Edge":{ "properties":{ "entityId":{ "format":"int64", "type":"integer" }, "entityVersion":{ "format":"int32", "type":"integer" }, "businessObjectClass":{ "type":"string" }, "technology":{ "type":"string" }, "ratecode":{ "type":"string" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "specName":{ "type":"string" }, "edgeType":{ "type":"string" }, "fromNode":{ "format":"int64", "type":"integer" }, "fromNodeId":{ "type":"string" }, "fromNodeBusinessObjectClass":{ "type":"string" }, "fromNodeData":{ "type":"string" }, "isPipeInterfaceTerminated":{ "type":"boolean" }, "toNode":{ "format":"int64", "type":"integer" }, "toNodeId":{ "type":"string" }, "toNodeBusinessObjectClass":{ "type":"string" }, "toNodeData":{ "type":"string" }, "referenceId":{ "format":"int64", "type":"integer" }, "inventoryStatus":{ "type":"string" }, "fromNodeReferenceId":{ "type":"string" }, "toNodeReferenceId":{ "type":"string" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "properties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "maxBandwidth":{ "type":"number" }, "totalCapacity":{ "type":"number" }, "availableCapacity":{ "type":"boolean" }, "isChannelized":{ "type":"boolean" }, "unitBitRate":{ "type":"number" }, "maxContiguousChannels":{ "format":"int32", "type":"integer" }, "costValue1":{ "format":"double", "type":"number" }, "costValue2":{ "format":"double", "type":"number" }, "costValue3":{ "format":"double", "type":"number" }, "autoSuggestName":{ "type":"string" }, "capacities":{ "items":{ "$ref":"#/components/schemas/Capacity" }, "type":"array" }, "channels":{ "items":{ "type":"string" }, "type":"array" }, "pathIds":{ "items":{ "format":"int32", "type":"integer" }, "type":"array", "uniqueItems":true }, "trailPaths":{ "format":"int32", "type":"integer" }, "protectedEdge":{ "type":"boolean" }, "nativeEMSName":{ "type":"string" }, "fromNodeCapacityConsumed":{ "format":"float", "type":"number" }, "toNodeCapacityConsumed":{ "format":"float", "type":"number" } }, "type":"object" }, "ErrorType":{ "required":[ "code", "reason" ], "properties":{ "code":{ "type":"string" }, "reason":{ "type":"string" }, "message":{ "items":{ "type":"string" }, "type":"array" }, "status":{ "type":"string" } }, "type":"object" }, "Event":{ "properties":{ "entityId":{ "format":"int64", "type":"integer" }, "businessObjectClass":{ "type":"string" }, "instanceName":{ "type":"string" }, "eventDate":{ "example":"2022-03-10", "format":"date", "type":"string", "writeOnly":true }, "eventStatus":{ "type":"string" }, "thresholdName":{ "type":"string" }, "thresholdTimeRange":{ "format":"int64", "type":"integer" }, "thresholdTypeName":{ "type":"string" }, "thresholdSeverity":{ "format":"int64", "type":"integer" }, "metricValue":{ "format":"double", "type":"number" }, "thresholdOperator":{ "type":"string" }, "thresholdType":{ "type":"string" }, "thresholdMessage":{ "type":"string" }, "measurement":{ "type":"string" }, "thresholdValue":{ "format":"double", "type":"number" }, "referenceId":{ "format":"int64", "type":"integer" }, "alarmType":{ "type":"string" }, "perceivedSeverity":{ "type":"string" }, "probableCause":{ "type":"string" }, "specificProblem":{ "type":"string" }, "sourceSystemID":{ "type":"string" }, "alarmDetails":{ "type":"string" }, "href":{ "type":"string" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "properties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "relationships":{ "additionalProperties":{ "type":"string" }, "type":"object" } }, "type":"object" }, "Filter":{ "properties":{ "businessObjectClass":{ "type":"string" }, "technology":{ "type":"string" }, "ratecode":{ "type":"string" }, "specification":{ "type":"string" }, "isNode":{ "type":"boolean" }, "city":{ "type":"string" }, "locationCode":{ "type":"string" }, "deviceType":{ "type":"string" }, "alarm":{ "type":"string" }, "networkType":{ "type":"string" }, "deviceSpecification":{ "type":"string" }, "vendor":{ "type":"string" }, "domain":{ "type":"string" } }, "type":"object" }, "FilterChip":{ "properties":{ "filter":{ "type":"string" }, "value":{ "type":"string" }, "label":{ "type":"string" }, "filterLabel":{ "type":"string" }, "isNode":{ "type":"boolean" }, "dependencies":{ "items":{ "$ref":"#/components/schemas/FilterChip" }, "type":"array" } }, "type":"object" }, "GraphData":{ "properties":{ "alarmSummary":{ "$ref":"#/components/schemas/AlarmSummary" }, "edges":{ "items":{ "$ref":"#/components/schemas/Edge" }, "type":"array" }, "nodes":{ "items":{ "$ref":"#/components/schemas/Vertex" }, "type":"array" }, "filters":{ "items":{ "$ref":"#/components/schemas/Filter" }, "type":"array" }, "filterChips":{ "items":{ "$ref":"#/components/schemas/FilterChip" }, "type":"array" }, "deviceHierarchyAvailable":{ "type":"boolean" } }, "type":"object" }, "LabelData":{ "properties":{ "entityId":{ "format":"int64", "type":"integer" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "locationCode":{ "type":"string" }, "deviceIdentifier":{ "type":"string" }, "autoSuggestName":{ "type":"string" } }, "type":"object" }, "Path":{ "properties":{ "source":{ "$ref":"#/components/schemas/Vertex" }, "destination":{ "$ref":"#/components/schemas/Vertex" }, "edges":{ "items":{ "$ref":"#/components/schemas/Edge" }, "type":"array" } }, "type":"object" }, "PathAnalysisCriteria":{ "enum":[ "SOURCE_ENTITY_ID", "DESTINATION_ENTITY_ID", "INTERMEDIATE_ENTITY_ID", "ALGORITHM", "K", "TECHNOLOGY", "RATECODE", "NUMBER_OF_HOPS", "PIPE_SPECIFICATIONS", "FILTER_BY", "NETWORKS", "VENDOR", "EXCLUDE_ALARM_TYPE", "IS_GAP_ANALYSIS", "BITRATE_QUANTITY", "TOPOLOGY_BITRATE", "IS_CONTIGUOUS_CHANNELS", "EXCLUDE_EDGES", "IS_PATH_ANALYSIS", "SAME_WAVELENGTH_AND_FREQUENCY", "INCLUDE_EDGES", "INCLUDE_PARTIAL_PATHS", "DISTANCE_FROM_SOURCE", "DISTANCE_FROM_TARGET", "UOM_OF_DISTANCE_FROM_SOURCE", "UOM_OF_DISTANCE_FROM_TARGET" ], "type":"string" }, "Profile":{ "properties":{ "alarmSummary":{ "$ref":"#/components/schemas/AlarmSummary" }, "entityId":{ "format":"int64", "type":"integer" }, "entityVersion":{ "format":"int32", "type":"integer" }, "businessObjectClass":{ "type":"string" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "referenceId":{ "format":"int64", "type":"integer" }, "relationships":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "properties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "zoomLevel":{ "format":"int32", "type":"integer" }, "profileVertices":{ "items":{ "$ref":"#/components/schemas/ProfileVertex" }, "type":"array" }, "profileEdges":{ "items":{ "$ref":"#/components/schemas/ProfileEdge" }, "type":"array" }, "refresh":{ "type":"boolean" }, "json":{ "type":"string" }, "status":{ "type":"string" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "filters":{ "items":{ "$ref":"#/components/schemas/Filter" }, "type":"array" }, "filterChips":{ "items":{ "$ref":"#/components/schemas/FilterChip" }, "type":"array" } }, "type":"object" }, "ProfileEdge":{ "properties":{ "entityId":{ "format":"int64", "type":"integer" }, "entityVersion":{ "format":"int32", "type":"integer" }, "businessObjectClass":{ "type":"string" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "profileNode":{ "$ref":"#/components/schemas/ProfileVertex" }, "toProfileNode":{ "$ref":"#/components/schemas/ProfileVertex" }, "communication":{ "format":"int64", "type":"integer" }, "lineType":{ "type":"string" }, "lineColor":{ "type":"string" }, "label":{ "type":"string" }, "exclude":{ "type":"boolean" }, "profile":{ "format":"int64", "type":"integer" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "properties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "edge":{ "$ref":"#/components/schemas/Edge" } }, "type":"object" }, "ProfileVertex":{ "properties":{ "entityId":{ "format":"int64", "type":"integer" }, "entityVersion":{ "format":"int32", "type":"integer" }, "businessObjectClass":{ "type":"string" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "imageName":{ "type":"string" }, "xPos":{ "format":"int32", "type":"integer" }, "yPos":{ "format":"int32", "type":"integer" }, "label":{ "type":"string" }, "exclude":{ "type":"boolean" }, "profile":{ "format":"int64", "type":"integer" }, "relationships":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "properties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "device":{ "format":"int64", "type":"integer" }, "nec":{ "format":"int64", "type":"integer" }, "location":{ "format":"int64", "type":"integer" }, "network":{ "format":"int64", "type":"integer" }, "vertex":{ "$ref":"#/components/schemas/Vertex" } }, "type":"object" }, "RebuildRequest":{ "properties":{ "eids":{ "description":"Entity IDs to rebuild.", "items":{ "type":"string" }, "type":"array" }, "targetService":{ "description":"Target system to route rebuilt events to. Only ATA supported.", "type":"string" }, "state":{ "description":"Filter by event state.", "type":"string" }, "errorCode":{ "description":"Filter by error code.", "type":"string" }, "eventType":{ "description":"Filter by event type.", "type":"string" }, "action":{ "description":"Filter by action.", "type":"string" }, "startCreationDate":{ "description":"Start of the creation date range (format: yyyy-MM-dd)", "type":"string" }, "endCreationDate":{ "description":"End of the creation date range (format: yyyy-MM-dd)", "type":"string" }, "startLastModifiedDate":{ "description":"Start of the last modified date range (format: yyyy-MM-dd)", "type":"string" }, "endLastModifiedDate":{ "description":"End of the last modified date range (format: yyyy-MM-dd)", "type":"string" }, "empty":{ "type":"boolean" } }, "description":"Request object for rebuilding fallout events.", "type":"object" }, "SavedSearchParamType":{ "properties":{ "id":{ "format":"int64", "type":"integer" }, "paramNumber":{ "format":"int32", "type":"integer" }, "filterName":{ "type":"string" }, "filterValue":{ "type":"string" }, "valueList":{ "items":{ "type":"string" }, "type":"array" }, "operator":{ "type":"string" } }, "type":"object" }, "SavedSearchType":{ "properties":{ "id":{ "format":"int64", "type":"integer" }, "userId":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "entityType":{ "type":"string" }, "url":{ "type":"string" }, "lastNodeCount":{ "format":"int32", "type":"integer" }, "lastEdgeCount":{ "format":"int32", "type":"integer" }, "searchParams":{ "items":{ "$ref":"#/components/schemas/SavedSearchParamType" }, "type":"array" }, "createdUser":{ "type":"string" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "pathView":{ "type":"boolean" } }, "type":"object" }, "SubNetwork":{ "properties":{ "parentNetworkName":{ "type":"string" }, "subNetworkName":{ "type":"string" }, "subNetworkEid":{ "format":"int64", "type":"integer" }, "nodes":{ "items":{ "$ref":"#/components/schemas/Vertex" }, "type":"array" }, "locations":{ "items":{ "$ref":"#/components/schemas/Vertex" }, "type":"array" } }, "type":"object" }, "SystemPreferenceColorsType":{ "properties":{ "preferenceId":{ "format":"int64", "type":"integer" }, "createdUser":{ "type":"string" }, "rateCode":{ "type":"string" }, "technology":{ "type":"string" }, "color":{ "type":"string" }, "edgestyle":{ "type":"string" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" } }, "type":"object" }, "SystemPreferenceIconType":{ "properties":{ "preferenceId":{ "format":"int64", "type":"integer" }, "createdUser":{ "type":"string" }, "specification":{ "type":"string" }, "networkType":{ "type":"string" }, "icon_id":{ "format":"int64", "type":"integer" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "IconBase64":{ "type":"string" }, "iconBase64":{ "type":"string" } }, "type":"object" }, "UnitOfMeasurement":{ "enum":[ "Meter", "Kilometer", "Mile", "Yard", "Foot" ], "type":"string" }, "Vertex":{ "properties":{ "entityId":{ "format":"int64", "type":"integer" }, "entityVersion":{ "format":"int32", "type":"integer" }, "businessObjectClass":{ "type":"string" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "specName":{ "type":"string" }, "latitude":{ "format":"double", "type":"number" }, "longitude":{ "format":"double", "type":"number" }, "inventoryStatus":{ "type":"string" }, "nodeCategory":{ "type":"string" }, "macAddress":{ "type":"string" }, "availablePositions":{ "type":"string" }, "occupiedPositions":{ "type":"string" }, "ipv4":{ "type":"string" }, "ipv4Subnet":{ "type":"string" }, "ipv6":{ "type":"string" }, "ipv6Subnet":{ "type":"string" }, "zoneId":{ "type":"string" }, "deviceIdentifier":{ "type":"string" }, "equipmentCategory":{ "type":"string" }, "networkStatus":{ "type":"string" }, "activeEvent":{ "format":"int64", "type":"integer" }, "city":{ "type":"string" }, "state":{ "type":"string" }, "country":{ "type":"string" }, "postalCode":{ "type":"string" }, "district":{ "type":"string" }, "region":{ "type":"string" }, "province":{ "type":"string" }, "locationCode":{ "type":"string" }, "operator":{ "type":"string" }, "referenceId":{ "format":"int64", "type":"integer" }, "communication":{ "format":"int64", "type":"integer" }, "autoSuggestName":{ "type":"string" }, "subNetworkName":{ "type":"string" }, "subNetworkEntityId":{ "format":"int64", "type":"integer" }, "subNetworkId":{ "format":"int64", "type":"integer" }, "fromNodeSubNetwork":{ "format":"int64", "type":"integer" }, "toNodeSubNetwork":{ "format":"int64", "type":"integer" }, "nodeType":{ "type":"string" }, "area":{ "type":"string" }, "circle":{ "type":"string" }, "category":{ "type":"string" }, "subCategory":{ "type":"string" }, "topologyType":{ "type":"string" }, "subType":{ "type":"string" }, "capacityConsumed":{ "format":"float", "type":"number" }, "relationships":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "properties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "deviceInterfaceId":{ "type":"string" }, "deviceInterfaceName":{ "type":"string" }, "physicalPortId":{ "type":"string" }, "physicalPortName":{ "type":"string" }, "locationName":{ "type":"string" }, "pathIds":{ "items":{ "format":"int32", "type":"integer" }, "type":"array", "uniqueItems":true }, "layerName":{ "type":"string" }, "layerId":{ "format":"int32", "type":"integer" }, "bridgeEdges":{ "items":{ "$ref":"#/components/schemas/BridgeEdge" }, "type":"array", "uniqueItems":true }, "nativeEMSName":{ "type":"string" }, "activeEventDesc":{ "type":"string" } }, "type":"object" }, "AggregateFilter":{ "properties":{ "filter":{ "type":"string" }, "value":{ "items":{ "type":"string" }, "type":"array" } }, "type":"object" }, "FalloutAggregateFilterRequest":{ "properties":{ "selectedFilter":{ "type":"string" }, "filters":{ "items":{ "$ref":"#/components/schemas/AggregateFilter" }, "type":"array" } }, "type":"object" }, "FalloutEvent":{ "properties":{ "entityId":{ "format":"int64", "type":"integer" }, "event":{ "type":"string" }, "eventType":{ "type":"string" }, "errorCode":{ "type":"string" }, "errorDescription":{ "type":"string" }, "eventHeaders":{ "type":"string" }, "origEvent":{ "type":"object" }, "sourceSystemId":{ "type":"string" }, "createdUser":{ "type":"string" }, "createdDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "type":"string" }, "lastModifiedDate":{ "example":"2022-03-10", "format":"date", "type":"string" }, "action":{ "type":"string" }, "state":{ "type":"string" }, "targetSystemId":{ "type":"string" } }, "type":"object" }, "FalloutEventActionSummary":{ "properties":{ "action":{ "type":"string" }, "count":{ "format":"int64", "type":"integer" }, "states":{ "additionalProperties":{ "format":"int64", "type":"integer" }, "type":"object" } }, "type":"object" }, "FalloutEventFilterDateMetadata":{ "properties":{ "attributeName":{ "type":"string" }, "gte":{ "type":"string" }, "lte":{ "type":"string" } }, "type":"object" }, "FalloutEventFilterItem":{ "properties":{ "filter":{ "type":"string" }, "plugin":{ "type":"string" }, "filterLabel":{ "type":"string" }, "label":{ "type":"string" }, "value":{ "type":"string" }, "metadata":{ "$ref":"#/components/schemas/FalloutEventFilterDateMetadata" } }, "type":"object" }, "FalloutEventFilterResponse":{ "properties":{ "totalResults":{ "format":"int64", "type":"integer" }, "hasMore":{ "type":"boolean" }, "items":{ "items":{ "$ref":"#/components/schemas/FalloutEventFilterItem" }, "type":"array" } }, "type":"object" }, "FalloutEventGroupSummary":{ "properties":{ "fallouts":{ "items":{ }, "type":"array" }, "totalCount":{ "format":"int64", "type":"integer" } }, "type":"object" }, "FalloutEventSummary":{ "properties":{ "count":{ "format":"int64", "type":"integer" }, "actions":{ "items":{ "$ref":"#/components/schemas/FalloutEventActionSummary" }, "type":"array" }, "targetService":{ "type":"string" } }, "type":"object" }, "FalloutFilterRequest":{ "properties":{ "filters":{ "additionalProperties":{ }, "type":"object" } }, "type":"object" }, "ResubmitRequest":{ "properties":{ "eids":{ "description":"Entity IDs to resubmit. If present, overrides all filters. Max 500 IDs allowed.", "items":{ "type":"string" }, "type":"array" }, "state":{ "description":"State filter for fallout events. Default is READY_TO_RESUBMIT.", "type":"string" }, "action":{ "description":"Action to take for resubmission. Default is REBUILD.", "type":"string" }, "errorCode":{ "description":"Error code filter for fallout events, e.g. TOP-4006.", "type":"string" }, "targetService":{ "description":"Target system to route resubmitted events to. Required if filters are used.", "type":"string" }, "empty":{ "type":"boolean" } }, "type":"object" }, "BulkDeleteRecord":{ "properties":{ "id":{ "description":"Document id of the entity to be deleted.", "type":"string" } }, "type":"object" }, "BulkOperationResult":{ "properties":{ "hasErrors":{ "description":"Flag to indicate if there are any errors.", "type":"boolean" }, "errors":{ "description":"Error records to store the information of the failed operations on the entities.", "items":{ "$ref":"#/components/schemas/ErrorRecord" }, "type":"array" } }, "type":"object" }, "ErrorRecord":{ "properties":{ "id":{ "description":"Document id of the entity for which the operation failed.", "type":"string" }, "errorMessage":{ "description":"Error message indicating the reason for the failure.", "type":"string" } }, "type":"object" }, "EventBulkUpdateRecord":{ "properties":{ "id":{ "description":"Event document id for which update operation is to be performed.", "type":"string" }, "ownerName":{ "description":"Owner name to be updated for the event.", "type":"string" }, "eventStatus":{ "description":"Event status to be updated for the event.", "type":"string" }, "analysisStatus":{ "description":"Event analysis status to be updated for the event.", "type":"string" } }, "type":"object" }, "EventSelectAllUpdateRequest":{ "properties":{ "filters":{ "description":"Applied filters defining a smart search query.", "items":{ "$ref":"#/components/schemas/FilterChip" }, "type":"array" }, "excludeList":{ "description":"List of event document IDs which should be excluded from applying patch operation.", "items":{ "type":"string" }, "type":"array" }, "operation":{ "allOf":[ { "$ref":"#/components/schemas/EventBulkUpdateRecord" } ], "description":"Patch operation that should be performed on the events matching the filters criteria.", "type":"object" } }, "type":"object" }, "ImpactBulkUpdateRecord":{ "properties":{ "id":{ "description":"Impact document id for which update operation is to be performed.", "type":"string" }, "ownerName":{ "description":"Owner name to be updated for the impact.", "type":"string" }, "impactSeverity":{ "description":"Impact severity to be updated for the impact.", "type":"string" }, "analysisStatus":{ "description":"Analysis status to be updated for the impact.", "type":"string" } }, "type":"object" }, "ImpactItem":{ "properties":{ "_id":{ "type":"string" }, "_index":{ "type":"string" }, "_score":{ "format":"double", "type":"number" }, "highlight":{ }, "_source":{ "$ref":"#/components/schemas/SmartSearchEventImpact" } }, "type":"object" }, "ImpactSelectAllUpdateRequest":{ "properties":{ "filters":{ "description":"Applied filters defining a smart search query.", "items":{ "$ref":"#/components/schemas/FilterChip" }, "type":"array" }, "excludeList":{ "description":"List of event document IDs which should be excluded from applying patch operation.", "items":{ "type":"string" }, "type":"array" }, "operation":{ "allOf":[ { "$ref":"#/components/schemas/ImpactBulkUpdateRecord" } ], "description":"Patch operation that should be performed on the events matching the filters criteria.", "type":"object" } }, "type":"object" }, "ResourceHighestSeverityEvent":{ "properties":{ "id":{ "description":"Event document id of highest severity event for this resource.", "type":"string" }, "perceivedSeverity":{ "description":"Perceived severity of highest severity event for this resource.", "type":"string" }, "resourceId":{ "description":"Resource id.", "type":"string" } }, "type":"object" }, "SelectAllDeleteRequest":{ "properties":{ "filters":{ "description":"Applied filters defining a smart search query.", "items":{ "$ref":"#/components/schemas/FilterChip" }, "type":"array" }, "excludeList":{ "description":"List of entity document IDs which should be excluded from applying delete operation.", "items":{ "type":"string" }, "type":"array" } }, "type":"object" }, "Shards":{ "properties":{ "total":{ "format":"int32", "type":"integer" }, "successful":{ "format":"int32", "type":"integer" }, "skipped":{ "format":"int32", "type":"integer" }, "failed":{ "format":"int32", "type":"integer" } }, "type":"object" }, "SmartSearchBulkIndex":{ "properties":{ "_index":{ "type":"string" }, "_id":{ "type":"string" } }, "type":"object" }, "SmartSearchCustomer":{ "properties":{ "customerId":{ "type":"string" }, "customerName":{ "type":"string" }, "customerHref":{ "type":"string" }, "customerRole":{ "type":"string" }, "customerType":{ "type":"string" } }, "type":"object" }, "SmartSearchEvent":{ "properties":{ "entityId":{ "deprecated":true, "format":"int64", "type":"integer" }, "eventId":{ "type":"string" }, "businessObjectClass":{ "type":"string" }, "instanceName":{ "description":"Instance name for this event.", "type":"string" }, "eventDate":{ "description":"Event date when event status for this event was changed.", "example":"2022-03-10", "format":"date", "type":"string" }, "eventStatus":{ "description":"Event status for this event.", "type":"string" }, "thresholdName":{ "description":"Threshold name for this TCA event.", "type":"string" }, "thresholdTimeRange":{ "description":"Threshold time range for this TCA event.", "type":"string" }, "thresholdTypeName":{ "description":"Threshold time range for this TCA event.", "type":"string" }, "thresholdSeverity":{ "description":"Threshold severity for this TCA event.", "format":"int64", "type":"integer" }, "metricValue":{ "description":"Threshold metric value for this TCA event.", "type":"string" }, "thresholdOperator":{ "description":"Threshold operator value for this TCA event.", "type":"string" }, "thresholdType":{ "description":"Threshold type for this TCA event.", "type":"string" }, "thresholdMessage":{ "description":"Threshold message for this TCA event.", "type":"string" }, "measurement":{ "description":"Threshold measurement for this TCA event.", "type":"string" }, "thresholdValue":{ "description":"Threshold value for this TCA event.", "format":"double", "type":"number" }, "referenceId":{ "description":"External assurance system reference id for this event.", "type":"string" }, "alarmType":{ "description":"Alarm type for this event.", "type":"string" }, "perceivedSeverity":{ "description":"Alarm perceived severity for this event.", "type":"string" }, "probableCause":{ "description":"Alarm probable cause for this event.", "type":"string" }, "specificProblem":{ "description":"Alarm specific problem for this event.", "type":"string" }, "sourceSystemID":{ "description":"Assurance system source system identifier for this event.", "type":"string" }, "alarmDetails":{ "description":"Protocol specific alarm details for this event.", "type":"string" }, "href":{ "description":"External system alarm href for this event.", "type":"string" }, "createdDate":{ "description":"Date on which this event was created.", "example":"2022-03-10", "format":"date", "type":"string" }, "createdUser":{ "description":"User by whom this event was created.", "type":"string" }, "lastModifiedDate":{ "description":"Date on which this event was last modified.", "example":"2022-03-10", "format":"date", "type":"string" }, "lastModifiedUser":{ "description":"User by whom this event was last modified.", "type":"string" }, "reportId":{ "description":"System generated report id, when this event was completed.", "type":"string" }, "reportCreationDate":{ "description":"Date at which this event was completed and a report was generated.", "example":"2022-03-10", "format":"date", "type":"string" }, "properties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "relationships":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "lang":{ "description":"Smart Search internal field used in lang pipeline processing.", "type":"string" }, "tenant_id":{ "description":"Smart Search internal field for search tenancy.", "type":"string" }, "id":{ "description":"Document id for the event entity.", "type":"string" }, "resourceName":{ "description":"Name of the resource on which this event is raised.", "type":"string" }, "resourceCategory":{ "description":"Category of the resource on which this event is raised.", "type":"string" }, "resourceType":{ "description":"Type of the resource on which this event is raised.", "type":"string" }, "resourceSubType":{ "description":"Sub type of the resource on which this event is raised.", "type":"string" }, "resourceId":{ "description":"Inventory id of the resource on which this event is raised.", "type":"string" }, "resourceHref":{ "description":"Inventory href of the resource on which this event is raised.", "type":"string" }, "resourceActiveEvent":{ "description":"Active event on the topology node when this event was raised.", "format":"int64", "type":"integer" }, "nodeLinkEntityId":{ "description":"Entity id of the device node in topology to which this event is associated.", "type":"string" }, "edgeLinkEntityId":{ "description":"Entity ids of the communication edges in topology that terminate on the inventory resource on which this event is raised.", "items":{ "type":"string" }, "type":"array" }, "ownerName":{ "description":"Owner of this event.", "type":"string" }, "analysisStatus":{ "description":"Analysis status for this event.", "type":"string" }, "errorDetails":{ "description":"Error details gathered when event analysis fails for this event.", "type":"string" }, "description":{ "description":"Free-text description for this event.", "type":"string" }, "parentNodeEntityId":{ "description":"parent node entity Id", "type":"string" } }, "type":"object" }, "SmartSearchEventImpact":{ "properties":{ "index":{ "$ref":"#/components/schemas/SmartSearchBulkIndex" }, "lang":{ "description":"Smart Search internal field used in lang pipeline processing.", "type":"string" }, "tenant_id":{ "description":"Smart Search internal field for search tenancy.", "type":"string" }, "id":{ "description":"Document id for the impact entity.", "type":"string" }, "name":{ "description":"Name of the impacted entity.", "type":"string" }, "entityType":{ "description":"Entity Type of the impacted entity.", "type":"string" }, "href":{ "description":"Inventory href of the impacted entity.", "type":"string" }, "specification":{ "description":"Specification of the impacted entity.", "type":"string" }, "latitude":{ "description":"Latitude of the impacted location entity.", "format":"double", "type":"number" }, "longitude":{ "description":"Longitude of the impacted location entity.", "format":"double", "type":"number" }, "impactType":{ "description":"Type of impact, possible values are DIRECT and INDIRECT.", "type":"string" }, "technology":{ "description":"Technology of the impacted Connectivity entity.", "type":"string" }, "ratecode":{ "description":"Ratecode of the impacted Connectivity entity.", "type":"string" }, "analysisStatus":{ "description":"Analysis status for the impacted entity.", "type":"string" }, "event":{ "description":"Document id of the event with which this impact is associated.", "type":"string" }, "location":{ "description":"Latitude and Longitude coordinates for the location.", "type":"string" }, "endDate":{ "description":"The date at which the impact is closed.", "example":"2022-03-10", "format":"date", "type":"string" }, "lastUpdatedDate":{ "description":"The date at which the impact was last modified.", "example":"2022-03-10", "format":"date", "type":"string" }, "qualificationTime":{ "description":"The number of epoch milliseconds between the time the event is created and the time the impact analysis status changes to QUALIFIED or DISQUALIFIED.", "type":"string" }, "customer":{ "description":"Details about the customers impacted due to this impact.", "items":{ "$ref":"#/components/schemas/SmartSearchCustomer" }, "type":"array" }, "impactSeverity":{ "description":"Severity of the impact.", "type":"string" }, "ownerName":{ "description":"Owner of the impact.", "type":"string" }, "comments":{ "description":"Free-text comments related to the impact added by user.", "type":"string" }, "flowIdentifierIdentifier":{ "description":"Identifier of the impacted flow identifier.", "format":"int32", "type":"integer" }, "flowIdentifierDomain":{ "description":"Domain of the impacted flow identifier.", "type":"string" } }, "type":"object" }, "SmartSearchResultsImpact":{ "properties":{ "totalResults":{ "format":"int32", "type":"integer" }, "count":{ "format":"int32", "type":"integer" }, "hasMore":{ "type":"boolean" }, "limit":{ "format":"int32", "type":"integer" }, "offset":{ "format":"int32", "type":"integer" }, "took":{ "format":"int32", "type":"integer" }, "sort":{ "items":{ "$ref":"#/components/schemas/Sort" }, "type":"array" }, "timed_out":{ "type":"boolean" }, "_shards":{ "$ref":"#/components/schemas/Shards" }, "items":{ "items":{ "$ref":"#/components/schemas/ImpactItem" }, "type":"array" } }, "type":"object" }, "Sort":{ "properties":{ "value":{ "type":"string" }, "label":{ "type":"string" } }, "type":"object" } } }, "info":{ "title":"REST API for Active Topology Automation and Service Impact Analysis", "version":"2026.04.28", "description":"Use Oracle Communications Active Topology Automation (ATA) for creating, updating, deleting, and reading topology vertices and edges. Use Oracle Communications Service Impact Analysis for viewing, analyzing, and customizing service impacts reports.\nThe Oracle Communications Active Topology Automation (ATA) represents the spatial relationships and connectivity among your inventory entities form the inventory and network topology. For more information, see ATA Model Documentation.", "x-summary":"Use Oracle Communications Active Topology Automation (ATA) for creating, updating, deleting, and reading topology vertices and edges." }, "openapi":"3.0.3", "paths":{ "/topology/v2/edge":{ "post":{ "tags":[ "Active Topology Automation/Edge" ], "description":"Create a new Edge", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "fromNode":3445, "edgeType":"LOCATION_REGION", "name":"HOLIDAY GLN DENVER CO 80260 US-Southwest", "businessObjectClass":"TopologyOnly", "toNode":29211 } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Create a New Edge" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "fromNode":3445, "edgeType":"LOCATION_REGION", "autoSuggestName":"(null)-HOLIDAY GLN DENVER CO 80260 US-Southwest", "name":"HOLIDAY GLN DENVER CO 80260 US-Southwest", "entityId":29810, "businessObjectClass":"TopologyOnly", "toNode":29211 } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edge created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a new Edge", "x-internal-id":"topology-v2-edge-post", "x-filename-id":"topology-v2-edge-post" }, "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The label for the edges", "in":"query", "name":"label", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The fromnode entityid for the edges", "in":"query", "name":"fromnode", "required":false, "schema":{ "type":"string" } }, { "description":"The tonode entityid for the edges", "in":"query", "name":"tonode", "required":false, "schema":{ "type":"string" } }, { "description":"The fromnode label for the edges", "in":"query", "name":"fromnodeLabel", "required":false, "schema":{ "type":"string" } }, { "description":"The tonode label for the edges", "in":"query", "name":"tonodeLabel", "required":false, "schema":{ "type":"string" } }, { "description":"The Edge boc to be searched", "in":"query", "name":"boc", "required":false, "schema":{ "type":"string" } }, { "description":"The name of the edges", "in":"query", "name":"name", "required":false, "schema":{ "type":"string" } }, { "description":"The id of the edges", "in":"query", "name":"id", "required":false, "schema":{ "type":"string" } }, { "description":"The properties of an edges", "in":"query", "name":"property", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The offset for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The limit for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve a list of existing edges", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":4753, "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-01-13T20:00:09.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500002", "entityId":10944, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1500001, "toNode":4759, "entityVersion":2, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500004", "createdDate":"2023-01-13T20:00:09.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1000)-BRKL01NY.SR-1-BRKL02NY.SR-1", "costValue3":100, "name":"BRKL01NY.SR-1-BRKL02NY.SR-1", "costValue2":100, "costValue1":100, "id":"1000", "createdUser":"", "ratecode":"100G" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edge retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of edges", "x-internal-id":"topology-v2-edge-get", "x-filename-id":"topology-v2-edge-get" }, "put":{ "tags":[ "Active Topology Automation/Edge" ], "description":"Update an existing Edge", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "fromNode":4894, "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "inventoryStatus":"INSTALLED", "entityId":29811, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":91583996, "toNode":6039, "specName":"INNI Connectivity", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "name":"DLLS01TX.SR-1 / DST001TX.MC-1 / 10GigE / GE10 / 2", "ratecode":"1GigE" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Update an existing Edge" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":4894, "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-03-29T14:06:50.000Z", "inventoryStatus":"INSTALLED", "entityId":29811, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":91583996, "toNode":6039, "entityVersion":1, "createdDate":"2023-03-29T14:03:05.000Z", "specName":"INNI Connectivity", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(9502)-DLLS01TX.SR-1 / DST001TX.MC-1 / 10GigE / GE10 / 2", "costValue3":100, "name":"DLLS01TX.SR-1 / DST001TX.MC-1 / 10GigE / GE10 / 2", "costValue2":100, "costValue1":100, "id":"9502", "ratecode":"1GigE" } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Edge updated successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Edge", "x-internal-id":"topology-v2-edge-put", "x-filename-id":"topology-v2-edge-put" } }, "/topology/v2/edge/communication":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The technology of the edges", "in":"query", "name":"technology", "required":false, "schema":{ "type":"string" } }, { "description":"The ratecode of the edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "type":"string" } }, { "description":"The fromnode entityid for the edges", "in":"query", "name":"fromnode", "required":false, "schema":{ "type":"string" } }, { "description":"The tonode label for the edges", "in":"query", "name":"tonode", "required":false, "schema":{ "type":"string" } }, { "description":"The fromnode label for the edges", "in":"query", "name":"fromnodeLabel", "required":false, "schema":{ "type":"string" } }, { "description":"The toNode label for the edges", "in":"query", "name":"tonodeLabel", "required":false, "schema":{ "type":"string" } }, { "description":"The fromNode id of the edges", "in":"query", "name":"fromnodeId", "required":false, "schema":{ "type":"string" } }, { "description":"The toNode id of the edges", "in":"query", "name":"tonodeId", "required":false, "schema":{ "type":"string" } }, { "description":"The offset for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The limit for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve a list of communication edges", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":4809, "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-01-13T20:02:10.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500572", "entityId":10974, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1500571, "toNode":4839, "entityVersion":2, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500574", "createdDate":"2023-01-13T20:02:10.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1030)-BVRL01CA.SR-1-SCRM01CA.SR-1", "costValue3":100, "name":"BVRL01CA.SR-1-SCRM01CA.SR-1", "costValue2":100, "costValue1":100, "id":"1030", "createdUser":"", "ratecode":"100G" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edge retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of communication edges", "x-internal-id":"topology-v2-edge-communication-get", "x-filename-id":"topology-v2-edge-communication-get" } }, "/topology/v2/edge/communication/center-vertex/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityid of the source device to find the nearby edges", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "description":"The distance the edges are from the device", "in":"query", "name":"distance", "required":false, "schema":{ "format":"double", "type":"number" } }, { "description":"The unit of measure for the distance", "in":"query", "name":"uom", "required":false, "schema":{ "$ref":"#/components/schemas/UnitOfMeasurement" } }, { "description":"The technology for the edges", "in":"query", "name":"technology", "required":false, "schema":{ "type":"string" } }, { "description":"The ratecode for the edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "type":"string" } }, { "description":"The offset for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The limit for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve a list of communication edges within a specific distance of a device", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":4809, "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-01-13T20:02:10.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500572", "entityId":10974, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1500571, "toNode":4839, "entityVersion":2, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500574", "createdDate":"2023-01-13T20:02:10.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1030)-BVRL01CA.SR-1-SCRM01CA.SR-1", "costValue3":100, "name":"BVRL01CA.SR-1-SCRM01CA.SR-1", "costValue2":100, "costValue1":100, "id":"1030", "createdUser":"", "ratecode":"100G" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of communication edges within a specific distance of a device", "x-internal-id":"topology-v2-edge-communication-center-vertex-eid-{eid}-get", "x-filename-id":"topology-v2-edge-communication-center-vertex-eid-eid-get" } }, "/topology/v2/edge/communication/location/eid/{loceid}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityid of the location", "in":"path", "name":"loceid", "required":true, "schema":{ "type":"string" } }, { "description":"The technology for the edges", "in":"query", "name":"technology", "required":false, "schema":{ "type":"string" } }, { "description":"The ratecode for the edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "type":"string" } }, { "description":"The node category for the devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "type":"string" } }, { "description":"The offset for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The limit for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve a list of communication edges terminated on a location", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":2777, "fromNodeBusinessObjectClass":"NetworkEntityCodeDAO", "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-01-28T20:36:00.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-3225026", "entityId":22724, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":3225027, "toNode":22723, "entityVersion":2, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-3225029", "createdDate":"2023-01-28T20:36:00.000Z", "toNodeBusinessObjectClass":"PropertyLocationDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(75106)-GE10 / 1", "costValue3":100, "name":"GE10 / 1", "costValue2":100, "costValue1":100, "id":"75106", "createdUser":"uimuser", "ratecode":"10GigE" } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of communication edges terminated on a location", "x-internal-id":"topology-v2-edge-communication-location-eid-{loceid}-get", "x-filename-id":"topology-v2-edge-communication-location-eid-loceid-get" } }, "/topology/v2/edge/communication/nec/eid/{neceid}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityid of the network entity code", "in":"path", "name":"neceid", "required":true, "schema":{ "type":"string" } }, { "description":"The technology for the edges", "in":"query", "name":"technology", "required":false, "schema":{ "type":"string" } }, { "description":"The ratecode for the edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "type":"string" } }, { "description":"The node category for the devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "type":"string" } }, { "description":"The offset for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The limit for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve a list of communication edges terminated on a network entity code", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":2777, "fromNodeBusinessObjectClass":"NetworkEntityCodeDAO", "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-01-28T20:36:00.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-3225026", "entityId":22724, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":3225027, "toNode":22723, "entityVersion":2, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-3225029", "createdDate":"2023-01-28T20:36:00.000Z", "toNodeBusinessObjectClass":"PropertyLocationDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(75106)-GE10 / 1", "costValue3":100, "name":"GE10 / 1", "costValue2":100, "costValue1":100, "id":"75106", "createdUser":"uimuser", "ratecode":"10GigE" } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of communication edges terminated on a network entity code", "x-internal-id":"topology-v2-edge-communication-nec-eid-{neceid}-get", "x-filename-id":"topology-v2-edge-communication-nec-eid-neceid-get" } }, "/topology/v2/edge/communication/network/{network}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityid of the network", "in":"path", "name":"network", "required":true, "schema":{ "type":"string" } }, { "description":"The technology for the edges", "in":"query", "name":"technology", "required":false, "schema":{ "type":"string" } }, { "description":"The ratecode for the edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "type":"string" } }, { "description":"The offset for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The limit for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve a list of communication edges in a network", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":4919, "isPipeInterfaceTerminated":true, "lastModifiedDate":"2023-01-13T23:17:02.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1580561", "entityId":12505, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":1580562, "toNode":5029, "entityVersion":1, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1580564", "createdDate":"2023-01-13T23:17:02.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2561)-KRNY01NJ.T-1 / NWRK01NJ.MC-1 / 1GigE / GE1 / 1", "costValue3":100, "name":"KRNY01NJ.T-1 / NWRK01NJ.MC-1 / 1GigE / GE1 / 1", "costValue2":100, "costValue1":100, "lastModifiedUser":"", "id":"2561", "createdUser":"", "ratecode":"1GigE" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of communication edges in a network", "x-internal-id":"topology-v2-edge-communication-network-{network}-get", "x-filename-id":"topology-v2-edge-communication-network-network-get" } }, "/topology/v2/edge/containment":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The fromnode entityid for the edges", "in":"query", "name":"fromnode", "required":false, "schema":{ "type":"string" } }, { "description":"The tonode label for the edges", "in":"query", "name":"tonode", "required":false, "schema":{ "type":"string" } }, { "description":"The fromnode label for the edges", "in":"query", "name":"fromnodeLabel", "required":false, "schema":{ "type":"string" } }, { "description":"The toNode label for the edges", "in":"query", "name":"tonodeLabel", "required":false, "schema":{ "type":"string" } }, { "description":"The edge label for the edges. Refer Valid Values section of Active Topology Automation Model Documentation for the list of values of EdgeLabel.", "in":"query", "name":"edgeLabel", "required":false, "schema":{ "type":"string" } }, { "description":"The fromNode id of the edges", "in":"query", "name":"fromnodeId", "required":false, "schema":{ "type":"string" } }, { "description":"The toNode id of the edges", "in":"query", "name":"tonodeId", "required":false, "schema":{ "type":"string" } } ], "description":"Retrieve a list of comtainment edges", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "fromNode":29210, "createdDate":"2023-03-11T04:41:40.000Z", "lastModifiedDate":"2023-03-11T04:41:40.000Z", "edgeType":"LOCATION_REGION", "autoSuggestName":"(null)-9413 MAIN ST PLANO TX 75000 US-Southwest", "name":"9413 MAIN ST PLANO TX 75000 US-Southwest", "entityId":29212, "lastModifiedUser":"uimuser", "businessObjectClass":"TopologyOnly", "createdUser":"uimuser", "toNode":29211 } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of containment edges", "x-internal-id":"topology-v2-edge-containment-get", "x-filename-id":"topology-v2-edge-containment-get" } }, "/topology/v2/edge/device/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityId of the device", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "description":"The edge label you want to retrieve. Refer Valid Values section of Active Topology Automation Model Documentation for the list of values of EdgeLabel. ", "in":"query", "name":"label", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an related device edges based on the device enityId and edge label", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "fromNode":5494, "createdDate":"2023-01-13T18:32:34.000Z", "lastModifiedDate":"2023-01-13T18:32:34.000Z", "edgeType":"DEVICE_LOCATION", "autoSuggestName":"(null)-LGRN01IL.T-1.LD-901 MEADOWCREST RD LA GRANGE PARK IL 60526 US", "name":"LGRN01IL.T-1.LD-901 MEADOWCREST RD LA GRANGE PARK IL 60526 US", "entityId":5497, "businessObjectClass":"TopologyOnly", "toNode":1444 } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edge retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an related device edges based on the device enityId and edge label", "x-internal-id":"topology-v2-edge-device-eid-{eid}-get", "x-filename-id":"topology-v2-edge-device-eid-eid-get" } }, "/topology/v2/edge/edges":{ "post":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The number of records to skip for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The maximum number of records to return for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Return a list of edges using an input Map containing typeId_referenceId and typeId", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "1_9167197":"1", "1_9161465":"1" } } }, "schema":{ "type":"object" } } }, "description":"The list of edges to return" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":4753, "isPipeInterfaceTerminated":false, "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500002", "referenceId":1500001, "entityVersion":2, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500004", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1000)-BRKL01NY.SR-1-BRKL02NY.SR-1", "costValue3":100, "costValue2":100, "costValue1":100, "id":"1000", "createdUser":"", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2023-01-13T20:00:09.000Z", "inventoryStatus":"INSTALLED", "entityId":10944, "technology":"WDM", "businessObjectClass":"PipeDAO", "toNode":4759, "createdDate":"2023-01-13T20:00:09.000Z", "specName":"DWDM_Fiber_Channel", "name":"BRKL01NY.SR-1-BRKL02NY.SR-1", "ratecode":"100G" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edges returned successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of Edges", "x-internal-id":"topology-v2-edge-edges-post", "x-filename-id":"topology-v2-edge-edges-post" } }, "/topology/v2/edge/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityId of the edge", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Edge based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":28865, "isPipeInterfaceTerminated":false, "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-7875069", "referenceId":7875071, "entityVersion":1, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-7875075", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(300032)-PLOC_G10_101.001 / PLOC_G10_104.001 / OC12 / OC12 / 1", "costValue3":100, "costValue2":100, "costValue1":100, "lastModifiedUser":"uimuser", "id":"300032", "createdUser":"uimuser", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2023-03-02T21:07:06.000Z", "inventoryStatus":"INSTALLED", "entityId":28876, "technology":"SONET", "businessObjectClass":"TDMFacilityDAO", "toNode":28856, "createdDate":"2023-03-02T21:07:06.000Z", "specName":"Channelized Facility", "name":"PLOC_G10_101.001 / PLOC_G10_104.001 / OC12 / OC12 / 1", "ratecode":"OC12" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edge retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Edge based on enityId", "x-internal-id":"topology-v2-edge-eid-{eid}-get", "x-filename-id":"topology-v2-edge-eid-eid-get" }, "patch":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entity id of edge", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Update cost of existing edge", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "costName":"Jitter", "value":40 } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Cost of edge to be updated as." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":1097, "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "isPipeInterfaceTerminated":true, "lastModifiedDate":"2023-03-10T07:27:32.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"BRCL01CT.SR-1", "entityId":1124, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":6, "toNode":1074, "entityVersion":2, "toNodeData":"MDRD01MD.SR-1.LD", "createdDate":"2023-03-08T13:09:12.000Z", "toNodeBusinessObjectClass":"NetworkEntityCodeDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1007)-BRCL01CT.SR-1-MDRD01MD.SR-1-UPD", "costValue3":100, "name":"BRCL01CT.SR-1-MDRD01MD.SR-1-UPD", "costValue2":100, "costValue1":40, "id":"1007", "properties":{ "prop2":"val2", "prop1":"val1" }, "ratecode":"40GigE" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Cost of edge is updated sucessfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update cost of existing edge", "x-internal-id":"topology-v2-edge-eid-{eid}-patch", "x-filename-id":"topology-v2-edge-eid-eid-patch" }, "delete":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityId of the edge", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Delete an existing edge based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The edge was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing edge based on the entityId", "x-internal-id":"topology-v2-edge-eid-{eid}-delete", "x-filename-id":"topology-v2-edge-eid-eid-delete" } }, "/topology/v2/edge/eids":{ "post":{ "tags":[ "Active Topology Automation/Edge" ], "description":"Return a list of edges using an input list", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":[ 28865, 28862 ] } }, "schema":{ "items":{ "format":"int64", "type":"integer" }, "type":"array" } } }, "description":"The list of entityIds to return" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "entityVersion":1, "fromNode":29338, "createdDate":"2023-03-17T21:30:48.000Z", "lastModifiedDate":"2023-03-17T21:30:48.000Z", "edgeType":"PARENT_DEVICE", "autoSuggestName":"(null)-VLNCL1VC.SR-1.LD-MDRDL1MD.SR-1.LD", "name":"VLNCL1VC.SR-1.LD-MDRDL1MD.SR-1.LD", "entityId":29340, "businessObjectClass":"TopologyOnly", "toNode":29333 }, { "entityVersion":1, "fromNode":24009, "createdDate":"2023-01-30T19:49:13.000Z", "lastModifiedDate":"2023-01-30T19:49:13.000Z", "edgeType":"PARENT_DEVICE", "autoSuggestName":"(null)-EquipmentShelfI-PhysicalDeviceI", "name":"EquipmentShelfI-PhysicalDeviceI", "entityId":24010, "businessObjectClass":"TopologyOnly", "toNode":24008 } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/Edge" }, "type":"array" } } }, "description":"New Event created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of edges using a list of entity ids", "x-internal-id":"topology-v2-edge-eids-post", "x-filename-id":"topology-v2-edge-eids-post" } }, "/topology/v2/edge/fromnode/{fromnode}/tonode/{tonode}":{ "delete":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The fromNode entityId of the edge", "in":"path", "name":"fromnode", "required":true, "schema":{ "type":"string" } }, { "description":"The toNode entityId of the edge", "in":"path", "name":"tonode", "required":true, "schema":{ "type":"string" } }, { "description":"The label of the edge", "in":"query", "name":"label", "required":false, "schema":{ "type":"string" } } ], "description":"Delete an existing edge based on the fromNode and the toNode", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The edge was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing edge based on the fromNode and the toNode", "x-internal-id":"topology-v2-edge-fromnode-{fromnode}-tonode-{tonode}-delete", "x-filename-id":"topology-v2-edge-fromnode-fromnode-tonode-tonode-delete" } }, "/topology/v2/edge/network/{network}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityid of the network", "in":"path", "name":"network", "required":true, "schema":{ "type":"string" } }, { "description":"The technology for the edges", "in":"query", "name":"technology", "required":false, "schema":{ "type":"string" } }, { "description":"The ratecode for the edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "type":"string" } } ], "description":"Retrieve a list of communication edges, nodes and alarms in a network", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "nodes":[ ], "edges":[ ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of communication edges, nodes and alarms in a network", "x-internal-id":"topology-v2-edge-network-{network}-get", "x-filename-id":"topology-v2-edge-network-network-get" } }, "/topology/v2/edge/typeid/{typeid}/referenceid/{referenceid}":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The typeId of the edge", "in":"path", "name":"typeid", "required":true, "schema":{ "type":"string" } }, { "description":"The referenceId of the edge", "in":"path", "name":"referenceid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Edge based on typeId and referenceId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":28865, "isPipeInterfaceTerminated":false, "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-7875069", "referenceId":7875071, "entityVersion":1, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-7875075", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(300032)-PLOC_G10_101.001 / PLOC_G10_104.001 / OC12 / OC12 / 1", "costValue3":100, "costValue2":100, "costValue1":100, "lastModifiedUser":"uimuser", "id":"300032", "createdUser":"uimuser", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2023-03-02T21:07:06.000Z", "inventoryStatus":"INSTALLED", "entityId":28876, "technology":"SONET", "businessObjectClass":"TDMFacilityDAO", "toNode":28856, "createdDate":"2023-03-02T21:07:06.000Z", "specName":"Channelized Facility", "name":"PLOC_G10_101.001 / PLOC_G10_104.001 / OC12 / OC12 / 1", "ratecode":"OC12" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edge retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Edge based on typeId and referenceId", "x-internal-id":"topology-v2-edge-typeid-{typeid}-referenceid-{referenceid}-get", "x-filename-id":"topology-v2-edge-typeid-typeid-referenceid-referenceid-get" }, "patch":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The type id of edge", "in":"path", "name":"typeid", "required":true, "schema":{ "type":"string" } }, { "description":"The reference id of edge", "in":"path", "name":"referenceid", "required":true, "schema":{ "type":"string" } } ], "description":"Update cost of existing edge", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "costName":"Latency", "value":20 } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Cost of edge to be updated as." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":1097, "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "isPipeInterfaceTerminated":true, "lastModifiedDate":"2023-03-10T07:07:06.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"MDRD01MD.SR-1.LD", "entityId":1120, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":2, "toNode":1102, "entityVersion":1, "toNodeData":"VLNC01VC.SR-1.LD", "createdDate":"2023-03-08T13:09:12.000Z", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1003)-MDRD01MD.SR-1-VLNC01VC.SR-1", "costValue3":100, "name":"MDRD01MD.SR-1-VLNC01VC.SR-1", "costValue2":20, "costValue1":100, "id":"1003", "ratecode":"40GigE" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Cost of edge is updated sucessfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update cost of existing edge", "x-internal-id":"topology-v2-edge-typeid-{typeid}-referenceid-{referenceid}-patch", "x-filename-id":"topology-v2-edge-typeid-typeid-referenceid-referenceid-patch" }, "delete":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The typeId of the edge", "in":"path", "name":"typeid", "required":true, "schema":{ "type":"string" } }, { "description":"The referenceId of the edge", "in":"path", "name":"referenceid", "required":true, "schema":{ "type":"string" } } ], "description":"Delete an existing edge based on typeId and referenceId", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The edge was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing edge based on typeId and referenceId", "x-internal-id":"topology-v2-edge-typeid-{typeid}-referenceid-{referenceid}-delete", "x-filename-id":"topology-v2-edge-typeid-typeid-referenceid-referenceid-delete" } }, "/topology/v2/edge/vertex/eid/{eid}/hierarchy":{ "get":{ "tags":[ "Active Topology Automation/Edge" ], "parameters":[ { "description":"The entityid for the location", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "description":"The offset for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The limit for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve the location hierarchy down", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "entityVersion":1, "fromNode":29326, "createdDate":"2023-03-17T21:30:43.000Z", "lastModifiedDate":"2023-03-17T21:30:43.000Z", "edgeType":"LOCATED_AT", "autoSuggestName":"(null)-LGNSL1MD.MC-1-LGNSL1MD", "name":"LGNSL1MD.MC-1-LGNSL1MD", "entityId":29327, "businessObjectClass":"TopologyOnly", "toNode":29325 }, { "entityVersion":1, "fromNode":29355, "createdDate":"2023-03-17T21:30:51.000Z", "lastModifiedDate":"2023-03-17T21:30:51.000Z", "edgeType":"DEVICE_LOCATION", "autoSuggestName":"(null)-LGNSL1MD.MC-1.LD-LGNSL1MD", "name":"LGNSL1MD.MC-1.LD-LGNSL1MD", "entityId":29357, "businessObjectClass":"TopologyOnly", "toNode":29325 }, { "entityVersion":1, "fromNode":29355, "createdDate":"2023-03-17T21:30:51.000Z", "lastModifiedDate":"2023-03-17T21:30:51.000Z", "edgeType":"IDENTIFIED_BY", "autoSuggestName":"(null)-LGNSL1MD.MC-1.LD-LGNSL1MD.MC-1", "name":"LGNSL1MD.MC-1.LD-LGNSL1MD.MC-1", "entityId":29358, "businessObjectClass":"TopologyOnly", "toNode":29326 } ] } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the location hierarchy down", "x-internal-id":"topology-v2-edge-vertex-eid-{eid}-hierarchy-get", "x-filename-id":"topology-v2-edge-vertex-eid-eid-hierarchy-get" } }, "/topology/v2/graph/costMapping":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "description":"Retrieves cost mappings on communication edge that are configured in topology-config.yaml", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "costValue3":"Distance", "costValue2":"Latency", "costValue1":"Jitter" } } }, "schema":{ "items":{ "type":"string" }, "type":"array" } } }, "description":"Retrieved cost mappings sucessfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve cost mappings on communication edge", "x-internal-id":"topology-v2-graph-costMapping-get", "x-filename-id":"topology-v2-graph-costmapping-get" } }, "/topology/v2/graph/edge":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "parameters":[ { "description":"The edge labels to be searched", "in":"query", "name":"label", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The edge properties to be searched", "in":"query", "name":"property", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"Return All Edges", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":4753, "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-01-13T20:00:09.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500002", "entityId":10944, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1500001, "toNode":4759, "entityVersion":2, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-1500004", "createdDate":"2023-01-13T20:00:09.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1000)-BRKL01NY.SR-1-BRKL02NY.SR-1", "costValue3":100, "name":"BRKL01NY.SR-1-BRKL02NY.SR-1", "costValue2":100, "costValue1":100, "id":"1000", "createdUser":"", "ratecode":"100G" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve All Edges", "x-internal-id":"topology-v2-graph-edge-get", "x-filename-id":"topology-v2-graph-edge-get" } }, "/topology/v2/graph/edge/count":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "description":"Return the count of Edges", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":28380 } }, "schema":{ "format":"int64", "type":"integer" } } }, "description":"Count of Edges retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the count of Edges", "x-internal-id":"topology-v2-graph-edge-count-get", "x-filename-id":"topology-v2-graph-edge-count-get" } }, "/topology/v2/graph/edge/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "parameters":[ { "description":"The entityId of the edge", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Edge based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "fromNode":28865, "isPipeInterfaceTerminated":false, "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-7875069", "referenceId":7875071, "entityVersion":1, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-7875075", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(300032)-PLOC_G10_101.001 / PLOC_G10_104.001 / OC12 / OC12 / 1", "costValue3":100, "costValue2":100, "costValue1":100, "lastModifiedUser":"uimuser", "id":"300032", "createdUser":"uimuser", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2023-03-02T21:07:06.000Z", "inventoryStatus":"INSTALLED", "entityId":28876, "technology":"SONET", "businessObjectClass":"TDMFacilityDAO", "toNode":28856, "createdDate":"2023-03-02T21:07:06.000Z", "specName":"Channelized Facility", "name":"PLOC_G10_101.001 / PLOC_G10_104.001 / OC12 / OC12 / 1", "ratecode":"OC12" } } }, "schema":{ "$ref":"#/components/schemas/Edge" } } }, "description":"Edge retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Edge based on enityId", "x-internal-id":"topology-v2-graph-edge-eid-{eid}-get", "x-filename-id":"topology-v2-graph-edge-eid-eid-get" } }, "/topology/v2/graph/excludeAlarmTypes":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "description":"Retrieves alarm types which will be populated in excludeAlarmTypes drop down of Path analysis search criteria in UIM UI", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ "Critical and Greater", "Major and Greater", "Minor and Greater" ] } }, "schema":{ "type":"string" } } }, "description":"Retrieved alarm types sucessfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve alarm types that needs to be excluded while doing path analysis", "x-internal-id":"topology-v2-graph-excludeAlarmTypes-get", "x-filename-id":"topology-v2-graph-excludealarmtypes-get" } }, "/topology/v2/graph/paths":{ "post":{ "tags":[ "Active Topology Automation/Graph" ], "description":"Retrieve paths that are matching the search criteria, mentioned in the form of properties in request", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "destinationEntityId":"1102", "numberOfHops":10, "sourceEntityId":"1097", "algorithm":"Any" } } }, "schema":{ "$ref":"#/components/schemas/PathAnalysisCriteria" } } }, "description":"Search criteria to find paths. Map containing criteria defined in PathAnalysisCriteria Enum class only can be given in request." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "destination":{ "latitude":39.47, "networkStatus":"", "ipv6Subnet":"", "referenceId":4, "entityVersion":2, "deviceIdentifier":"", "ipv4":"", "ipv6":"", "availablePositions":"", "autoSuggestName":"(VLNC01VC.SR-1)-VLNC01VC.SR-1.LD", "zoneId":"", "lastModifiedUser":"", "id":"VLNC01VC.SR-1", "activeEvent":999, "createdUser":"", "longitude":-0.3764, "lastModifiedDate":"2023-03-08T13:09:09.000Z", "inventoryStatus":"", "equipmentCategory":"", "entityId":1102, "nodeCategory":"", "nodeType":"", "businessObjectClass":"LogicalDeviceDAO", "macAddress":"", "createdDate":"2023-03-08T13:09:09.000Z", "specName":"GenericDevice", "name":"VLNC01VC.SR-1.LD", "occupiedPositions":"", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "ipv4Subnet":"", "properties":{ "prop2":"val2", "prop1":"val1" } }, "edges":[ { "fromNode":1097, "isPipeInterfaceTerminated":true, "lastModifiedDate":"2023-03-10T07:07:06.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"MDRD01MD.SR-1.LD", "entityId":1120, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":2, "toNode":1102, "entityVersion":1, "toNodeData":"VLNC01VC.SR-1.LD", "createdDate":"2023-03-08T13:09:12.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1003)-MDRD01MD.SR-1-VLNC01VC.SR-1", "costValue3":100, "name":"MDRD01MD.SR-1-VLNC01VC.SR-1", "costValue2":20, "costValue1":100, "lastModifiedUser":"", "id":"1003", "createdUser":"", "ratecode":"40GigE" } ], "source":{ "latitude":40.4167, "networkStatus":"", "ipv6Subnet":"", "referenceId":3, "entityVersion":2, "deviceIdentifier":"", "ipv4":"", "ipv6":"", "availablePositions":"", "autoSuggestName":"(MDRD01MD.SR-1)-MDRD01MD.SR-1.LD", "zoneId":"", "lastModifiedUser":"", "id":"MDRD01MD.SR-1", "activeEvent":999, "createdUser":"", "longitude":-3.7167, "lastModifiedDate":"2023-03-08T13:09:08.000Z", "inventoryStatus":"", "equipmentCategory":"", "entityId":1097, "nodeCategory":"", "nodeType":"", "businessObjectClass":"LogicalDeviceDAO", "macAddress":"", "createdDate":"2023-03-08T13:09:08.000Z", "specName":"GenericDevice", "name":"MDRD01MD.SR-1.LD", "occupiedPositions":"", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "ipv4Subnet":"", "properties":{ "prop1":"val1" } } } ] } }, "schema":{ "$ref":"#/components/schemas/Path" } } }, "description":"Retrieved paths sucessfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve paths that are matching the search criteria, mentioned in the form of properties in request", "x-internal-id":"topology-v2-graph-paths-post", "x-filename-id":"topology-v2-graph-paths-post" }, "get":{ "tags":[ "Active Topology Automation/Graph" ], "description":"Retrieve paths that are matching the search criteria, mentioned in the form of properties in request", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "destinationEntityId":"1102", "numberOfHops":10, "sourceEntityId":"1097", "algorithm":"Any" } } }, "schema":{ "$ref":"#/components/schemas/PathAnalysisCriteria" } } }, "description":"Search criteria to find paths. Map containing criteria defined in PathAnalysisCriteria Enum class only can be given in request." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "destination":{ "latitude":39.47, "networkStatus":"", "ipv6Subnet":"", "referenceId":4, "entityVersion":2, "deviceIdentifier":"", "ipv4":"", "ipv6":"", "availablePositions":"", "autoSuggestName":"(VLNC01VC.SR-1)-VLNC01VC.SR-1.LD", "zoneId":"", "lastModifiedUser":"", "id":"VLNC01VC.SR-1", "activeEvent":999, "createdUser":"", "longitude":-0.3764, "lastModifiedDate":"2023-03-08T13:09:09.000Z", "inventoryStatus":"", "equipmentCategory":"", "entityId":1102, "nodeCategory":"", "nodeType":"", "businessObjectClass":"LogicalDeviceDAO", "macAddress":"", "createdDate":"2023-03-08T13:09:09.000Z", "specName":"GenericDevice", "name":"VLNC01VC.SR-1.LD", "occupiedPositions":"", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "ipv4Subnet":"", "properties":{ "prop2":"val2", "prop1":"val1" } }, "edges":[ { "fromNode":1097, "isPipeInterfaceTerminated":true, "lastModifiedDate":"2023-03-10T07:07:06.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"MDRD01MD.SR-1.LD", "entityId":1120, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":2, "toNode":1102, "entityVersion":1, "toNodeData":"VLNC01VC.SR-1.LD", "createdDate":"2023-03-08T13:09:12.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1003)-MDRD01MD.SR-1-VLNC01VC.SR-1", "costValue3":100, "name":"MDRD01MD.SR-1-VLNC01VC.SR-1", "costValue2":20, "costValue1":100, "lastModifiedUser":"", "id":"1003", "createdUser":"", "ratecode":"40GigE" } ], "source":{ "latitude":40.4167, "networkStatus":"", "ipv6Subnet":"", "referenceId":3, "entityVersion":2, "deviceIdentifier":"", "ipv4":"", "ipv6":"", "availablePositions":"", "autoSuggestName":"(MDRD01MD.SR-1)-MDRD01MD.SR-1.LD", "zoneId":"", "lastModifiedUser":"", "id":"MDRD01MD.SR-1", "activeEvent":999, "createdUser":"", "longitude":-3.7167, "lastModifiedDate":"2023-03-08T13:09:08.000Z", "inventoryStatus":"", "equipmentCategory":"", "entityId":1097, "nodeCategory":"", "nodeType":"", "businessObjectClass":"LogicalDeviceDAO", "macAddress":"", "createdDate":"2023-03-08T13:09:08.000Z", "specName":"GenericDevice", "name":"MDRD01MD.SR-1.LD", "occupiedPositions":"", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "ipv4Subnet":"", "properties":{ "prop1":"val1" } } } ] } }, "schema":{ "$ref":"#/components/schemas/Path" } } }, "description":"Retrieved paths sucessfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve paths that are matching the search criteria, mentioned in the form of properties in request", "x-internal-id":"topology-v2-graph-paths-get", "x-filename-id":"topology-v2-graph-paths-get" } }, "/topology/v2/graph/shortest-path/source/{src}/destination/{dest}":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "parameters":[ { "description":"The entityId of the source Vertex", "in":"path", "name":"src", "required":true, "schema":{ "type":"string" } }, { "description":"The entityId of the destination Vertex", "in":"path", "name":"dest", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve shortest path from source to destination", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "destination":{ "latitude":12.845, "networkStatus":"", "ipv6Subnet":"", "referenceId":73, "entityVersion":5, "deviceIdentifier":"", "ipv4":"", "ipv6":"", "availablePositions":"", "autoSuggestName":"(BANG01.ECT-2)-BANG01.ECT-2.LD", "zoneId":"", "lastModifiedUser":"", "id":"BANG01.ECT-2", "activeEvent":999, "createdUser":"", "longitude":77.66, "lastModifiedDate":"2023-03-29T18:35:12.000Z", "inventoryStatus":"", "equipmentCategory":"", "entityId":1210, "nodeCategory":"", "nodeType":"", "businessObjectClass":"LogicalDeviceDAO", "macAddress":"", "createdDate":"2023-03-23T16:21:43.000Z", "specName":"Packet Network Device", "name":"BANG01.ECT-2.LD", "occupiedPositions":"", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "ipv4Subnet":"" }, "edges":[ { "fromNode":1204, "isPipeInterfaceTerminated":true, "lastModifiedDate":"2023-03-23T16:21:44.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"HYD01.CT-1.LD", "entityId":1238, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":62, "toNode":1210, "entityVersion":1, "toNodeData":"BANG01.ECT-2.LD", "createdDate":"2023-03-23T16:21:44.000Z", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1016)-HYD01.CT-1-BANG01.ECT-2", "costValue3":100, "name":"HYD01.CT-1-BANG01.ECT-2", "costValue2":100, "costValue1":100, "lastModifiedUser":"", "id":"1016", "createdUser":"", "ratecode":"10GigE" } ], "source":{ "latitude":19.076, "networkStatus":"", "ipv6Subnet":"", "referenceId":71, "entityVersion":4, "deviceIdentifier":"", "ipv4":"", "ipv6":"", "availablePositions":"", "autoSuggestName":"(HYD01.CT-1)-HYD01.CT-1.LD", "zoneId":"", "lastModifiedUser":"", "id":"HYD01.CT-1", "activeEvent":999, "createdUser":"", "longitude":72.877, "lastModifiedDate":"2023-03-28T09:15:08.000Z", "inventoryStatus":"", "equipmentCategory":"", "entityId":1204, "nodeCategory":"", "nodeType":"", "businessObjectClass":"LogicalDeviceDAO", "macAddress":"", "createdDate":"2023-03-23T16:21:43.000Z", "specName":"Packet Network Device", "name":"HYD01.CT-1.LD", "occupiedPositions":"", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "ipv4Subnet":"" } } } }, "schema":{ "type":"object" } } }, "description":"Path retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve shortest path from source to destination", "x-internal-id":"topology-v2-graph-shortest-path-source-{src}-destination-{dest}-get", "x-filename-id":"topology-v2-graph-shortest-path-source-src-destination-dest-get" } }, "/topology/v2/graph/vertex":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "parameters":[ { "description":"The vertex labels to be searched", "in":"query", "name":"label", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vertex properties to be searched", "in":"query", "name":"property", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"Return All Vertices", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":0, "createdDate":"2023-01-13T22:47:45.000Z", "lastModifiedDate":"2023-01-13T22:47:45.000Z", "autoSuggestName":"(1234)-Cisco", "name":"Cisco", "entityId":4743, "lastModifiedUser":"anonymous", "businessObjectClass":"VendorDAO", "createdUser":"anonymous" } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertices retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve All Vertices", "x-internal-id":"topology-v2-graph-vertex-get", "x-filename-id":"topology-v2-graph-vertex-get" } }, "/topology/v2/graph/vertex/count":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "description":"Return the count of Vertices", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":9093 } }, "schema":{ "format":"int64", "type":"integer" } } }, "description":"Count of Vertices retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the count of Vertices", "x-internal-id":"topology-v2-graph-vertex-count-get", "x-filename-id":"topology-v2-graph-vertex-count-get" } }, "/topology/v2/graph/vertex/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Graph" ], "parameters":[ { "description":"The entityId of the Vertex", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Vertex based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "latitude":0, "networkStatus":"", "ipv6Subnet":"", "referenceId":3430525, "entityVersion":1, "deviceIdentifier":"E75981", "ipv4":"", "ipv6":"", "availablePositions":"", "autoSuggestName":"(75202)-E75981", "zoneId":"", "lastModifiedUser":"", "id":"75202", "activeEvent":999, "createdUser":"", "longitude":0, "lastModifiedDate":"2023-03-24T03:19:10.000Z", "inventoryStatus":"INSTALLED", "equipmentCategory":"", "entityId":21981, "nodeCategory":"", "nodeType":"", "businessObjectClass":"LogicalDeviceDAO", "macAddress":"", "createdDate":"2023-03-24T03:19:10.000Z", "specName":"channelized_packet_hybrid", "name":"E75981", "occupiedPositions":"", "ipv4Subnet":"" } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Vertex based on enityId", "x-internal-id":"topology-v2-graph-vertex-eid-{eid}-get", "x-filename-id":"topology-v2-graph-vertex-eid-eid-get" } }, "/topology/v2/profile":{ "post":{ "tags":[ "Active Topology Automation/Profile" ], "description":"Create a new Profile .", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "entityVersion":0, "zoomLevel":0, "profileEdges":[ { "entityVersion":0, "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:41:17.076Z", "profile":0, "entityId":0, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:41:17.076Z", "name":"dev_zdevice", "exclude":false, "id":"5475003", "device":100155343 }, "createdDate":"2023-03-06T15:41:17.161Z", "lastModifiedDate":"2023-03-06T15:41:17.161Z", "profile":0, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":0, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:41:17.076Z", "profile":0, "entityId":0, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:41:17.076Z", "name":"dev_ydevice", "exclude":false, "id":"5475002", "device":100155341 } } ], "createdDate":"2023-03-06T15:41:16.865Z", "lastModifiedDate":"2023-03-06T15:41:16.865Z", "name":"dev_service:dev_service - 1", "refresh":false, "entityId":0, "id":"5100001:1", "profileVertices":[ { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:41:17.076Z", "profile":0, "entityId":0, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:41:17.076Z", "name":"dev_device", "exclude":false, "id":"5475001", "device":100155338 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:41:17.076Z", "profile":0, "entityId":0, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:41:17.076Z", "name":"dev_zdevice", "exclude":false, "id":"5475003", "device":100155343 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:41:17.076Z", "profile":0, "entityId":0, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:41:17.076Z", "name":"dev_ydevice", "exclude":false, "id":"5475002", "device":100155341 } ], "businessObjectClass":"ServiceConfigurationVersionDAO", "referenceId":118500001 } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"Profile object to be created." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "zoomLevel":0, "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "lastModifiedDate":"2023-03-06T15:55:47.892Z", "refresh":false, "entityId":100155358, "businessObjectClass":"ServiceConfigurationVersionDAO", "referenceId":118500005, "entityVersion":0, "profileEdges":[ { "entityVersion":0, "createdDate":"2023-03-06T15:55:48.180Z", "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, "lastModifiedDate":"2023-03-06T15:55:48.180Z", "profile":100155358, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":100155362, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } } ], "createdDate":"2023-03-06T15:55:47.892Z", "name":"dev_service:dev_service - 3", "id":"5100001:3", "profileVertices":[ { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:55:48.105Z", "profile":100155358, "entityId":100155359, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:55:48.105Z", "name":"dev_device", "exclude":false, "id":"5475001", "device":100155338 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:55:48.107Z", "profile":100155358, "entityId":100155360, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:55:48.107Z", "name":"dev_zdevice", "exclude":false, "id":"5475003", "device":100155343 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:55:48.108Z", "profile":100155358, "entityId":100155361, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:55:48.108Z", "name":"dev_ydevice", "exclude":false, "id":"5475002", "device":100155341 } ] } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"JSON response after creating the Profile" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a new Profile", "x-internal-id":"topology-v2-profile-post", "x-filename-id":"topology-v2-profile-post" }, "put":{ "tags":[ "Active Topology Automation/Profile" ], "description":"Update an existing Profile.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "zoomLevel":0, "lastModifiedDate":"2023-03-06T15:55:47.892Z", "refresh":false, "entityId":100155358, "businessObjectClass":"ServiceConfigurationVersionDAO", "referenceId":118500005, "entityVersion":0, "profileEdges":[ { "entityVersion":0, "createdDate":"2023-03-06T15:55:48.180Z", "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, "lastModifiedDate":"2023-03-06T15:55:48.180Z", "profile":100155358, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":100155362, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } } ], "createdDate":"2023-03-06T15:55:47.892Z", "name":"dev_service:dev_service - 3", "id":"5100001:3", "profileVertices":[ { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:55:48.105Z", "profile":100155358, "entityId":100155359, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:55:48.105Z", "name":"dev_device", "exclude":false, "id":"5475001", "device":100155338 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:55:48.107Z", "profile":100155358, "entityId":100155360, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:55:48.107Z", "name":"dev_zdevice", "exclude":false, "id":"5475003", "device":100155343 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:55:48.108Z", "profile":100155358, "entityId":100155361, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:55:48.108Z", "name":"dev_ydevice", "exclude":false, "id":"5475002", "device":100155341 } ], "status":"CANCELLED" } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"Profile to be updated as." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "profileEdges":[ { "entityVersion":1, "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, "profile":100155358, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":100155362, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } } ], "zoomLevel":0, "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "name":"dev_service:dev_service - 3", "refresh":false, "entityId":100155358, "id":"5100001:3", "profileVertices":[ { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155358, "entityId":100155359, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_device", "exclude":false, "location":0, "id":"5475001", "device":100155338 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155358, "entityId":100155360, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155358, "entityId":100155361, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } ], "businessObjectClass":"ServiceConfigurationVersionDAO", "referenceId":118500005 } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"JSON response after updating the Profile" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Profile", "x-internal-id":"topology-v2-profile-put", "x-filename-id":"topology-v2-profile-put" } }, "/topology/v2/profile/data/eid/{eid}":{ "delete":{ "tags":[ "Active Topology Automation/Profile" ], "parameters":[ { "description":"The entity id of the Profile whose nodes and edges are to be deleted", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Delete an existing Profile nodes and edges.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":2, "profileEdges":[ ], "zoomLevel":0, "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "name":"dev_service:dev_service - 3", "refresh":false, "entityId":100155358, "id":"5100001:3", "profileVertices":[ ], "businessObjectClass":"ServiceConfigurationVersionDAO", "referenceId":118500005 } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"JSON response after delete the Profile nodes and edges" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing Profile nodes and edges", "x-internal-id":"topology-v2-profile-data-eid-{eid}-delete", "x-filename-id":"topology-v2-profile-data-eid-eid-delete" } }, "/topology/v2/profile/referenceId/service/id/{id}/version/{version}":{ "get":{ "tags":[ "Active Topology Automation/Profile" ], "parameters":[ { "description":"The id of the service", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The version of the service for which profile has to be fetched", "in":"path", "name":"version", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Profile reference id based on service and version", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ "225007" ] } }, "schema":{ "items":{ "type":"string" }, "type":"array" } } }, "description":"JSON response after retrieving the Profile reference Id" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Profile reference id based on service and version", "x-internal-id":"topology-v2-profile-referenceId-service-id-{id}-version-{version}-get", "x-filename-id":"topology-v2-profile-referenceid-service-id-id-version-version-get" } }, "/topology/v2/profile/service/id/{id}":{ "get":{ "tags":[ "Active Topology Automation/Profile" ], "parameters":[ { "description":"Version of the profile to be retrieved. Latest version can be retreived by passing \"latest\" as input.", "example":1, "in":"query", "name":"version", "schema":{ "type":"string" } }, { "description":"The id of the service.", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve Profile based on service id and version number.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "profileEdges":[ { "entityVersion":1, "edge":{ "fromNode":100155341, "isPipeInterfaceTerminated":true, "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-109500002", "referenceId":109500003, "entityVersion":3, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-109500005", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(5250001)-YYY / ZZZ / 1GigE / GE1 / 23", "costValue3":100, "costValue2":100, "costValue1":100, "lastModifiedUser":"uimuser", "id":"5250001", "createdUser":"uimuser", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2023-03-06T10:09:46.000Z", "inventoryStatus":"INSTALLED", "entityId":100155339, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":100155343, "createdDate":"2023-03-06T10:07:07.000Z", "specName":"INNI Connectivity", "name":"YYY / ZZZ / 1GigE / GE1 / 23", "ratecode":"1GigE" }, "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, "profile":100155347, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":100155351, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } } ], "zoomLevel":0, "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "name":"dev_service:dev_service - 1", "refresh":false, "entityId":100155347, "id":"5100001:1", "profileVertices":[ { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "vertex":{ "lastModifiedDate":"2023-03-06T10:05:22.000Z", "inventoryStatus":"INSTALLED", "latitude":0, "entityId":100155338, "businessObjectClass":"LogicalDeviceDAO", "referenceId":111000001, "entityVersion":1, "createdDate":"2023-03-06T10:05:22.000Z", "specName":"Packet Network Device", "autoSuggestName":"(5475001)-dev_device", "name":"dev_device", "lastModifiedUser":"uimuser", "id":"5475001", "activeEvent":999, "createdUser":"uimuser", "longitude":0 }, "profile":100155347, "entityId":100155348, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_device", "exclude":false, "location":0, "id":"5475001", "device":100155338 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "vertex":{ "lastModifiedDate":"2023-03-06T10:08:22.000Z", "inventoryStatus":"INSTALLED", "latitude":40.0591, "entityId":100155343, "businessObjectClass":"LogicalDeviceDAO", "referenceId":111000031, "entityVersion":2, "createdDate":"2023-03-06T10:08:22.000Z", "deviceIdentifier":"dev_zdevice", "specName":"Packet Network Device", "autoSuggestName":"(5475003)-dev_zdevice", "name":"dev_zdevice", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"5475003", "activeEvent":999, "createdUser":"uimuser", "longitude":-4.1974 }, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "vertex":{ "lastModifiedDate":"2023-03-06T10:07:52.000Z", "inventoryStatus":"INSTALLED", "latitude":40.1433, "entityId":100155341, "businessObjectClass":"LogicalDeviceDAO", "referenceId":111000016, "entityVersion":2, "createdDate":"2023-03-06T10:07:52.000Z", "deviceIdentifier":"dev_ydevice", "specName":"Packet Network Device", "autoSuggestName":"(5475002)-dev_ydevice", "name":"dev_ydevice", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"5475002", "activeEvent":999, "createdUser":"uimuser", "longitude":-3.4258 }, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } ], "businessObjectClass":"ServiceConfigurationVersionDAO", "referenceId":118500001 } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"JSON response after retrieveing the profile." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve Profile based on service id", "x-internal-id":"topology-v2-profile-service-id-{id}-get", "x-filename-id":"topology-v2-profile-service-id-id-get" } }, "/topology/v2/profile/service/id/{id}/version/{version}":{ "get":{ "tags":[ "Active Topology Automation/Profile" ], "parameters":[ { "description":"The id of the service", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The version of the service to be used for auto-suggest", "in":"path", "name":"version", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve service configuration versions based on service id and autosuggest version number", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ "1 - (19)" ] } }, "schema":{ "items":{ "type":"string" }, "type":"array" } } }, "description":"JSON response after retrieving versions based on version autosuggest" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve service configuration versions based on service id and autosuggest version number", "x-internal-id":"topology-v2-profile-service-id-{id}-version-{version}-get", "x-filename-id":"topology-v2-profile-service-id-id-version-version-get" } }, "/topology/v2/profile/service/name/{name}":{ "get":{ "tags":[ "Active Topology Automation/Profile" ], "parameters":[ { "description":"The name of the service to be used for auto-suggest", "in":"path", "name":"name", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve service displayInfo based on autosuggest name", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ "(31) - BS", "(4) - CORE_NetworkSliceSubnet-hyd_A155_4", "(5) - CORE_NetworkSliceSubnet-hyd_A155_5", "(7) - CORE_NetworkSliceSubnet-hyd_A155_7", "(8) - CORE_NetworkSliceSubnet-hyd_A155_8", "(20) - CORE_NetworkSliceSubnet-hyd_A156_20", "(21) - CORE_NetworkSliceSubnet-hyd_A156_21", "(23) - CORE_NetworkSliceSubnet-hyd_A156_23", "(2) - NetworkSlice-hyd_A155", "(19) - NetworkSlice-hyd_A156", "(17) - POTSService_2091", "(14) - POTSService_2091", "(40) - POTSService_2091", "(30) - POTSService_2091", "(15) - QA", "(10) - RAN_NetworkSliceSubnet-hyd_A155_10", "(11) - RAN_NetworkSliceSubnet-hyd_A155_11", "(27) - RAN_NetworkSliceSubnet-hyd_A156_27", "(28) - RAN_NetworkSliceSubnet-hyd_A156_28", "(12) - TRANS_NetworkSliceSubnet-hyd_A155_12", "(29) - TRANS_NetworkSliceSubnet-hyd_A156_29", "(43) - ch_purge", "(42) - custsvc", "(1) - hyd_A155", "(18) - hyd_A156", "(44) - pug_check", "(37) - purge_check", "(39) - purge_qa1" ] } }, "schema":{ "items":{ "type":"string" }, "type":"array" } } }, "description":"JSON response after retriving the services by auto-suggest on name" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve service displayInfo based on autosuggest name", "x-internal-id":"topology-v2-profile-service-name-{name}-get", "x-filename-id":"topology-v2-profile-service-name-name-get" } }, "/topology/v2/profile/typeid/{typeid}/referenceid/{referenceid}":{ "get":{ "tags":[ "Active Topology Automation/Profile" ], "parameters":[ { "description":"The type Id of the profile business object class", "in":"path", "name":"typeid", "required":true, "schema":{ "type":"string" } }, { "description":"The reference Id of the profile", "in":"path", "name":"referenceid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Profile based on type id and reference id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "profileEdges":[ { "entityVersion":1, "edge":{ "fromNode":100155341, "isPipeInterfaceTerminated":true, "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-109500002", "referenceId":109500003, "entityVersion":3, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-109500005", "toNodeBusinessObjectClass":"LogicalDeviceDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(5250001)-YYY / ZZZ / 1GigE / GE1 / 23", "costValue3":100, "costValue2":100, "costValue1":100, "lastModifiedUser":"uimuser", "id":"5250001", "createdUser":"uimuser", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2023-03-06T10:09:46.000Z", "inventoryStatus":"INSTALLED", "entityId":100155339, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":100155343, "createdDate":"2023-03-06T10:07:07.000Z", "specName":"INNI Connectivity", "name":"YYY / ZZZ / 1GigE / GE1 / 23", "ratecode":"1GigE" }, "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, "profile":100155347, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":100155351, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } } ], "zoomLevel":0, "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "name":"dev_service:dev_service - 1", "refresh":false, "entityId":100155347, "id":"5100001:1", "profileVertices":[ { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "vertex":{ "lastModifiedDate":"2023-03-06T10:05:22.000Z", "inventoryStatus":"INSTALLED", "latitude":0, "entityId":100155338, "businessObjectClass":"LogicalDeviceDAO", "referenceId":111000001, "entityVersion":1, "createdDate":"2023-03-06T10:05:22.000Z", "specName":"Packet Network Device", "autoSuggestName":"(5475001)-dev_device", "name":"dev_device", "lastModifiedUser":"uimuser", "id":"5475001", "activeEvent":999, "createdUser":"uimuser", "longitude":0 }, "profile":100155347, "entityId":100155348, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_device", "exclude":false, "location":0, "id":"5475001", "device":100155338 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "vertex":{ "lastModifiedDate":"2023-03-06T10:08:22.000Z", "inventoryStatus":"INSTALLED", "latitude":40.0591, "entityId":100155343, "businessObjectClass":"LogicalDeviceDAO", "referenceId":111000031, "entityVersion":2, "createdDate":"2023-03-06T10:08:22.000Z", "deviceIdentifier":"dev_zdevice", "specName":"Packet Network Device", "autoSuggestName":"(5475003)-dev_zdevice", "name":"dev_zdevice", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"5475003", "activeEvent":999, "createdUser":"uimuser", "longitude":-4.1974 }, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, { "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "vertex":{ "lastModifiedDate":"2023-03-06T10:07:52.000Z", "inventoryStatus":"INSTALLED", "latitude":40.1433, "entityId":100155341, "businessObjectClass":"LogicalDeviceDAO", "referenceId":111000016, "entityVersion":2, "createdDate":"2023-03-06T10:07:52.000Z", "deviceIdentifier":"dev_ydevice", "specName":"Packet Network Device", "autoSuggestName":"(5475002)-dev_ydevice", "name":"dev_ydevice", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"5475002", "activeEvent":999, "createdUser":"uimuser", "longitude":-3.4258 }, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } ], "businessObjectClass":"ServiceConfigurationVersionDAO", "referenceId":118500001 } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"JSON response after retrieveing the profile" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve Profile based on type id and reference id", "x-internal-id":"topology-v2-profile-typeid-{typeid}-referenceid-{referenceid}-get", "x-filename-id":"topology-v2-profile-typeid-typeid-referenceid-referenceid-get" } }, "/topology/v2/profileEdge":{ "post":{ "tags":[ "Active Topology Automation/Profile" ], "description":"Create a new Profile Edge.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "entityVersion":0, "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:41:17.076Z", "profile":0, "entityId":0, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:41:17.076Z", "name":"dev_zdevice", "exclude":false, "id":"5475003", "device":100155343 }, "createdDate":"2023-03-06T15:41:17.161Z", "lastModifiedDate":"2023-03-06T15:41:17.161Z", "profile":0, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":0, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:41:17.076Z", "profile":0, "entityId":0, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:41:17.076Z", "name":"dev_ydevice", "exclude":false, "id":"5475002", "device":100155341 } } } }, "schema":{ "$ref":"#/components/schemas/ProfileEdge" } } }, "description":"ProfileEdge object to be created." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":0, "createdDate":"2023-03-06T15:55:48.180Z", "toProfileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155349, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_zdevice", "exclude":false, "location":0, "id":"5475003", "device":100155343 }, "lastModifiedDate":"2023-03-06T15:55:48.180Z", "profile":100155358, "name":"YYY / ZZZ / 1GigE / GE1 / 23", "entityId":100155362, "exclude":false, "id":"5250001", "communication":100155339, "businessObjectClass":"PacketConnectivityDAO", "profileNode":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "profile":100155347, "entityId":100155350, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "nec":0, "network":0, "entityVersion":1, "name":"dev_ydevice", "exclude":false, "location":0, "id":"5475002", "device":100155341 } } } }, "schema":{ "$ref":"#/components/schemas/ProfileEdge" } } }, "description":"JSON response after creating the Profile Edge" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a new Profile Edge", "x-internal-id":"topology-v2-profileEdge-post", "x-filename-id":"topology-v2-profileedge-post" } }, "/topology/v2/profileVertex":{ "post":{ "tags":[ "Active Topology Automation/Profile" ], "description":"Create a new Profile Vertex.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "vertex":100123461, "lastModifiedDate":"2023-03-06T15:55:48.180Z", "profile":100155364, "entityId":0, "xPos":0, "label":"null", "businessObjectClass":"LogicalDeviceDAO", "nec":100189363, "network":100125363, "entityVersion":0, "relationships":{ }, "createdDate":"2023-03-06T15:55:48.180Z", "name":"dev_dev2", "exclude":false, "lastModifiedUser":"null", "location":100156263, "id":"5475004", "device":100155363, "properties":{ }, "createdUser":"null" } } }, "schema":{ "$ref":"#/components/schemas/ProfileVertex" } } }, "description":"ProfileVertex object to be created." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "imageName":"oracle.communications.platform.entity.impl.MediaDAO-1381575223.png", "yPos":0, "lastModifiedDate":"2023-03-06T15:55:48.180Z", "profile":100155364, "entityId":100155366, "xPos":0, "businessObjectClass":"LogicalDeviceDAO", "entityVersion":0, "createdDate":"2023-03-06T15:55:48.180Z", "name":"dev_dev2", "exclude":false, "id":"5475004", "device":100155363 } } }, "schema":{ "$ref":"#/components/schemas/ProfileVertex" } } }, "description":"JSON response after creating the Profile Vertex" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a new Profile Vertex", "x-internal-id":"topology-v2-profileVertex-post", "x-filename-id":"topology-v2-profilevertex-post" } }, "/topology/v2/tmf/resourceadapter/decrypt":{ "post":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "description":"Decrypt encrypted attributes using TMF API", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object" } } } }, "responses":{ "200":{ "content":{ "application/json":{ } }, "description":"JSON response after decrypting the attributes" } }, "summary":"Decrypt encrypted attributes", "x-internal-id":"topology-v2-tmf-resourceadapter-decrypt-post", "x-filename-id":"topology-v2-tmf-resourceadapter-decrypt-post" } }, "/topology/v2/tmf/resourceadapter/edge/paths/underlay/channels/{id}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "description":"Offset for pagination, defaults to 0 when not supplied.", "example":10, "in":"query", "name":"offset", "required":false, "schema":{ "format":"int64", "type":"integer" } }, { "description":"Limit for pagination, defaults to 25 when not supplied.", "example":100, "in":"query", "name":"limit", "required":false, "schema":{ "format":"int64", "type":"integer" } }, { "description":"Sorting field, defaults to \"id\" when not supplied. \"id\" and \"name\" are the valid values.", "example":"id", "in":"query", "name":"sortBy", "required":false, "schema":{ "type":"string" } }, { "description":"Sorting order, defaults to \"asc\" when not supplied. \"asc\" and \"desc\" are the valid values.", "example":"desc", "in":"query", "name":"sortOrder", "required":false, "schema":{ "type":"string" } }, { "description":"If set true, filters out channels which are not enabling any trail.", "example":false, "in":"query", "name":"filterUnassigned", "required":false, "schema":{ "type":"boolean" } }, { "description":"If set true, filters out channels which are not enabled.", "example":false, "in":"query", "name":"filterEnabled", "required":false, "schema":{ "type":"boolean" } }, { "description":"\"pipe\" or \"connectivity\" id in \"business_object_type-id\" format.", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } } ], "description":"Fetch Pipe/Connectivity Channels.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ } }, "schema":{ "items":{ }, "type":"array" } } }, "description":"List of channels retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Fetch Pipe/Connectivity Channels", "x-internal-id":"topology-v2-tmf-resourceadapter-edge-paths-underlay-channels-{id}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-edge-paths-underlay-channels-id-get" } }, "/topology/v2/tmf/resourceadapter/edge/paths/underlay/service/{entityId}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "description":"Topology profile entity id.", "example":2671939, "in":"path", "name":"entityId", "required":true, "schema":{ "type":"string" } } ], "description":"Fetch Underlay layers information based on the profile id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "nodes":[ { "country":"IN", "city":"A1", "inventoryStatus":"INSTALLED", "latitude":0, "entityId":2671904, "businessObjectClass":"LogicalDeviceDAO", "referenceId":34500001, "entityVersion":2, "bridgeEdges":[ { "layerId":2, "entityId":2671904, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-26T11:18:22.000Z", "deviceIdentifier":"AA1_LD1", "layerId":1, "specName":"Packet Network Device", "autoSuggestName":"(975019)-AA1_LD1", "name":"AA1_LD1", "deviceInterfaceName":"10GigE-750314-1/1", "id":"975019", "layerName":"Ethernet", "activeEvent":999, "locationCode":"AA1", "capacityConsumed":12.197803, "createdUser":"inv", "longitude":0 }, { "country":"IN", "city":"B1", "inventoryStatus":"INSTALLED", "latitude":0, "entityId":2671906, "businessObjectClass":"LogicalDeviceDAO", "referenceId":34500036, "entityVersion":2, "bridgeEdges":[ { "layerId":2, "entityId":2671906, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-26T11:19:07.000Z", "deviceIdentifier":"BB1_LD1", "layerId":1, "specName":"Packet Network Device", "autoSuggestName":"(975020)-BB1_LD1", "name":"BB1_LD1", "deviceInterfaceName":"10GigE-750318-1/1/1", "id":"975020", "layerName":"Ethernet", "activeEvent":999, "locationCode":"BB1", "capacityConsumed":24.285715, "createdUser":"inv", "longitude":0 } ], "edges":[ { "entityVersion":0, "toNodeData":"1GigE-750315-1/1", "fromNode":2671904, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"10GigE-750314-1/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2671904 }, { "fromNode":2671904, "fromNodeData":"10GigE-750314-1/1", "protectedEdge":false, "referenceId":45000020, "entityVersion":4, "toNodeData":"10GigE-750318-1/1", "maxBandwidth":9000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":10000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2550003)-AA1 / BB1 / 10GigE / GE10 / 1", "lastModifiedUser":"inv", "id":"2550003", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-26T11:35:09.000Z", "inventoryStatus":"INSTALLED", "trailPaths":1, "entityId":2671916, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2671906, "createdDate":"2025-05-26T11:33:26.000Z", "specName":"INNI Connectivity", "name":"AA1 / BB1 / 10GigE / GE10 / 1", "properties":{ "isInternetwork":"false" }, "ratecode":"10GigE" }, { "entityVersion":0, "toNodeData":"10GigE-750318-1/1/1", "fromNode":2671906, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"1GigE-750319-1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2671906 } ], "filterChips":[ { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ { "filter":"RatecodesLOV", "isNode":false, "label":"10GigE", "filterLabel":"Ratecode", "value":"10GigE", "dependencies":[ ] }, { "filter":"SpecNamesLOV", "isNode":false, "label":"INNI Connectivity", "filterLabel":"Specification", "value":"INNI Connectivity", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"B1", "filterLabel":"City", "value":"B1", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"A1", "filterLabel":"City", "value":"A1", "dependencies":[ ] } ] }, { "filter":"CityLOV", "isNode":true, "label":"B1", "filterLabel":"City", "value":"B1", "dependencies":[ { "filter":"LocationCodeLOV", "isNode":true, "label":"BB1", "filterLabel":"LocationCode", "value":"BB1", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ ] }, { "filter":"AlarmsLOV", "isNode":true, "label":"None", "filterLabel":"Alarm", "value":"None" } ] } ], "filters":[ { "city":"B1", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"BB1" }, { "city":"A1", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"AA1" }, { "city":"B1", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"10GigE" } ] }, { "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "nodes":[ { "country":"IN", "city":"A1", "inventoryStatus":"INSTALLED", "latitude":0, "entityId":2671904, "businessObjectClass":"LogicalDeviceDAO", "referenceId":34500001, "entityVersion":2, "bridgeEdges":[ { "layerId":1, "entityId":2671904, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-26T11:18:22.000Z", "deviceIdentifier":"AA1_LD1", "layerId":2, "specName":"Packet Network Device", "autoSuggestName":"(975019)-AA1_LD1", "name":"AA1_LD1", "deviceInterfaceName":"100GigE-750316-1/1", "id":"975019", "layerName":"Ethernet", "activeEvent":999, "locationCode":"AA1", "capacityConsumed":12.197803, "createdUser":"inv", "longitude":0 }, { "country":"IN", "city":"B1", "inventoryStatus":"INSTALLED", "latitude":0, "entityId":2671906, "businessObjectClass":"LogicalDeviceDAO", "referenceId":34500036, "entityVersion":2, "bridgeEdges":[ { "layerId":1, "entityId":2671906, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-26T11:19:07.000Z", "deviceIdentifier":"BB1_LD1", "layerId":2, "specName":"Packet Network Device", "autoSuggestName":"(975020)-BB1_LD1", "name":"BB1_LD1", "deviceInterfaceName":"100GigE-750320-2/1", "id":"975020", "layerName":"Ethernet", "activeEvent":999, "locationCode":"BB1", "capacityConsumed":24.285715, "createdUser":"inv", "longitude":0 }, { "country":"IN", "city":"C1", "inventoryStatus":"INSTALLED", "latitude":0, "entityId":2671908, "businessObjectClass":"LogicalDeviceDAO", "referenceId":34500071, "entityVersion":2, "createdDate":"2025-05-26T11:20:30.000Z", "deviceIdentifier":"CC1_LD1", "layerId":2, "specName":"Packet Network Device", "autoSuggestName":"(975021)-CC1_LD1", "name":"CC1_LD1", "deviceInterfaceName":"10GigE-750322-2/1", "id":"975021", "layerName":"Ethernet", "activeEvent":999, "locationCode":"CC1", "capacityConsumed":23.076923, "createdUser":"inv", "longitude":0 } ], "edges":[ { "entityVersion":0, "toNodeData":"10GigE-750318-1/1", "fromNode":2671906, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"100GigE-750320-1/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2671906 }, { "fromNode":2671906, "fromNodeData":"100GigE-750320-2/1", "protectedEdge":false, "referenceId":45000072, "entityVersion":4, "toNodeData":"100GigE-750324-2/1", "maxBandwidth":90000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":100000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2550011)-BB1 / CC1 / 100GigE / GE100 / 1", "lastModifiedUser":"inv", "id":"2550011", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-26T11:37:55.000Z", "inventoryStatus":"INSTALLED", "trailPaths":1, "entityId":2671926, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2671908, "createdDate":"2025-05-26T11:35:45.000Z", "specName":"INNI Connectivity", "name":"BB1 / CC1 / 100GigE / GE100 / 1", "properties":{ "isInternetwork":"false" }, "ratecode":"100GigE" }, { "fromNode":2671904, "fromNodeData":"100GigE-750316-1/1", "protectedEdge":false, "referenceId":45000003, "entityVersion":4, "toNodeData":"100GigE-750320-1/1", "maxBandwidth":90000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":100000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2550001)-AA1 / BB1 / 100GigE / GE100 / 1", "lastModifiedUser":"inv", "id":"2550001", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-26T11:34:01.000Z", "inventoryStatus":"INSTALLED", "trailPaths":1, "entityId":2671912, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2671906, "createdDate":"2025-05-26T11:28:01.000Z", "specName":"INNI Connectivity", "name":"AA1 / BB1 / 100GigE / GE100 / 1", "properties":{ "isInternetwork":"false" }, "ratecode":"100GigE" }, { "entityVersion":0, "toNodeData":"10GigE-750322-2/1", "fromNode":2671908, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"100GigE-750324-2/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2671908 }, { "entityVersion":0, "toNodeData":"10GigE-750314-1/1", "fromNode":2671904, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"100GigE-750316-1/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2671904 }, { "entityVersion":0, "toNodeData":"10GigE-750318-2/1", "fromNode":2671906, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"100GigE-750320-2/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2671906 } ], "filterChips":[ { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ { "filter":"RatecodesLOV", "isNode":false, "label":"100GigE", "filterLabel":"Ratecode", "value":"100GigE", "dependencies":[ ] }, { "filter":"SpecNamesLOV", "isNode":false, "label":"INNI Connectivity", "filterLabel":"Specification", "value":"INNI Connectivity", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"B1", "filterLabel":"City", "value":"B1", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"A1", "filterLabel":"City", "value":"A1", "dependencies":[ ] } ] }, { "filter":"CityLOV", "isNode":true, "label":"B1", "filterLabel":"City", "value":"B1", "dependencies":[ { "filter":"LocationCodeLOV", "isNode":true, "label":"BB1", "filterLabel":"LocationCode", "value":"BB1", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ ] }, { "filter":"AlarmsLOV", "isNode":true, "label":"None", "filterLabel":"Alarm", "value":"None" } ] } ], "filters":[ { "city":"C1", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"CC1" }, { "city":"B1", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"BB1" }, { "city":"A1", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"AA1" }, { "city":"B1", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"100GigE" }, { "city":"C1", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"100GigE" } ] } ] } }, "schema":{ "items":{ }, "type":"array" } } }, "description":"List of GraphData which represents each layer is retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Fetch Service Underlay layers", "x-internal-id":"topology-v2-tmf-resourceadapter-edge-paths-underlay-service-{entityId}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-edge-paths-underlay-service-entityid-get" } }, "/topology/v2/tmf/resourceadapter/edge/paths/underlay/{entityType}/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "description":"\"pipe\" and \"connectivity\" are the only valid values.", "in":"path", "name":"entityType", "required":true, "schema":{ "type":"string" } }, { "description":"Topology entity id of the Pipe or Connectivity.", "example":573739, "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "description":"When this is true, ATA DB will not be looked up for the eid and eid should be the actual Inventory ID of the channel.", "in":"query", "name":"isChannel", "schema":{ "type":"boolean" } }, { "examples":{ "mulitple_paths":{ "summary":"Multiple paths can be retrieved like this", "value":"1,2" }, "all_paths":{ "summary":"All paths can be retrieved like this", "value":"all" } }, "description":"The comma separated path numbers for which the Underlay should be retrieved. If you want to retrieve all paths, specify \"all\" as the value of this parameter. If this parameter is omitted, by default working path (first path) Underlay is retrieved.", "in":"query", "name":"paths", "schema":{ "type":"string" } }, { "description":"Defines the maximum number of paths to be returned at a time for any trail in the layers including the topmost trail.", "in":"query", "name":"maxPathLimit", "schema":{ "format":"int32", "type":"integer" } } ], "description":"Fetch Pipe/Connectivity Underlay layers information based on the id, entityType and paths.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "nodes":[ { "country":"US", "city":"NEWARK", "latitude":31.6734, "postalCode":"25652", "referenceId":37500322, "entityVersion":2, "deviceIdentifier":"NEWUS.P01", "autoSuggestName":"(1125037)-NEWUS.P01", "deviceInterfaceName":"NEWUS.P01_10 Gb_7/1", "id":"1125037", "state":"NY", "activeEvent":999, "capacityConsumed":15.384616, "createdUser":"inv", "longitude":-101.905, "inventoryStatus":"INSTALLED", "entityId":2672256, "businessObjectClass":"LogicalDeviceDAO", "bridgeEdges":[ { "layerId":2, "entityId":2672256, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-29T06:26:23.000Z", "layerId":1, "specName":"Packet Network Device", "name":"NEWUS.P01", "layerName":"Ethernet", "locationCode":"NEWUS" }, { "country":"US", "city":"NEW YORK", "latitude":25.6126, "postalCode":"64547", "referenceId":37500012, "entityVersion":2, "deviceIdentifier":"NYKUS.P01", "autoSuggestName":"(1125033)-NYKUS.P01", "deviceInterfaceName":"NYKUS.P01_10 Gb_2/1", "id":"1125033", "state":"NY", "activeEvent":999, "capacityConsumed":15.457876, "createdUser":"inv", "longitude":-107.5086, "inventoryStatus":"INSTALLED", "entityId":2672244, "businessObjectClass":"LogicalDeviceDAO", "bridgeEdges":[ { "layerId":2, "entityId":2672244, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-29T06:26:22.000Z", "layerId":1, "specName":"Packet Network Device", "name":"NYKUS.P01", "layerName":"Ethernet", "locationCode":"NYKUS" }, { "country":"US", "city":"BINGHAMTON", "latitude":38.2548, "postalCode":"38874", "referenceId":37500126, "entityVersion":2, "deviceIdentifier":"BNGHUS.P01", "autoSuggestName":"(1125034)-BNGHUS.P01", "deviceInterfaceName":"1GigE-825330-2/1", "id":"1125034", "state":"NY", "activeEvent":999, "capacityConsumed":30.842491, "createdUser":"inv", "longitude":-115.272, "inventoryStatus":"INSTALLED", "entityId":2672247, "businessObjectClass":"LogicalDeviceDAO", "bridgeEdges":[ { "layerId":2, "entityId":2672247, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-29T06:26:22.000Z", "layerId":1, "specName":"Packet Network Device", "name":"BNGHUS.P01", "layerName":"Ethernet", "locationCode":"BNGHUS" } ], "edges":[ { "entityVersion":0, "toNodeData":"1GigE-825323-1/1", "fromNode":2672244, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"NYKUS.P01_10 Gb_2/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672244 }, { "fromNode":2672244, "fromNodeData":"NYKUS.P01_10 Gb_2/1", "protectedEdge":false, "referenceId":46500539, "entityVersion":4, "toNodeData":"NEWUS.P01_10 Gb_8/1", "maxBandwidth":9000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":10000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2625065)-NEWUS.P01 / NYKUS.P01 / 10GigE / GE10 / 1", "lastModifiedUser":"inv", "id":"2625065", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-29T15:00:47.000Z", "inventoryStatus":"INSTALLED", "trailPaths":2, "entityId":2672398, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2672256, "createdDate":"2025-05-29T14:25:55.000Z", "specName":"INNI Connectivity", "name":"NEWUS.P01 / NYKUS.P01 / 10GigE / GE10 / 1", "properties":{ "isInternetwork":"true" }, "ratecode":"10GigE" }, { "fromNode":2672256, "fromNodeData":"NEWUS.P01_10 Gb_7/1", "protectedEdge":false, "referenceId":46500552, "entityVersion":4, "toNodeData":"BNGHUS.P01_10 Gb_7/1", "maxBandwidth":9000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":10000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2625067)-BNGHUS.P01 / NEWUS.P01 / 10GigE / GE10 / 1", "lastModifiedUser":"inv", "id":"2625067", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-29T15:00:59.000Z", "inventoryStatus":"INSTALLED", "trailPaths":2, "entityId":2672400, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2672247, "createdDate":"2025-05-29T14:25:55.000Z", "specName":"INNI Connectivity", "name":"BNGHUS.P01 / NEWUS.P01 / 10GigE / GE10 / 1", "properties":{ "isInternetwork":"true" }, "ratecode":"10GigE" }, { "entityVersion":0, "toNodeData":"NEWUS.P01_10 Gb_8/1/1", "fromNode":2672256, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"NEWUS.P01_10 Gb_7/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672256 }, { "entityVersion":0, "toNodeData":"1GigE-825330-2/1", "fromNode":2672247, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"BNGHUS.P01_10 Gb_7/1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672247 } ], "filterChips":[ { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ { "filter":"RatecodesLOV", "isNode":false, "label":"10GigE", "filterLabel":"Ratecode", "value":"10GigE", "dependencies":[ ] }, { "filter":"SpecNamesLOV", "isNode":false, "label":"INNI Connectivity", "filterLabel":"Specification", "value":"INNI Connectivity", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"NEWARK", "filterLabel":"City", "value":"NEWARK", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"NEW YORK", "filterLabel":"City", "value":"NEW YORK", "dependencies":[ ] } ] }, { "filter":"CityLOV", "isNode":true, "label":"NEWARK", "filterLabel":"City", "value":"NEWARK", "dependencies":[ { "filter":"LocationCodeLOV", "isNode":true, "label":"NEWUS", "filterLabel":"LocationCode", "value":"NEWUS", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ ] }, { "filter":"AlarmsLOV", "isNode":true, "label":"None", "filterLabel":"Alarm", "value":"None" } ] } ], "filters":[ { "city":"BINGHAMTON", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"BNGHUS" }, { "city":"NEWARK", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"10GigE" }, { "city":"BINGHAMTON", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"10GigE" }, { "city":"NEW YORK", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"NYKUS" }, { "city":"NEWARK", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"NEWUS" } ] }, { "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "nodes":[ { "country":"US", "city":"PATERSON", "inventoryStatus":"INSTALLED", "latitude":30.2069, "postalCode":"99462", "entityId":2672271, "businessObjectClass":"LogicalDeviceDAO", "referenceId":37500642, "entityVersion":2, "createdDate":"2025-05-29T06:26:23.000Z", "deviceIdentifier":"PTRSUS.P01", "layerId":2, "specName":"Packet Network Device", "autoSuggestName":"(1125042)-PTRSUS.P01", "name":"PTRSUS.P01", "deviceInterfaceName":"PTRSUS.P01_100 Gb_14", "id":"1125042", "layerName":"Ethernet", "state":"NY", "activeEvent":999, "locationCode":"PTRSUS", "capacityConsumed":7.326008, "createdUser":"inv", "longitude":-110.2818 }, { "country":"US", "city":"NEWARK", "latitude":31.6734, "postalCode":"25652", "referenceId":37500322, "entityVersion":2, "deviceIdentifier":"NEWUS.P01", "autoSuggestName":"(1125037)-NEWUS.P01", "deviceInterfaceName":"NEWUS.P01_100 Gb_1", "id":"1125037", "state":"NY", "activeEvent":999, "capacityConsumed":15.384616, "createdUser":"inv", "longitude":-101.905, "inventoryStatus":"INSTALLED", "entityId":2672256, "businessObjectClass":"LogicalDeviceDAO", "bridgeEdges":[ { "layerId":1, "entityId":2672256, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-29T06:26:23.000Z", "layerId":2, "specName":"Packet Network Device", "name":"NEWUS.P01", "layerName":"Ethernet", "locationCode":"NEWUS" }, { "country":"US", "city":"BRIDGEPORT", "inventoryStatus":"INSTALLED", "latitude":43.8155, "postalCode":"98214", "entityId":2672274, "businessObjectClass":"LogicalDeviceDAO", "referenceId":37500704, "entityVersion":2, "createdDate":"2025-05-29T06:26:23.000Z", "deviceIdentifier":"BRDGUS.P01", "layerId":2, "specName":"Packet Network Device", "autoSuggestName":"(1125043)-BRDGUS.P01", "name":"BRDGUS.P01", "deviceInterfaceName":"BRDGUS.P01_100 Gb_17", "id":"1125043", "layerName":"Ethernet", "state":"NY", "activeEvent":999, "locationCode":"BRDGUS", "capacityConsumed":7.326008, "createdUser":"inv", "longitude":-106.4937 }, { "country":"US", "city":"NEW YORK", "latitude":25.6126, "postalCode":"64547", "referenceId":37500012, "entityVersion":2, "deviceIdentifier":"NYKUS.P01", "autoSuggestName":"(1125033)-NYKUS.P01", "deviceInterfaceName":"NYKUS.P01_100 Gb_15", "id":"1125033", "state":"NY", "activeEvent":999, "capacityConsumed":15.457876, "createdUser":"inv", "longitude":-107.5086, "inventoryStatus":"INSTALLED", "entityId":2672244, "businessObjectClass":"LogicalDeviceDAO", "bridgeEdges":[ { "layerId":1, "entityId":2672244, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-29T06:26:22.000Z", "layerId":2, "specName":"Packet Network Device", "name":"NYKUS.P01", "layerName":"Ethernet", "locationCode":"NYKUS" }, { "country":"US", "city":"BINGHAMTON", "latitude":38.2548, "postalCode":"38874", "referenceId":37500126, "entityVersion":2, "deviceIdentifier":"BNGHUS.P01", "autoSuggestName":"(1125034)-BNGHUS.P01", "deviceInterfaceName":"BNGHUS.P01_100 Gb_17/1", "id":"1125034", "state":"NY", "activeEvent":999, "capacityConsumed":30.842491, "createdUser":"inv", "longitude":-115.272, "inventoryStatus":"INSTALLED", "entityId":2672247, "businessObjectClass":"LogicalDeviceDAO", "bridgeEdges":[ { "layerId":1, "entityId":2672247, "businessObjectClass":"LogicalDeviceDAO" } ], "createdDate":"2025-05-29T06:26:22.000Z", "layerId":2, "specName":"Packet Network Device", "name":"BNGHUS.P01", "layerName":"Ethernet", "locationCode":"BNGHUS" } ], "edges":[ { "fromNode":2672274, "fromNodeData":"BRDGUS.P01_100 Gb_17", "protectedEdge":false, "referenceId":46500054, "entityVersion":2, "toNodeData":"BNGHUS.P01_100 Gb_17", "maxBandwidth":90000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":100000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2625007)-BNGHUS.P01 / BRDGUS.P01 / 100GigE / GE100 / 1", "lastModifiedUser":"inv", "id":"2625007", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-29T14:47:34.000Z", "inventoryStatus":"INSTALLED", "trailPaths":1, "entityId":2672313, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2672247, "createdDate":"2025-05-29T14:19:03.000Z", "specName":"INNI Connectivity", "name":"BNGHUS.P01 / BRDGUS.P01 / 100GigE / GE100 / 1", "properties":{ "isInternetwork":"true" }, "ratecode":"100GigE" }, { "entityVersion":0, "toNodeData":"PTRSUS.P01_100 Gb_14/1", "fromNode":2672271, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"PTRSUS.P01_100 Gb_4/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672271 }, { "entityVersion":0, "toNodeData":"NEWUS.P01_10 Gb_7/1", "fromNode":2672256, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"NEWUS.P01_100 Gb_1/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672256 }, { "entityVersion":0, "toNodeData":"NYKUS.P01_10 Gb_2/1", "fromNode":2672244, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"NYKUS.P01_100 Gb_15/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672244 }, { "entityVersion":0, "toNodeData":"BRDGUS.P01_100 Gb_17/1", "fromNode":2672274, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"BRDGUS.P01_100 Gb_18/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672274 }, { "fromNode":2672271, "fromNodeData":"PTRSUS.P01_100 Gb_14", "protectedEdge":false, "referenceId":46500020, "entityVersion":2, "toNodeData":"NEWUS.P01_100 Gb_16", "maxBandwidth":90000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":100000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2625003)-NEWUS.P01 / PTRSUS.P01 / 100GigE / GE100 / 1", "lastModifiedUser":"inv", "id":"2625003", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-29T14:51:54.000Z", "inventoryStatus":"INSTALLED", "trailPaths":1, "entityId":2672307, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2672256, "createdDate":"2025-05-29T14:19:02.000Z", "specName":"INNI Connectivity", "name":"NEWUS.P01 / PTRSUS.P01 / 100GigE / GE100 / 1", "properties":{ "isInternetwork":"true" }, "ratecode":"100GigE" }, { "entityVersion":0, "toNodeData":"NEWUS.P01_100 Gb_16/1", "fromNode":2672256, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"NEWUS.P01_10 Gb_8/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672256 }, { "fromNode":2672244, "fromNodeData":"NYKUS.P01_100 Gb_15", "protectedEdge":false, "referenceId":46500003, "entityVersion":2, "toNodeData":"PTRSUS.P01_100 Gb_4", "maxBandwidth":90000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":100000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2625001)-NYKUS.P01 / PTRSUS.P01 / 100GigE / GE100 / 1", "lastModifiedUser":"inv", "id":"2625001", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-29T14:51:42.000Z", "inventoryStatus":"INSTALLED", "trailPaths":1, "entityId":2672304, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2672271, "createdDate":"2025-05-29T14:19:02.000Z", "specName":"INNI Connectivity", "name":"NYKUS.P01 / PTRSUS.P01 / 100GigE / GE100 / 1", "properties":{ "isInternetwork":"true" }, "ratecode":"100GigE" }, { "fromNode":2672256, "fromNodeData":"NEWUS.P01_100 Gb_1", "protectedEdge":false, "referenceId":46500037, "entityVersion":2, "toNodeData":"BRDGUS.P01_100 Gb_18", "maxBandwidth":90000, "toNodeBusinessObjectClass":"LogicalDeviceDAO", "totalCapacity":100000, "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(2625005)-BRDGUS.P01 / NEWUS.P01 / 100GigE / GE100 / 1", "lastModifiedUser":"inv", "id":"2625005", "createdUser":"inv", "fromNodeBusinessObjectClass":"LogicalDeviceDAO", "lastModifiedDate":"2025-05-29T14:47:17.000Z", "inventoryStatus":"INSTALLED", "trailPaths":1, "entityId":2672310, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "toNode":2672274, "createdDate":"2025-05-29T14:19:02.000Z", "specName":"INNI Connectivity", "name":"BRDGUS.P01 / NEWUS.P01 / 100GigE / GE100 / 1", "properties":{ "isInternetwork":"true" }, "ratecode":"100GigE" }, { "entityVersion":0, "toNodeData":"BNGHUS.P01_100 Gb_17/1", "fromNode":2672247, "autoSuggestName":"Cross Connect (Trail-bound)", "fromNodeData":"BNGHUS.P01_10 Gb_7/1", "name":"Cross Connect (Trail-bound)", "protectedEdge":false, "businessObjectClass":"CrossConnectDAO", "toNode":2672247 } ], "filterChips":[ { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ { "filter":"RatecodesLOV", "isNode":false, "label":"100GigE", "filterLabel":"Ratecode", "value":"100GigE", "dependencies":[ ] }, { "filter":"SpecNamesLOV", "isNode":false, "label":"INNI Connectivity", "filterLabel":"Specification", "value":"INNI Connectivity", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"PATERSON", "filterLabel":"City", "value":"PATERSON", "dependencies":[ ] }, { "filter":"CityLOV", "isNode":true, "label":"NEW YORK", "filterLabel":"City", "value":"NEW YORK", "dependencies":[ ] } ] }, { "filter":"CityLOV", "isNode":true, "label":"PATERSON", "filterLabel":"City", "value":"PATERSON", "dependencies":[ { "filter":"LocationCodeLOV", "isNode":true, "label":"PTRSUS", "filterLabel":"LocationCode", "value":"PTRSUS", "dependencies":[ ] }, { "filter":"DeviceTypeLOV", "isNode":true, "label":"", "filterLabel":"DeviceType", "value":"", "dependencies":[ ] }, { "filter":"NetworkTypeLOV", "isNode":true, "label":"", "filterLabel":"NetworkType", "value":"", "dependencies":[ ] }, { "filter":"TechnologiesLOV", "isNode":false, "label":"Ethernet", "filterLabel":"Technology", "value":"Ethernet", "dependencies":[ ] }, { "filter":"AlarmsLOV", "isNode":true, "label":"None", "filterLabel":"Alarm", "value":"None" } ] } ], "filters":[ { "city":"BRIDGEPORT", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"BRDGUS" }, { "city":"NEWARK", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"100GigE" }, { "city":"BINGHAMTON", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"BNGHUS" }, { "city":"PATERSON", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"PTRSUS" }, { "city":"NEW YORK", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"NYKUS" }, { "city":"BINGHAMTON", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"100GigE" }, { "city":"BRIDGEPORT", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"100GigE" }, { "city":"NEWARK", "alarm":"None", "isNode":true, "technology":"Ethernet", "locationCode":"NEWUS" }, { "city":"PATERSON", "specification":"INNI Connectivity", "isNode":false, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "ratecode":"100GigE" } ] } ] } }, "schema":{ "items":{ }, "type":"array" } } }, "description":"List of GraphData which represents each layer is retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Fetch Pipe/Connectivity Underlay layers", "x-internal-id":"topology-v2-tmf-resourceadapter-edge-paths-underlay-{entityType}-{eid}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-edge-paths-underlay-entitytype-eid-get" } }, "/topology/v2/tmf/resourceadapter/edge/paths/{entityType}/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "description":"\"pipe\" and \"connectivity\" are the only valid values.", "in":"path", "name":"entityType", "required":true, "schema":{ "type":"string" } }, { "description":"Topology entity id of the Pipe or Connectivity.", "example":573739, "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "description":"When this is true, ATA DB will not be looked up for the eid and the eid should be the actual Inventory ID of the channel.", "in":"query", "name":"isChannel", "schema":{ "type":"boolean" } } ], "description":"Fetch GraphData based on entityType and entityid.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":0, "warning":0 }, "nodes":[ { "country":"IN", "city":"HYD", "physicalPortName":"LOC_V1A1", "latitude":78.4867, "postalCode":"500050", "entityId":9402, "businessObjectClass":"PropertyLocationDAO", "referenceId":48000001, "entityVersion":5, "createdDate":"2023-04-17T04:46:15.000Z", "specName":"Property Location", "autoSuggestName":"(2550001)-LOC_V1A1", "name":"LOC_V1A1", "id":"2550001", "state":"TS", "locationCode":"LOC_V1A1", "longitude":17.385 }, { "country":"IN", "city":"PUN", "physicalPortName":"LOC_V1C1", "latitude":73.8567, "postalCode":"500052", "entityId":9404, "businessObjectClass":"PropertyLocationDAO", "referenceId":48000005, "entityVersion":2, "createdDate":"2023-04-17T04:46:15.000Z", "specName":"Property Location", "autoSuggestName":"(2550003)-LOC_V1C1", "name":"LOC_V1C1", "id":"2550003", "state":"MH", "locationCode":"LOC_V1C1", "longitude":18.5204 }, { "country":"IN", "city":"DEL", "physicalPortName":"LOC_V1D1", "latitude":77.1025, "postalCode":"500053", "entityId":9405, "businessObjectClass":"PropertyLocationDAO", "referenceId":48000007, "entityVersion":2, "createdDate":"2023-04-17T04:46:15.000Z", "specName":"Property Location", "autoSuggestName":"(2550004)-LOC_V1D1", "name":"LOC_V1D1", "id":"2550004", "state":"DL", "locationCode":"LOC_V1D1", "longitude":28.7041 } ], "edges":[ { "entityVersion":0, "pathIds":[ 1 ], "toNodeData":"LOC_V1C1", "fromNode":9404, "autoSuggestName":"Gap - ok", "fromNodeData":"LOC_V1C1", "name":"Gap - ok", "businessObjectClass":"ConnectivityGapDAO", "toNode":9404 }, { "entityVersion":0, "pathIds":[ 1 ], "toNodeData":"LOC_V1D1", "fromNode":9405, "autoSuggestName":"Gap - ok", "fromNodeData":"LOC_V1D1", "name":"Gap - ok", "businessObjectClass":"ConnectivityGapDAO", "toNode":9405 }, { "fromNode":9402, "fromNodeBusinessObjectClass":"PropertyLocationDAO", "isPipeInterfaceTerminated":false, "lastModifiedDate":"2023-04-21T06:27:18.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-72000002", "entityId":10223, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":72000003, "toNode":9405, "entityVersion":3, "toNodeData":"oracle.communications.platform.entity.impl.PipeTerminationPointDAO-72000005", "createdDate":"2023-04-21T06:23:44.000Z", "specName":"INNI Connectivity", "toNodeBusinessObjectClass":"PropertyLocationDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(3975001)-LOC_V1A1 / LOC_V1D1 / 1GigE / GE1 / 1", "costValue3":100, "name":"LOC_V1A1 / LOC_V1D1 / 1GigE / GE1 / 1", "costValue2":100, "costValue1":100, "id":"3975001", "ratecode":"1GigE" }, { "pathIds":[ 1 ], "fromNode":9402, "fromNodeBusinessObjectClass":"PropertyLocationDAO", "lastModifiedDate":"2023-04-21T06:26:09.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"LOC_V1A1", "entityId":10225, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":72000016, "toNode":9404, "entityVersion":4, "toNodeData":"LOC_V1C1", "createdDate":"2023-04-21T06:24:07.000Z", "specName":"INNI Connectivity", "toNodeBusinessObjectClass":"PropertyLocationDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(3975003)-LOC_V1A1 / LOC_V1C1 / 1GigE / GE1 / 1", "name":"LOC_V1A1 / LOC_V1C1 / 1GigE / GE1 / 1", "id":"3975003", "ratecode":"1GigE" }, { "pathIds":[ 1 ], "fromNode":9404, "fromNodeBusinessObjectClass":"PropertyLocationDAO", "lastModifiedDate":"2023-04-21T06:26:35.000Z", "inventoryStatus":"INSTALLED", "fromNodeData":"LOC_V1C1", "entityId":10227, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":72000029, "toNode":9405, "entityVersion":4, "toNodeData":"LOC_V1D1", "createdDate":"2023-04-21T06:24:20.000Z", "specName":"INNI Connectivity", "toNodeBusinessObjectClass":"PropertyLocationDAO", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(3975005)-LOC_V1C1 / LOC_V1D1 / 1GigE / GE1 / 1", "name":"LOC_V1C1 / LOC_V1D1 / 1GigE / GE1 / 1", "id":"3975005", "ratecode":"1GigE" }, { "entityVersion":0, "pathIds":[ 1 ], "toNodeData":"LOC_V1A1", "fromNode":9402, "autoSuggestName":"Gap - ok", "fromNodeData":"LOC_V1A1", "name":"Gap - ok", "businessObjectClass":"ConnectivityGapDAO", "toNode":9402 } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"JSON response after retrieveing the GraphData" } }, "summary":"Fetch GraphData based on entityType and entityid", "x-internal-id":"topology-v2-tmf-resourceadapter-edge-paths-{entityType}-{eid}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-edge-paths-entitytype-eid-get" } }, "/topology/v2/tmf/resourceadapter/id/{id}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"decryptAttributes", "schema":{ "default":"NONE", "type":"string" } } ], "description":"Fetch Resource details based on id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "serviceLocation":{ "@referredType":"PropertyLocation", "name":"HYD", "id":"HYD", "href":"http://:/InventoryRSOpenAPI/place/HYD" }, "lifecycleState":"INSTALLED", "childDeviceInterfaces":[ { "@type":"DeviceInterface", "id":"20-2-1", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-2-1" }, { "@type":"DeviceInterface", "id":"20-2-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-2-2" } ], "logicalDeviceAccounts":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/logicalDevice/1-2/logicalDeviceAccounts", "@type":"LogicalDevice", "endOperatingDate":"2038-01-19T08:44:07.000Z", "resourceVersion":"1", "resourceSpecification":{ "endDate":"2038-01-19T08:44:07.000Z", "entityType":"LogicalDevice", "name":"BATLD-DISpec", "id":"BATLD-DISpec", "href":"http://:/InventoryRSOpenAPI/specification/BATLD-DISpec", "version":"1", "startDate":"2023-03-03T00:00:01.000Z" }, "resourceCharacteristic":[ ], "percentageConsumed":"0.0", "deviceInterfaces":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/logicalDevice/1-2/deviceInterfaces", "lifecycleSubState":"UNASSIGNED", "resourceStatus":"Available", "deviceIdentifier":"HYD.1", "@baseType":"LogicalResource", "totalCapacity":"0.00 Mbps", "name":"LD-H-1", "resourceRelationship":[ { "resourceRef":{ "@type":"PhysicalDevice", "id":"4-75001", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/4-75001" }, "relationshipType":"MAPPEDTO" } ], "id":"1-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/1-2", "startOperatingDate":"2022-07-29T20:29:57.530Z", "networkLocation":{ "@referredType":"NetworkEntityCode", "name":"HYD.1", "id":"HYD.1", "href":"http://:/InventoryRSOpenAPI/place/HYD.1" }, "capacityConsumed":"0.00 Mbps" } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"JSON response after retrieveing the Resource" } }, "summary":"Fetch Resource details based on id", "x-internal-id":"topology-v2-tmf-resourceadapter-id-{id}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-id-id-get" } }, "/topology/v2/tmf/resourceadapter/layeredview/pipes/{id}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":25, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "type":"string" } } ], "description":"Fetch layered view pipes based on id with optional pagination and sorting.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "Pipe":[ { "zEndLogicalDeviceName":"CHNN03TN.P01", "zEndLogicalDeviceId":"225003", "bitRate":"150.336 Mbps", "zEndLocation":"CHNN03TN", "aEndLogicalDeviceId":"225001", "adminState":"INSTALLED", "aEndLocation":"CHNN01TN", "aEndLogicalDeviceName":"CHNN01TN.P01", "entityId":"15150531", "connectivityIdentifier":"CHNN01TN.P01 / CHNN03TN.P01 / VC4 / VC4 / 5", "id":"31-600094" }, { "zEndLogicalDeviceName":"CHNN03TN.P01", "zEndLogicalDeviceId":"225003", "bitRate":"150.336 Mbps", "zEndLocation":"CHNN03TN", "aEndLogicalDeviceId":"225001", "adminState":"INSTALLED", "aEndLocation":"CHNN01TN", "aEndLogicalDeviceName":"CHNN01TN.P01", "entityId":"13664043", "connectivityIdentifier":"CHNN01TN.P01 / CHNN03TN.P01 / VC4 / VC4 / 1", "id":"31-462313" } ] } } }, "schema":{ "type":"object" } } }, "description":"JSON response after retrieving the layered view pipes" } }, "summary":"Fetch layered view pipes based on id", "x-internal-id":"topology-v2-tmf-resourceadapter-layeredview-pipes-{id}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-layeredview-pipes-id-get" } }, "/topology/v2/tmf/resourceadapter/layeredview/services/{id}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":25, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "type":"string" } } ], "description":"Fetch overlay services for a given service id with optional pagination and sorting", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "Service":[ { "statusDate":"2024-02-18T14:35:09.871Z", "name":"SR_CHNN01TN.P01 / CHNN03TN.P01 / 150M / VPN / 7", "adminState":"IN_SERVICE", "specification":"AcessService", "entityId":"3000007", "id":"225007" }, { "statusDate":"2024-02-18T14:35:10.175Z", "name":"SR_CHNN01TN.P01 / CHNN03TN.P01 / 150M / VPN / 9", "adminState":"IN_SERVICE", "specification":"AcessService", "entityId":"3000009", "id":"225009" } ] } } }, "schema":{ "type":"object" } } }, "description":"JSON response after retrieving the overlay services" } }, "summary":"Fetch overlay services for a given service id", "x-internal-id":"topology-v2-tmf-resourceadapter-layeredview-services-{id}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-layeredview-services-id-get" } }, "/topology/v2/tmf/resourceadapter/resource/id/{id}":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"decryptAttributes", "schema":{ "default":"NONE", "type":"string" } }, { "example":1, "in":"query", "name":"depth", "schema":{ "default":"1", "format":"int32", "type":"integer" } } ], "description":"Fetch Resource details based on id and depth.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "serviceLocation":{ "@referredType":"PropertyLocation", "name":"HYD", "id":"HYD", "href":"http://:/InventoryRSOpenAPI/place/HYD" }, "lifecycleState":"INSTALLED", "childDeviceInterfaces":[ { "@type":"DeviceInterface", "id":"20-2-1", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-2-1" }, { "@type":"DeviceInterface", "id":"20-2-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-2-2" } ], "logicalDeviceAccounts":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/logicalDevice/1-2/logicalDeviceAccounts", "@type":"LogicalDevice", "endOperatingDate":"2038-01-19T08:44:07.000Z", "resourceVersion":"1", "resourceSpecification":{ "endDate":"2038-01-19T08:44:07.000Z", "entityType":"LogicalDevice", "name":"BATLD-DISpec", "id":"BATLD-DISpec", "href":"http://:/InventoryRSOpenAPI/specification/BATLD-DISpec", "version":"1", "startDate":"2023-03-03T00:00:01.000Z" }, "resourceCharacteristic":[ ], "percentageConsumed":"0.0", "deviceInterfaces":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/logicalDevice/1-2/deviceInterfaces", "lifecycleSubState":"UNASSIGNED", "resourceStatus":"Available", "deviceIdentifier":"HYD.1", "@baseType":"LogicalResource", "totalCapacity":"0.00 Mbps", "name":"LD-H-1", "resourceRelationship":[ { "resourceRef":{ "@type":"PhysicalDevice", "id":"4-75001", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/4-75001" }, "relationshipType":"MAPPEDTO" } ], "id":"1-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/1-2", "startOperatingDate":"2022-07-29T20:29:57.530Z", "networkLocation":{ "@referredType":"NetworkEntityCode", "name":"HYD.1", "id":"HYD.1", "href":"http://:/InventoryRSOpenAPI/place/HYD.1" }, "capacityConsumed":"0.00 Mbps" } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"JSON response after retrieveing the Resource" } }, "summary":"Fetch Resource details based on id and depth", "x-internal-id":"topology-v2-tmf-resourceadapter-resource-id-{id}-get", "x-filename-id":"topology-v2-tmf-resourceadapter-resource-id-id-get" } }, "/topology/v2/tmf/resourceadapter/{resourceType}/{id}/physicalConnectors":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"resourceType", "required":true, "schema":{ "type":"string" } } ], "description":"Fetch Physical Connectors based on id and resource type.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "lifecycleState":"INSTALLED", "@type":"PhysicalConnector", "endOperatingDate":"2038-01-19T08:44:07.000Z", "resourceVersion":"1", "resourceSpecification":{ "endDate":"2038-01-19T08:44:07.000Z", "entityType":"PhysicalConnector", "name":"BATPhysicalConnectorSpec", "id":"BATPhysicalConnectorSpec", "href":"http://:/InventoryRSOpenAPI/specification/BATPhysicalConnectorSpec", "version":"1", "startDate":"2023-03-03T00:00:01.000Z" }, "resourceCharacteristic":[ ], "lifecycleSubState":"UNASSIGNED", "resourceStatus":"Available", "@baseType":"PhysicalResource", "physicalDeviceRef":{ "@type":"PhysicalDevice", "id":"4-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/4-2" }, "resourceRelationship":[ ], "id":"9-2-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/9-2-2", "startOperatingDate":"2022-07-29T21:07:40.589Z" } ] } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"JSON response after retrieveing the Vertex" } }, "summary":"Fetch Physical Connectors based on id and resource type", "x-internal-id":"topology-v2-tmf-resourceadapter-{resourceType}-{id}-physicalConnectors-get", "x-filename-id":"topology-v2-tmf-resourceadapter-resourcetype-id-physicalconnectors-get" } }, "/topology/v2/tmf/resourceadapter/{resourceType}/{id}/physicalPorts":{ "get":{ "tags":[ "Active Topology Automation/Resource Adapter" ], "parameters":[ { "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"resourceType", "required":true, "schema":{ "type":"string" } } ], "description":"Fetch Physical Ports based on id and resource type.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "lifecycleState":"INSTALLED", "@type":"PhysicalPort", "endOperatingDate":"2038-01-19T08:44:07.000Z", "resourceVersion":"1", "resourceSpecification":{ "endDate":"2038-01-19T08:44:07.000Z", "entityType":"PhysicalPort", "name":"BATPhysicalPortSpec", "id":"BATPhysicalPortSpec", "href":"http://:/InventoryRSOpenAPI/specification/BATPhysicalPortSpec", "version":"1", "startDate":"2023-03-03T00:00:01.000Z" }, "resourceCharacteristic":[ ], "lifecycleSubState":"UNASSIGNED", "portNumber":0, "resourceStatus":"Available", "@baseType":"PhysicalResource", "physicalDeviceRef":{ "@type":"PhysicalDevice", "id":"4-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/4-2" }, "resourceRelationship":[ ], "id":"10-2-2", "href":"http://:/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/10-2-2", "startOperatingDate":"2022-07-29T21:07:40.583Z" } ] } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"JSON response after retrieveing the Vertex" } }, "summary":"Fetch Physical Ports based on id and resource type", "x-internal-id":"topology-v2-tmf-resourceadapter-{resourceType}-{id}-physicalPorts-get", "x-filename-id":"topology-v2-tmf-resourceadapter-resourcetype-id-physicalports-get" } }, "/topology/v2/ui/autosuggest/device/deviceidentifier":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The character string be searched", "in":"query", "name":"searchTerm", "required":false, "schema":{ "type":"string" } } ], "description":"Return entities by Device and Device Identifier", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "deviceIdentifier":"MKN001IL.T-1", "autoSuggestName":"MKN001IL.T-1-MKN001IL.T-1.LD", "name":"MKN001IL.T-1.LD", "entityId":5589, "id":"MKN001IL.T-1" } } }, "schema":{ "$ref":"#/components/schemas/LabelData" } } }, "description":"Device Identifiers retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"AutoSuggest search by Device Identifier", "x-internal-id":"topology-v2-ui-autosuggest-device-deviceidentifier-get", "x-filename-id":"topology-v2-ui-autosuggest-device-deviceidentifier-get" } }, "/topology/v2/ui/autosuggest/location/locationcode":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The character string be searched", "in":"query", "name":"searchTerm", "required":false, "schema":{ "type":"string" } } ], "description":"Return entities by Location and Location Code", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "autoSuggestName":"331-MID-COUNTY INTERCHANGE PLYMOUTH MEETING PA 19462 US", "name":"MID-COUNTY INTERCHANGE PLYMOUTH MEETING PA 19462 US", "entityId":1990, "id":"331", "locationCode":"PLYM01PA" } } }, "schema":{ "$ref":"#/components/schemas/LabelData" } } }, "description":"Location Codes retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"AutoSuggest search by Location Code", "x-internal-id":"topology-v2-ui-autosuggest-location-locationcode-get", "x-filename-id":"topology-v2-ui-autosuggest-location-locationcode-get" } }, "/topology/v2/ui/autosuggest/static/{entityType}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The type of entity requested", "in":"path", "name":"entityType", "required":true, "schema":{ "type":"string" } }, { "description":"The column name on the entity requested", "in":"query", "name":"staticField", "required":false, "schema":{ "type":"string" } }, { "description":"The character string be searched", "in":"query", "name":"searchTerm", "required":false, "schema":{ "type":"string" } } ], "description":"Return entities by specfied entity and column", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "name":"SPECNAME", "value":"GenericDevice" } } }, "schema":{ "$ref":"#/components/schemas/LabelData" } } }, "description":"The distinct values are retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"AutoSuggest search by static column data", "x-internal-id":"topology-v2-ui-autosuggest-static-{entityType}-get", "x-filename-id":"topology-v2-ui-autosuggest-static-entitytype-get" } }, "/topology/v2/ui/autosuggest/{entityType}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The type of entity requested", "in":"path", "name":"entityType", "required":true, "schema":{ "type":"string" } }, { "description":"The character string be searched", "in":"query", "name":"searchTerm", "required":false, "schema":{ "type":"string" } } ], "description":"Return entities by Entity Name", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "autoSuggestName":"5996-ORLN01FL.SR-1 / ORLN02FL.MC-1 / 10GigE / GE10 / 1", "name":"ORLN01FL.SR-1 / ORLN02FL.MC-1 / 10GigE / GE10 / 1", "entityId":15940, "id":"5996" } } }, "schema":{ "$ref":"#/components/schemas/LabelData" } } }, "description":"Entity names retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"AutoSuggest search by Name", "x-internal-id":"topology-v2-ui-autosuggest-{entityType}-get", "x-filename-id":"topology-v2-ui-autosuggest-entitytype-get" } }, "/topology/v2/ui/autosuggest/{entityType}/id":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The type of entity requested", "in":"path", "name":"entityType", "required":true, "schema":{ "type":"string" } }, { "description":"The character string be searched", "in":"query", "name":"searchTerm", "required":false, "schema":{ "type":"string" } } ], "description":"Return entities by Entity ID", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "autoSuggestName":"5996-ORLN01FL.SR-1 / ORLN02FL.MC-1 / 10GigE / GE10 / 1", "name":"ORLN01FL.SR-1 / ORLN02FL.MC-1 / 10GigE / GE10 / 1", "entityId":15940, "id":"5996" } } }, "schema":{ "$ref":"#/components/schemas/LabelData" } } }, "description":"Entity IDs retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"AutoSuggest search by ID", "x-internal-id":"topology-v2-ui-autosuggest-{entityType}-id-get", "x-filename-id":"topology-v2-ui-autosuggest-entitytype-id-get" } }, "/topology/v2/ui/color/preferences":{ "post":{ "tags":[ "Active Topology Automation/UI" ], "description":"Create a new Color Preference.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "color":"#FFFF00", "technology":"Ethernet", "rateCode":"10GigE", "edgestyle":"solid" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceColorsType" } } }, "description":"ColorPreference object to be created" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "color":"#FFFF00", "preferenceId":25, "technology":"Ethernet", "rateCode":"10GigE", "edgestyle":"solid" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceColorsType" } } }, "description":"Color Preference created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a Color Preference", "x-internal-id":"topology-v2-ui-color-preferences-post", "x-filename-id":"topology-v2-ui-color-preferences-post" } }, "/topology/v2/ui/color/preferences/createduser/{createdUser}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "in":"path", "name":"createdUser", "required":true, "schema":{ "type":"string" } } ], "description":"Return all the Color preferences sorted in desc created date order.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "createdDate":"2023-07-19T07:51:32.000Z", "color":"#FFFF00", "lastModifiedDate":"2023-07-19T07:51:32.000Z", "preferenceId":25, "lastModifiedUser":"admin", "technology":"Ethernet", "createdUser":"admin", "rateCode":"10GigE", "edgestyle":"solid" } ] } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceColorsType" } } }, "description":"All User Preferences retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get all the Color preferences", "x-internal-id":"topology-v2-ui-color-preferences-createduser-{createdUser}-get", "x-filename-id":"topology-v2-ui-color-preferences-createduser-createduser-get" }, "delete":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The createdUser of the Color Preference to be deleted", "in":"path", "name":"createdUser", "required":true, "schema":{ "type":"string" } } ], "description":"Delete all existing Color Preferences by createdUser", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The colorPreference by the given createdUser was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete all existing Color Preferences", "x-internal-id":"topology-v2-ui-color-preferences-createduser-{createdUser}-delete", "x-filename-id":"topology-v2-ui-color-preferences-createduser-createduser-delete" } }, "/topology/v2/ui/color/preferences/id/{preferenceId}":{ "put":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The preferenceId of the colorPreference to be updated", "in":"path", "name":"preferenceId", "required":true, "schema":{ "format":"int64", "type":"integer" } } ], "description":"Update an existing Color Preference.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "color":"#FFFF00", "preferenceId":24, "technology":"Ethernet", "rateCode":"10GigE", "edgestyle":"solid" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceColorsType" } } }, "description":"Color Preference object to be created" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "createdDate":"2023-07-19T07:38:24.000Z", "color":"#FFFF00", "lastModifiedDate":"2023-07-19T07:40:59.000Z", "preferenceId":24, "lastModifiedUser":"admin", "technology":"Ethernet", "createdUser":"admin", "rateCode":"10GigE", "edgestyle":"solid" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceColorsType" } } }, "description":"color Preference updated successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Color Preference", "x-internal-id":"topology-v2-ui-color-preferences-id-{preferenceId}-put", "x-filename-id":"topology-v2-ui-color-preferences-id-preferenceid-put" }, "delete":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The preferenceId of the Color Preference to be deleted", "in":"path", "name":"preferenceId", "required":true, "schema":{ "format":"int64", "type":"integer" } } ], "description":"Delete an existing Color Preference by Id", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The colorPreference by the given preferenceId was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing Color Preference", "x-internal-id":"topology-v2-ui-color-preferences-id-{preferenceId}-delete", "x-filename-id":"topology-v2-ui-color-preferences-id-preferenceid-delete" } }, "/topology/v2/ui/color/preferences/list":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "description":"Return all the Color preferences sorted in desc created date order.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "createdDate":"2023-07-19T07:51:32.000Z", "color":"#FFFF00", "lastModifiedDate":"2023-07-19T07:51:32.000Z", "preferenceId":25, "lastModifiedUser":"admin", "technology":"Ethernet", "createdUser":"admin", "rateCode":"10GigE", "edgestyle":"solid" } ] } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceColorsType" } } }, "description":"All User Preferences retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get all the Color preferences", "x-internal-id":"topology-v2-ui-color-preferences-list-get", "x-filename-id":"topology-v2-ui-color-preferences-list-get" }, "delete":{ "tags":[ "Active Topology Automation/UI" ], "description":"Delete all existing Color Preferences", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The colorPreference by the given createdUser was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete all existing Color Preferences", "x-internal-id":"topology-v2-ui-color-preferences-list-delete", "x-filename-id":"topology-v2-ui-color-preferences-list-delete" } }, "/topology/v2/ui/connectivity/list":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The technology of the connected edges", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connected edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the connected devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the connected edges", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The node category for the connected devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The domain for the connected devices", "in":"query", "name":"domain", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The connectivity x number of hops from each endpoint", "in":"query", "name":"hops", "required":false, "schema":{ "default":1, "format":"int32", "type":"integer" } } ], "description":"Return the graph for the specified connectivity list.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"JSON response after retrieveing the profile" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the graph for the connectivity list", "x-internal-id":"topology-v2-ui-connectivity-list-get", "x-filename-id":"topology-v2-ui-connectivity-list-get" } }, "/topology/v2/ui/connectivity/{eid}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The entity id for the connectivity", "in":"path", "name":"eid", "required":true, "schema":{ "format":"int64", "type":"integer" } }, { "description":"The technology of the connected edges", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connected edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the connected devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the connected edges", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The node category for the connected devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The domain for the connected devices", "in":"query", "name":"domain", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The connectivity x number of hops from each endpoint", "in":"query", "name":"hops", "required":false, "schema":{ "default":1, "format":"int32", "type":"integer" } } ], "description":"Return the graph for the specified connectivity.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"The connectivity graph is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the graph for a single connectivity", "x-internal-id":"topology-v2-ui-connectivity-{eid}-get", "x-filename-id":"topology-v2-ui-connectivity-eid-get" } }, "/topology/v2/ui/device/list":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The technology of the connected edges", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connected edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the connected devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the devices", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The custom defined node category for the connected devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The domain for the connected devices", "in":"query", "name":"domain", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The custom defined nodetype of the device.", "in":"query", "name":"nodetype", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"Return the graph for the specified device list.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"The device graph is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the graph for a list of devices", "x-internal-id":"topology-v2-ui-device-list-get", "x-filename-id":"topology-v2-ui-device-list-get" } }, "/topology/v2/ui/device/{eid}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The entity id of the device", "in":"path", "name":"eid", "required":true, "schema":{ "format":"int64", "type":"integer" } }, { "description":"The technology of the connected edges", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connected edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the connected devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the devices", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The custom defined node category for the connected devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The domain for the connected devices", "in":"query", "name":"domain", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The custom defined nodetype of the device.", "in":"query", "name":"nodetype", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The edges with this distance from the source device", "in":"query", "name":"distance", "required":false, "schema":{ "format":"double", "type":"number" } }, { "description":"The unit of measure for the distance", "in":"query", "name":"uom", "required":false, "schema":{ "default":"Meter", "type":"string" } }, { "in":"query", "name":"hops", "schema":{ "default":1, "format":"int32", "type":"integer" } } ], "description":"Return the graph for the specified device.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"The device graph is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the graph for a specific device", "x-internal-id":"topology-v2-ui-device-{eid}-get", "x-filename-id":"topology-v2-ui-device-eid-get" } }, "/topology/v2/ui/deviceHierarchy/list":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The technology of the connected edges", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connected edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the connected devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the devices", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The custom defined node category for the connected devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The domain for the connected devices", "in":"query", "name":"domain", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The custom defined nodetype of the device.", "in":"query", "name":"nodetype", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"Return the graph for the specified device list.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"The device graph is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the graph for a list of devices", "x-internal-id":"topology-v2-ui-deviceHierarchy-list-get", "x-filename-id":"topology-v2-ui-devicehierarchy-list-get" } }, "/topology/v2/ui/event/{eventid}/graph":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "in":"path", "name":"eventid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve graph data from list of connectivity eids", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/Profile" } } }, "description":"JSON response after retrieveing the profile" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve graph data from list of connectivity eids", "x-internal-id":"topology-v2-ui-event-{eventid}-graph-get", "x-filename-id":"topology-v2-ui-event-eventid-graph-get" } }, "/topology/v2/ui/icons":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "description":"Retrieve all existing Custom Icons", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The customIcons are retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve all existing Custom Icons", "x-internal-id":"topology-v2-ui-icons-get", "x-filename-id":"topology-v2-ui-icons-get" } }, "/topology/v2/ui/icons/delete":{ "delete":{ "tags":[ "Active Topology Automation/UI" ], "description":"Delete all existing uploaded custom Icons", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The uploaded customIcons are deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete all existing uploaded custom Icons", "x-internal-id":"topology-v2-ui-icons-delete-delete", "x-filename-id":"topology-v2-ui-icons-delete-delete" } }, "/topology/v2/ui/icons/delete/id/{id}":{ "delete":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The id of the customIcon to be deleted", "in":"path", "name":"id", "required":true, "schema":{ "format":"int64", "type":"integer" } } ], "description":"Delete an existing customIcon by ID", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The customIcon by the given id was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing custom Icon", "x-internal-id":"topology-v2-ui-icons-delete-id-{id}-delete", "x-filename-id":"topology-v2-ui-icons-delete-id-id-delete" } }, "/topology/v2/ui/icons/preferences":{ "post":{ "tags":[ "Active Topology Automation/UI" ], "description":"Create a new Icon Preference.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "specification":"cisco", "icon_id":"2", "networkType":"core" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceIconType" } } }, "description":"IconPreference object to be created" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "preferenceId":25, "specification":"cisco", "iconBase64":"base64string", "icon_id":"2", "networkType":"core" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceIconType" } } }, "description":"Icon Preference created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a Icon Preference", "x-internal-id":"topology-v2-ui-icons-preferences-post", "x-filename-id":"topology-v2-ui-icons-preferences-post" } }, "/topology/v2/ui/icons/preferences/createduser/{createdUser}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "in":"path", "name":"createdUser", "required":true, "schema":{ "type":"string" } } ], "description":"Return all the Icon preferences sorted in desc created date order.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "createdDate":"2023-07-19T07:51:32.000Z", "lastModifiedDate":"2023-07-19T07:51:32.000Z", "preferenceId":25, "specification":"Cisco", "iconBase64":"base64String", "lastModifiedUser":"admin", "icon_id":"2", "networkType":"core", "createdUser":"admin" } ] } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceIconType" } } }, "description":"All Icon Preferences retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get all the Icon preferences", "x-internal-id":"topology-v2-ui-icons-preferences-createduser-{createdUser}-get", "x-filename-id":"topology-v2-ui-icons-preferences-createduser-createduser-get" }, "delete":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The createdUser of the Icon Preference to be deleted", "in":"path", "name":"createdUser", "required":true, "schema":{ "type":"string" } } ], "description":"Delete all existing Icon Preferences by createdUser", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The iconPreference by the given createdUser was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete all existing Icon Preferences", "x-internal-id":"topology-v2-ui-icons-preferences-createduser-{createdUser}-delete", "x-filename-id":"topology-v2-ui-icons-preferences-createduser-createduser-delete" } }, "/topology/v2/ui/icons/preferences/id/{preferenceId}":{ "put":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The preferenceId of the iconPreference to be updated", "in":"path", "name":"preferenceId", "required":true, "schema":{ "format":"int64", "type":"integer" } } ], "description":"Update an existing Icon Preference.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "preferenceId":24, "specification":"Cisco", "icon_id":"2" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceIconType" } } }, "description":"Icon Preference object to be created" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "createdDate":"2023-07-19T07:38:24.000Z", "lastModifiedDate":"2023-07-19T07:40:59.000Z", "preferenceId":24, "specification":"cisco", "lastModifiedUser":"admin", "iconBase64":"base64.....String", "icon_id":"2", "networkType":"Core", "createdUser":"admin", "edgestyle":"solid" } } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceIconType" } } }, "description":"icon Preference updated successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Icon Preference", "x-internal-id":"topology-v2-ui-icons-preferences-id-{preferenceId}-put", "x-filename-id":"topology-v2-ui-icons-preferences-id-preferenceid-put" }, "delete":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The preferenceId of the Icon Preference to be deleted", "in":"path", "name":"preferenceId", "required":true, "schema":{ "format":"int64", "type":"integer" } } ], "description":"Delete an existing Icon Preference by Id", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The iconPreference by the given preferenceId was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing Icon Preference", "x-internal-id":"topology-v2-ui-icons-preferences-id-{preferenceId}-delete", "x-filename-id":"topology-v2-ui-icons-preferences-id-preferenceid-delete" } }, "/topology/v2/ui/icons/preferences/list":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "description":"Return all the Icon preferences sorted in desc created date order.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "createdDate":"2023-07-19T07:51:32.000Z", "lastModifiedDate":"2023-07-19T07:51:32.000Z", "preferenceId":25, "specification":"Cisco", "iconBase64":"base64String", "lastModifiedUser":"admin", "icon_id":"2", "networkType":"core", "createdUser":"admin" } ] } }, "schema":{ "$ref":"#/components/schemas/SystemPreferenceIconType" } } }, "description":"All Icon Preferences retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get all the Icon preferences", "x-internal-id":"topology-v2-ui-icons-preferences-list-get", "x-filename-id":"topology-v2-ui-icons-preferences-list-get" }, "delete":{ "tags":[ "Active Topology Automation/UI" ], "description":"Delete all existing Icon Preferences by createdUser", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The iconPreference by the given createdUser was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete all existing Icon Preferences", "x-internal-id":"topology-v2-ui-icons-preferences-list-delete", "x-filename-id":"topology-v2-ui-icons-preferences-list-delete" } }, "/topology/v2/ui/icons/upload":{ "post":{ "tags":[ "Active Topology Automation/UI" ], "description":"Upload a custom Icon from your computer.", "requestBody":{ "content":{ "*/*":{ "schema":{ "format":"binary", "type":"string" } } }, "description":"The input stream containing the image data to be uploaded." }, "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The customIcons are retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Upload a custom Icon", "x-internal-id":"topology-v2-ui-icons-upload-post", "x-filename-id":"topology-v2-ui-icons-upload-post" } }, "/topology/v2/ui/location/list":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The customer defined geographic area associated to the location", "in":"query", "name":"area", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The customer defined network circle associated to the location", "in":"query", "name":"circle", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The city identified on the location", "in":"query", "name":"city", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The technology of the connected edges", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connected edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the connected devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the devices", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The node category for the connected devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"Return the graph for the specified location list.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"The graph is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Rerieve the graph for a list of locations", "x-internal-id":"topology-v2-ui-location-list-get", "x-filename-id":"topology-v2-ui-location-list-get" } }, "/topology/v2/ui/location/{eid}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The entity id of the specfied location", "in":"path", "name":"eid", "required":true, "schema":{ "format":"int64", "type":"integer" } }, { "description":"The technology of the connected edges", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connected edges", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the connected devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The node category for the connected devices", "in":"query", "name":"nodecategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the connected devices", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The customer defined geographic area associated to each location", "in":"query", "name":"area", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The customer defined network circle associated to each location", "in":"query", "name":"circle", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The devices and locations within a specific distance of the location", "in":"query", "name":"distance", "required":false, "schema":{ "format":"double", "type":"number" } }, { "description":"The unit of measure used with the distance", "in":"query", "name":"uom", "required":false, "schema":{ "type":"string" } } ], "description":"Return the graph for the specified location.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":1, "warning":0 }, "nodes":[ { "area":"Orange County", "inventoryStatus":"INSTALLED", "latitude":28.4773, "postalCode":"32812", "entityId":4874, "nodeCategory":"National Core", "operator":"OPTIMUS", "referenceId":582553, "entityVersion":1, "deviceIdentifier":"ORLN01FL.SR-1", "specName":"Adva 5210", "activeEventDesc":"MAJOR", "autoSuggestName":"(ORLN01FL.SR-1)-ORLN01FL.SR-1.LD", "name":"ORLN01FL.SR-1.LD", "id":"ORLN01FL.SR-1", "state":"FL", "activeEvent":5, "locationCode":"ORLN01FL", "ipv4Subnet":"/18", "createdUser":"", "longitude":-81.337 }, { "country":"US", "city":"TAMPA", "latitude":27.9945, "postalCode":"33603", "operator":"OPTIMUS", "referenceId":606818, "entityVersion":1, "deviceIdentifier":"TMP001FL.SR-1", "autoSuggestName":"(TMP001FL.SR-1)-TMP001FL.SR-1.LD", "id":"TMP001FL.SR-1", "state":"FL", "activeEvent":999, "createdUser":"", "longitude":-82.4447, "area":"Hillsborough County", "inventoryStatus":"INSTALLED", "entityId":4879, "nodeCategory":"National Core", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:14:42.000Z", "specName":"Adva 5210", "name":"TMP001FL.SR-1.LD", "circle":"FL", "locationCode":"TMP001FL", "ipv4Subnet":"/18" } ], "edges":[ { "fromNode":4879, "lastModifiedDate":"2023-01-13T20:52:19.000Z", "inventoryStatus":"INSTALLED", "entityId":11264, "technology":"WDM", "businessObjectClass":"PipeDAO", "referenceId":1506081, "toNode":4874, "entityVersion":2, "createdDate":"2023-01-13T20:52:19.000Z", "specName":"DWDM_Fiber_Channel", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(1320)-TMP001FL.SR-1-ORLN01FL.SR-1", "name":"TMP001FL.SR-1-ORLN01FL.SR-1", "id":"1320", "createdUser":"", "ratecode":"100G" } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"The graph is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the graph for a specific location", "x-internal-id":"topology-v2-ui-location-{eid}-get", "x-filename-id":"topology-v2-ui-location-eid-get" } }, "/topology/v2/ui/logout-url":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "description":"Returns logout-uri from configuration using configProvider", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "LogoutResponse":{ "value":{ "uri":"/oidc/custom/logout" } } }, "schema":{ "type":"string" } } }, "description":"logout-uri retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get logout-uri", "x-internal-id":"topology-v2-ui-logout-url-get", "x-filename-id":"topology-v2-ui-logout-url-get" } }, "/topology/v2/ui/network/{network}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The network entity id to return", "in":"path", "name":"network", "required":true, "schema":{ "type":"string" } }, { "description":"The technology of the connectivity", "in":"query", "name":"technology", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The ratecode of the connectivity", "in":"query", "name":"ratecode", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vendor of the devices", "in":"query", "name":"vendor", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The specification name of the devices", "in":"query", "name":"specname", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The network category for parent or subnetworks", "in":"query", "name":"category", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The network subcategory for parent or subnetworks", "in":"query", "name":"subcategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The topology type for parent or subnetworks", "in":"query", "name":"topologytype", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The network subtype for parent or subnetworks", "in":"query", "name":"subtype", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"Return the full graph for subnetworks or only the access nodes", "in":"query", "name":"fullsubnetwork", "required":false, "schema":{ "default":false, "type":"boolean" } }, { "in":"query", "name":"nodecategory", "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"Return the graph for the specified network.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmSummary":{ "critical":0, "major":0, "warning":1 }, "nodes":[ { "country":"US", "city":"VALLEY STREAM", "latitude":40.6647, "postalCode":"11580", "operator":"OPTIMUS", "referenceId":1305070, "entityVersion":2, "deviceIdentifier":"VLLY01NY.MC-1", "autoSuggestName":"(VLLY01NY.MC-1)-VLLY01NY.MC-1.LD", "id":"VLLY01NY.MC-1", "state":"NY", "activeEvent":10, "createdUser":"", "longitude":-73.7043, "area":"Nassau County", "inventoryStatus":"INSTALLED", "entityId":8439, "nodeCategory":"Aggregation", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:55:35.000Z", "specName":"OPT9608", "activeEventDesc":"WARNING", "name":"VLLY01NY.MC-1.LD", "circle":"NY", "locationCode":"VLLY01NY" }, { "country":"US", "city":"FLORAL PARK", "latitude":40.7227, "postalCode":"11001", "operator":"OPTIMUS", "referenceId":1337576, "entityVersion":2, "deviceIdentifier":"FLRL01NY.T-1", "autoSuggestName":"(FLRL01NY.T-1)-FLRL01NY.T-1.LD", "subNetworkEntityId":18982, "id":"FLRL01NY.T-1", "state":"NY", "activeEvent":999, "createdUser":"", "longitude":-73.7029, "area":"Nassau County", "inventoryStatus":"INSTALLED", "entityId":8509, "nodeCategory":"Access", "businessObjectClass":"LogicalDeviceDAO", "createdDate":"2023-01-13T18:56:57.000Z", "specName":"ECI BG20", "name":"FLRL01NY.T-1.LD", "subNetworkName":"NY - Access 01", "circle":"NY", "locationCode":"FLRL01NY" } ], "edges":[ { "fromNode":8994, "lastModifiedDate":"2023-01-13T23:26:32.000Z", "inventoryStatus":"INSTALLED", "entityId":14977, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":1594570, "toNode":9149, "entityVersion":1, "createdDate":"2023-01-13T23:26:32.000Z", "specName":"INNI Connectivity", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(5033)-SYSS01NY.MC-1 / SYSS02NY.T-1 / 1GigE / GE1 / 1", "name":"SYSS01NY.MC-1 / SYSS02NY.T-1 / 1GigE / GE1 / 1", "lastModifiedUser":"", "id":"5033", "createdUser":"", "ratecode":"1GigE" }, { "fromNode":8439, "lastModifiedDate":"2023-01-13T23:24:57.000Z", "inventoryStatus":"INSTALLED", "entityId":14593, "technology":"Ethernet", "businessObjectClass":"PacketConnectivityDAO", "referenceId":1592394, "toNode":8509, "entityVersion":1, "createdDate":"2023-01-13T23:24:57.000Z", "specName":"INNI Connectivity", "edgeType":"COMMUNICATES_WITH", "autoSuggestName":"(4649)-FLRL01NY.T-1 / VLLY01NY.MC-1 / 1GigE / GE1 / 1", "name":"FLRL01NY.T-1 / VLLY01NY.MC-1 / 1GigE / GE1 / 1", "lastModifiedUser":"", "id":"4649", "createdUser":"", "ratecode":"1GigE" } ] } } }, "schema":{ "$ref":"#/components/schemas/GraphData" } } }, "description":"The network graph is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the graph for a network", "x-internal-id":"topology-v2-ui-network-{network}-get", "x-filename-id":"topology-v2-ui-network-network-get" } }, "/topology/v2/ui/network/{network}/subnetworks":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The network entity id to return", "in":"path", "name":"network", "required":true, "schema":{ "type":"string" } }, { "description":"The network category for parent or subnetworks", "in":"query", "name":"category", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The network subcategory for parent or subnetworks", "in":"query", "name":"subcategory", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The topology type for parent or subnetworks", "in":"query", "name":"topologytype", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The network subtype for parent or subnetworks", "in":"query", "name":"subtype", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"The list of subnetworks for a specified network.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "nodes":[ ], "subNetworkName":"NY Access 02", "locations":[ ], "subNetworkEid":28111, "parentNetworkName":"NY Regional 02" }, { "nodes":[ ], "subNetworkName":"NY Aggregation 02", "locations":[ ], "subNetworkEid":28112, "parentNetworkName":"NY Regional 02" } ] } }, "schema":{ "$ref":"#/components/schemas/SubNetwork" } } }, "description":"The list of subnetworks is retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get the list of a network subnetworks", "x-internal-id":"topology-v2-ui-network-{network}-subnetworks-get", "x-filename-id":"topology-v2-ui-network-network-subnetworks-get" } }, "/topology/v2/ui/savedsearch":{ "post":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "in":"query", "name":"validate", "schema":{ "default":false, "type":"boolean" } } ], "description":"Create a new Saved Search.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "entityType":"Connectivity", "name":"100G DWDM Connectivity", "description":"All 100G DWDM Connectivity", "id":63, "searchParams":[ { "filterValue":"DWDM", "paramNumber":1, "filterName":"technology", "operator":"matches" }, { "filterValue":"100G", "paramNumber":2, "filterName":"ratecode", "operator":"matches" } ] } } }, "schema":{ "$ref":"#/components/schemas/SavedSearchType" } } }, "description":"Saved Search object to be created" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "createdDate":"2023-03-06T22:16:49.000Z", "lastNodeCount":100, "lastModifiedDate":"2023-03-07T16:55:11.000Z", "entityType":"Connectivity", "name":"100G DWDM Connectivity", "description":"All 100G DWDM Connectivity ", "id":63, "lastEdgeCount":0, "url":"/topology/v2/ui/connectivity/list?technology=DWDM&ratecode=100G", "searchParams":[ { "filterValue":"DWDM", "paramNumber":1, "filterName":"technology", "id":63, "operator":"matches" }, { "filterValue":"100G", "paramNumber":2, "filterName":"ratecode", "id":63, "operator":"matches" } ] } } }, "schema":{ "$ref":"#/components/schemas/SavedSearchType" } } }, "description":"Saved Search created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a Saved Search", "x-internal-id":"topology-v2-ui-savedsearch-post", "x-filename-id":"topology-v2-ui-savedsearch-post" }, "get":{ "tags":[ "Active Topology Automation/UI" ], "description":"Return all the saved searches sorted in desc created date order.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "createdDate":"2023-03-06T22:16:49.000Z", "lastNodeCount":0, "lastModifiedDate":"2023-03-07T16:55:11.000Z", "entityType":"Connectivity", "name":"100G DWDM Connectivity", "description":"All 100G DWDM Connectivity ", "id":63, "lastEdgeCount":0, "url":"/topology/v2/ui/connectivity/list?technology=DWDM&ratecode=100G", "searchParams":[ { "filterValue":"DWDM", "paramNumber":1, "filterName":"technology", "id":63, "operator":"matches" }, { "filterValue":"100G", "paramNumber":2, "filterName":"ratecode", "id":63, "operator":"matches" } ] } } }, "schema":{ "$ref":"#/components/schemas/SavedSearchType" } } }, "description":"All Searches retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get all the saved searches", "x-internal-id":"topology-v2-ui-savedsearch-get", "x-filename-id":"topology-v2-ui-savedsearch-get" } }, "/topology/v2/ui/savedsearch/{id}":{ "get":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The id of the search requested", "in":"path", "name":"id", "required":true, "schema":{ "format":"int64", "type":"integer" } } ], "description":"Return Saved Search by ID", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "createdDate":"2023-01-19T00:32:34.000Z", "lastNodeCount":199, "lastModifiedDate":"2023-01-23T15:34:27.000Z", "entityType":"network", "name":"CA Regional Network", "description":"CA Regional with Access and Aggregator SubNetworks", "id":12, "lastEdgeCount":0, "url":"/topology/v2/ui/network/19001", "searchParams":[ { "filterValue":"19001", "paramNumber":1, "filterName":"EntityId", "id":12, "operator":"matches" }, { "filterValue":"CA-01", "paramNumber":2, "filterName":"identifier", "id":12, "operator":"matches" }, { "filterValue":"CA Regional", "paramNumber":3, "filterName":"name", "id":12, "operator":"matches" } ] } } }, "schema":{ "$ref":"#/components/schemas/SavedSearchType" } } }, "description":"The saved search retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get a saved search by ID", "x-internal-id":"topology-v2-ui-savedsearch-{id}-get", "x-filename-id":"topology-v2-ui-savedsearch-id-get" }, "put":{ "tags":[ "Active Topology Automation/UI" ], "description":"Update an existing Saved Search.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "lastNodeCount":199, "lastModifiedDate":"2023-01-23T15:34:27.000Z", "entityType":"network", "name":"CA Regional Network", "description":"CA Regional with Access and Aggregator SubNetworks", "id":12, "lastEdgeCount":0, "searchParams":[ { "filterValue":"19001", "paramNumber":1, "filterName":"EntityId", "id":12, "operator":"matches" }, { "filterValue":"CA-01", "paramNumber":2, "filterName":"identifier", "id":12, "operator":"matches" }, { "filterValue":"CA Regional", "paramNumber":3, "filterName":"name", "id":12, "operator":"matches" } ] } } }, "schema":{ "$ref":"#/components/schemas/SavedSearchType" } } }, "description":"Saved Search object to be created" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "createdDate":"2023-01-19T00:32:34.000Z", "lastNodeCount":199, "lastModifiedDate":"2023-01-23T15:34:27.000Z", "entityType":"network", "name":"CA Regional Network", "description":"CA Regional with Access and Aggregator SubNetworks", "id":12, "lastEdgeCount":0, "url":"/topology/v2/ui/network/19001", "searchParams":[ { "filterValue":"19001", "paramNumber":1, "filterName":"EntityId", "id":12, "operator":"matches" }, { "filterValue":"CA-01", "paramNumber":2, "filterName":"identifier", "id":12, "operator":"matches" }, { "filterValue":"CA Regional", "paramNumber":3, "filterName":"name", "id":12, "operator":"matches" } ] } } }, "schema":{ "$ref":"#/components/schemas/SavedSearchType" } } }, "description":"Saved Search created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Saved Search", "x-internal-id":"topology-v2-ui-savedsearch-{id}-put", "x-filename-id":"topology-v2-ui-savedsearch-id-put" }, "delete":{ "tags":[ "Active Topology Automation/UI" ], "parameters":[ { "description":"The id of the Saved Search to be deleted", "in":"path", "name":"id", "required":true, "schema":{ "format":"int64", "type":"integer" } } ], "description":"Delete an existing Saved Search by Id", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The Search by the given Id was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing Saved Search", "x-internal-id":"topology-v2-ui-savedsearch-{id}-delete", "x-filename-id":"topology-v2-ui-savedsearch-id-delete" } }, "/topology/v2/vertex":{ "post":{ "tags":[ "Active Topology Automation/Vertex" ], "description":"Create a New Vertex", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "entityVersion":0, "specName":"BATLD-DISpec", "latitude":0, "inventoryStatus":"INSTALLED", "name":"LD-S555.2", "entityId":0, "id":"2775001", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Create a New Vertex" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a New Vertex", "x-internal-id":"topology-v2-vertex-post", "x-filename-id":"topology-v2-vertex-post" }, "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The vertex labels to be searched. Refer Valid Values section of Active Topology Automation Model Documentation for the list of values of VertexLabel.", "in":"query", "name":"label", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The vertex name to be searched", "in":"query", "name":"name", "required":false, "schema":{ "type":"string" } }, { "description":"The vertex id to be searched", "in":"query", "name":"id", "required":false, "schema":{ "type":"string" } }, { "description":"The vertex boc to be searched", "in":"query", "name":"boc", "required":false, "schema":{ "type":"string" } }, { "description":"The vertex properties to be searched", "in":"query", "name":"property", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } }, { "description":"The number of records to skip for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The maximum number of records to return for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Return All Vertices", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":0, "createdDate":"2023-01-13T22:47:45.000Z", "lastModifiedDate":"2023-01-13T22:47:45.000Z", "autoSuggestName":"(1234)-Cisco", "name":"Cisco", "entityId":4743, "lastModifiedUser":"anonymous", "businessObjectClass":"VendorDAO", "createdUser":"anonymous" } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertices retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve All Vertices", "x-internal-id":"topology-v2-vertex-get", "x-filename-id":"topology-v2-vertex-get" }, "put":{ "tags":[ "Active Topology Automation/Vertex" ], "description":"Update an existing Vertex", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "entityVersion":2, "latitude":0, "inventoryStatus":"INSTALLED", "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Update an existing Vertex" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":3, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex updated successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Vertex", "x-internal-id":"topology-v2-vertex-put", "x-filename-id":"topology-v2-vertex-put" } }, "/topology/v2/vertex/activeEvent/eid/{eid}/severity/{severity}":{ "put":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The entity id of the device vertex", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "description":"The severity value for all active events", "in":"path", "name":"severity", "required":true, "schema":{ "type":"string" } } ], "description":"Update the Active Event Max Severity for the device", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":1, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex patched successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update the Active Event Max Severity for the device", "x-internal-id":"topology-v2-vertex-activeEvent-eid-{eid}-severity-{severity}-put", "x-filename-id":"topology-v2-vertex-activeevent-eid-eid-severity-severity-put" } }, "/topology/v2/vertex/device/eid/{eid}/children":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The entityId of the vertex", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve Child Vertices based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":3, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve Child Vertices based on entityId", "x-internal-id":"topology-v2-vertex-device-eid-{eid}-children-get", "x-filename-id":"topology-v2-vertex-device-eid-eid-children-get" } }, "/topology/v2/vertex/device/eid/{eid}/parents":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The entityId of the vertex", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve Parent Vertices based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":3, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018819, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve Parent Vertices based on entityId", "x-internal-id":"topology-v2-vertex-device-eid-{eid}-parents-get", "x-filename-id":"topology-v2-vertex-device-eid-eid-parents-get" } }, "/topology/v2/vertex/device/eid/{entityId}/events":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The entityId of the device", "in":"path", "name":"entityId", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve Active Events based on device entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "lastModifiedDate":"2023-03-02T22:54:23.000Z", "sourceSystemID":"tel.mad.mob.id_10_211_55_10_1", "thresholdSeverity":0, "metricValue":0, "entityId":28912, "thresholdValue":0, "businessObjectClass":"EventDAO", "referenceId":4, "alarmType":"EQUIPMENT_ALARM", "createdDate":"2023-03-02T22:54:23.000Z", "specificProblem":"indeterminate", "perceivedSeverity":"MAJOR", "probableCause":"port malfunction", "eventStatus":"RAISED", "thresholdTimeRange":0, "alarmDetails":"voltage=95", "href":"/alarmManagement/v4/alarm/4", "eventDate":"2023-03-02T22:54:23.000Z" } } }, "schema":{ "$ref":"#/components/schemas/Event" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve Active Events based on device entityId", "x-internal-id":"topology-v2-vertex-device-eid-{entityId}-events-get", "x-filename-id":"topology-v2-vertex-device-eid-entityid-events-get" } }, "/topology/v2/vertex/distant/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The source vertex entityId", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } }, { "description":"The distance from the source vertex", "in":"query", "name":"distance", "required":false, "schema":{ "default":"10.0", "format":"double", "type":"number" } }, { "description":"The unit of measure for the distance", "in":"query", "name":"uom", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/UnitOfMeasurement" }, { "default":"Kilometer" } ] } }, { "description":"The number of records to skip for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The maximum number of records to return for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Retrieve vertices based on distance from another vertex", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "lastModifiedDate":"2023-03-02T19:33:20.000Z", "inventoryStatus":"INSTALLED", "latitude":78.4664, "entityId":28749, "businessObjectClass":"LogicalDeviceDAO", "referenceId":9028661, "entityVersion":2, "createdDate":"2023-03-02T19:33:20.000Z", "deviceIdentifier":"PLOC_G06_102.001", "specName":"OC12_LD_EWO", "autoSuggestName":"(300006)-Device_G06_102.001", "name":"Device_G06_102.001", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"300006", "activeEvent":999, "createdUser":"uimuser", "longitude":17.4447 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve Vertices within distance", "x-internal-id":"topology-v2-vertex-distant-eid-{eid}-get", "x-filename-id":"topology-v2-vertex-distant-eid-eid-get" } }, "/topology/v2/vertex/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The entityId of the vertex", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Vertex based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":3, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Vertex based on entityId", "x-internal-id":"topology-v2-vertex-eid-{eid}-get", "x-filename-id":"topology-v2-vertex-eid-eid-get" }, "delete":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The entityid of the vertex to be deleted", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Delete an existing Vertex", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The Vertex was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing Vertex", "x-internal-id":"topology-v2-vertex-eid-{eid}-delete", "x-filename-id":"topology-v2-vertex-eid-eid-delete" } }, "/topology/v2/vertex/eids":{ "post":{ "tags":[ "Active Topology Automation/Vertex" ], "description":"Return a list of vertices using an input list", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":[ 28865, 28862 ] } }, "schema":{ "items":{ "format":"int64", "type":"integer" }, "type":"array" } } }, "description":"The list of entityIds to return" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "lastModifiedDate":"2023-03-02T21:07:04.000Z", "inventoryStatus":"INSTALLED", "latitude":78.4664, "entityId":28862, "businessObjectClass":"LogicalDeviceDAO", "referenceId":9161465, "entityVersion":2, "createdDate":"2023-03-02T21:07:04.000Z", "deviceIdentifier":"PLOC_G10_103.001", "specName":"OC12_LD_EWO", "autoSuggestName":"(300019)-Device_G10_103.001", "name":"Device_G10_103.001", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"300019", "activeEvent":999, "createdUser":"uimuser", "longitude":17.4447 }, { "lastModifiedDate":"2023-03-02T22:54:23.000Z", "inventoryStatus":"INSTALLED", "latitude":78.4664, "entityId":28865, "businessObjectClass":"LogicalDeviceDAO", "referenceId":9167197, "entityVersion":3, "createdDate":"2023-03-02T21:07:05.000Z", "deviceIdentifier":"PLOC_G10_104.001", "specName":"OC12_LD_EWO", "activeEventDesc":"MAJOR", "autoSuggestName":"(300020)-Device_G10_104.002", "name":"Device_G10_104.002", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"300020", "activeEvent":5, "createdUser":"uimuser", "longitude":17.4447 } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/Vertex" }, "type":"array" } } }, "description":"New Event created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of Vertices", "x-internal-id":"topology-v2-vertex-eids-post", "x-filename-id":"topology-v2-vertex-eids-post" } }, "/topology/v2/vertex/event":{ "post":{ "tags":[ "Active Topology Automation/Vertex" ], "description":"Create a new Event", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "alarmType":"deviceAlarm", "specificProblem":"indeterminate", "byDeviceIdentifier":true, "perceivedSeverity":"CRITICAL", "probableCause":"port malfunction", "sourceSystemID":"orcl.mob.id_101_21_55_10", "eventStatus":"RAISED", "alarmDetails":"voltage=95", "href":"/alarmManagement/v4/alarm/99795", "businessObjectClass":"EventDAO", "deviceId":"PLOC_G10_104.001", "referenceId":"99795" } } }, "schema":{ "$ref":"#/components/schemas/Event" } } }, "description":"The new event to be created" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "alarmType":"deviceAlarm", "specificProblem":"indeterminate", "perceivedSeverity":"CRITICAL", "probableCause":"port malfunction", "sourceSystemID":"orcl.mob.id_101_21_55_10", "eventStatus":"RAISED", "entityId":29010, "alarmDetails":"voltage=95", "href":"/alarmManagement/v4/alarm/99795", "businessObjectClass":"EventDAO", "referenceId":99795 } } }, "schema":{ "$ref":"#/components/schemas/Event" } } }, "description":"New Event created successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create an Event", "x-internal-id":"topology-v2-vertex-event-post", "x-filename-id":"topology-v2-vertex-event-post" }, "put":{ "tags":[ "Active Topology Automation/Vertex" ], "description":"Update an existing Event", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "instanceName":"PSSC01NJ.MC-1.Gi/2/1", "sourceSystemID":"PSSC01NJ.MC-1.Gi/2/1", "thresholdSeverity":3, "metricValue":0, "entityId":21504, "thresholdMessage":"None", "thresholdValue":0, "businessObjectClass":"EventDAO", "referenceId":300050, "thresholdName":"None", "thresholdTypeName":"Equipment Alarm", "alarmType":"EQUIPMENT_ALARM", "specificProblem":"indeterminate", "perceivedSeverity":"MAJOR", "probableCause":"Port Malfunction", "eventStatus":"RAISED", "thresholdTimeRange":0, "alarmDetails":"voltage=105", "href":"/alarmManagement/v4/alarm/300050", "eventDate":"2023-01-20T14:24:04.000Z" } } }, "schema":{ "$ref":"#/components/schemas/Event" } } }, "description":"Update an existing Vertex" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "instanceName":"PSSC01NJ.MC-1.Gi/2/1", "lastModifiedDate":"2023-01-20T14:24:04.000Z", "sourceSystemID":"PSSC01NJ.MC-1.Gi/2/1", "thresholdSeverity":3, "metricValue":0, "entityId":21504, "thresholdMessage":"None", "thresholdValue":0, "businessObjectClass":"EventDAO", "referenceId":300050, "thresholdName":"None", "thresholdTypeName":"Equipment Alarm", "alarmType":"EQUIPMENT_ALARM", "createdDate":"2023-01-20T14:24:04.000Z", "specificProblem":"indeterminate", "perceivedSeverity":"MAJOR", "probableCause":"Port Malfunction", "eventStatus":"RAISED", "thresholdTimeRange":0, "alarmDetails":"voltage=95", "href":"/alarmManagement/v4/alarm/300050", "eventDate":"2023-01-20T14:24:04.000Z" } } }, "schema":{ "$ref":"#/components/schemas/Event" } } }, "description":"Event updated successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Event", "x-internal-id":"topology-v2-vertex-event-put", "x-filename-id":"topology-v2-vertex-event-put" } }, "/topology/v2/vertex/event/config/{type}":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The ALARMTYPE, EVENTSTATUS or SEVERITY type to return", "in":"path", "name":"type", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve Event Type values based on Type", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ "COMMUNICATIONS_ALARM", "PROCESSING_ERROR_ALARM", "ENVIRONMENTAL_ALARM", "QUALITY_OF_SERVICE_ALARM", "EQUIPMENT_ALARM", "INTEGRITY_VIOLATION", "OPERATIONAL_VIOLATION", "PHYSICAL_VIOLATION", "SECURITY_SERVICE", "MECHANISM_VIOLATION", "TIME_DOMAIN_VIOLATION" ] } }, "schema":{ "type":"string" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve Event Type values", "x-internal-id":"topology-v2-vertex-event-config-{type}-get", "x-filename-id":"topology-v2-vertex-event-config-type-get" } }, "/topology/v2/vertex/event/eid/{eid}":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The entityId of the event", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve the event based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "instanceName":"PSSC01NJ.MC-1.Gi/2/1", "lastModifiedDate":"2023-01-20T14:24:04.000Z", "sourceSystemID":"PSSC01NJ.MC-1.Gi/2/1", "thresholdSeverity":3, "metricValue":0, "entityId":21504, "thresholdMessage":"None", "thresholdValue":0, "businessObjectClass":"EventDAO", "referenceId":300050, "thresholdName":"None", "thresholdTypeName":"Equipment Alarm", "alarmType":"EQUIPMENT_ALARM", "createdDate":"2023-01-20T14:24:04.000Z", "specificProblem":"indeterminate", "perceivedSeverity":"major", "probableCause":"Port Malfunction", "eventStatus":"raised", "thresholdTimeRange":0, "alarmDetails":"voltage=95", "href":"/alarmManagement/v4/alarm/300050", "eventDate":"2023-01-20T14:24:04.000Z" } } }, "schema":{ "$ref":"#/components/schemas/Event" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve the event based on entityId", "x-internal-id":"topology-v2-vertex-event-eid-{eid}-get", "x-filename-id":"topology-v2-vertex-event-eid-eid-get" } }, "/topology/v2/vertex/id/{id}":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The id of the vertex", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The label of the vertex. Refer Valid Values section of Active Topology Automation Model Documentation for the list of values of VertexLabel.", "in":"query", "name":"label", "required":false, "schema":{ "items":{ "type":"string" }, "type":"array" } } ], "description":"Retrieve an existing Vertex based on entityId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":3, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Vertex based on entityId", "x-internal-id":"topology-v2-vertex-id-{id}-get", "x-filename-id":"topology-v2-vertex-id-id-get" } }, "/topology/v2/vertex/typeid/{typeid}/id/{id}":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The typeId of the vertex", "in":"path", "name":"typeid", "required":true, "schema":{ "type":"string" } }, { "description":"The id of the vertex", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Vertex based on typeId and Id", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":3, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Vertex based on typeId and Id", "x-internal-id":"topology-v2-vertex-typeid-{typeid}-id-{id}-get", "x-filename-id":"topology-v2-vertex-typeid-typeid-id-id-get" } }, "/topology/v2/vertex/typeid/{typeid}/referenceid/{referenceid}":{ "get":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The typeId of the vertex", "in":"path", "name":"typeid", "required":true, "schema":{ "type":"string" } }, { "description":"The referenceId of the vertex", "in":"path", "name":"referenceid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieve an existing Vertex based on typeId and referenceId", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "entityVersion":3, "specName":"BATLD-DISpec", "inventoryStatus":"INSTALLED", "latitude":0, "name":"LD-S555.2", "entityId":100018820, "lastModifiedUser":"uimuser", "id":"2175100", "businessObjectClass":"LogicalDeviceDAO", "referenceId":60000001, "longitude":0 } } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertex retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve an existing Vertex based on typeId and referenceId", "x-internal-id":"topology-v2-vertex-typeid-{typeid}-referenceid-{referenceid}-get", "x-filename-id":"topology-v2-vertex-typeid-typeid-referenceid-referenceid-get" }, "delete":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The typeId of the vertex", "in":"path", "name":"typeid", "required":true, "schema":{ "type":"string" } }, { "description":"The referenceId of the vertex", "in":"path", "name":"referenceid", "required":true, "schema":{ "type":"string" } } ], "description":"Delete an existing Vertex based on typeId and referenceId", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"The Vertex was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an existing Vertex based on typeId and referenceId", "x-internal-id":"topology-v2-vertex-typeid-{typeid}-referenceid-{referenceid}-delete", "x-filename-id":"topology-v2-vertex-typeid-typeid-referenceid-referenceid-delete" } }, "/topology/v2/vertex/vertices":{ "post":{ "tags":[ "Active Topology Automation/Vertex" ], "parameters":[ { "description":"The number of records to skip for pagination", "in":"query", "name":"offset", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The maximum number of records to return for pagination", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Return a list of vertices using an input Map containing typeId_referenceId and typeId", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "1_9167197":"1", "1_9161465":"1" } } }, "schema":{ "type":"object" } } }, "description":"The list of vertices to return" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "lastModifiedDate":"2023-03-02T21:07:04.000Z", "inventoryStatus":"INSTALLED", "latitude":78.4664, "entityId":28862, "businessObjectClass":"LogicalDeviceDAO", "referenceId":9161465, "entityVersion":2, "createdDate":"2023-03-02T21:07:04.000Z", "deviceIdentifier":"PLOC_G10_103.001", "specName":"OC12_LD_EWO", "autoSuggestName":"(300019)-Device_G10_103.001", "name":"Device_G10_103.001", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"300019", "activeEvent":999, "createdUser":"uimuser", "longitude":17.4447 }, { "lastModifiedDate":"2023-03-02T22:54:23.000Z", "inventoryStatus":"INSTALLED", "latitude":78.4664, "entityId":28865, "businessObjectClass":"LogicalDeviceDAO", "referenceId":9167197, "entityVersion":3, "createdDate":"2023-03-02T21:07:05.000Z", "deviceIdentifier":"PLOC_G10_104.001", "specName":"OC12_LD_EWO", "activeEventDesc":"MAJOR", "autoSuggestName":"(300020)-Device_G10_104.002", "name":"Device_G10_104.002", "geometry":{ "gtype":1, "dim":2, "srid":8307 }, "lastModifiedUser":"uimuser", "id":"300020", "activeEvent":5, "createdUser":"uimuser", "longitude":17.4447 } ] } }, "schema":{ "$ref":"#/components/schemas/Vertex" } } }, "description":"Vertices returned successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Retrieve a list of Vertices", "x-internal-id":"topology-v2-vertex-vertices-post", "x-filename-id":"topology-v2-vertex-vertices-post" } }, "/topology/v2/fallout/events":{ "get":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"The state of the fallout event to filter results by.", "in":"query", "name":"state", "required":false, "schema":{ "type":"string" } }, { "description":"The error code of the fallout event to filter results by.", "in":"query", "name":"errorCode", "required":false, "schema":{ "type":"string" } }, { "description":"The event type of the fallout event to filter results by.", "in":"query", "name":"eventType", "required":false, "schema":{ "type":"string" } }, { "description":"The action of the fallout event to filter results by.", "in":"query", "name":"action", "required":false, "schema":{ "type":"string" } }, { "description":"The number of items to skip before starting to return the results.", "in":"query", "name":"offset", "required":false, "schema":{ "default":"0", "format":"int32", "type":"integer" } }, { "description":"the maximum number of results to return.", "in":"query", "name":"limit", "required":false, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The target service of the fallout event to filter results by.", "in":"query", "name":"targetService", "required":false, "schema":{ "type":"string" } }, { "description":"The start date of the creation date range filter (format: yyyy-MM-dd)", "in":"query", "name":"startCreationDate", "required":false, "schema":{ "type":"string" } }, { "description":"The end date of the creation date range filter (format: yyyy-MM-dd)", "in":"query", "name":"endCreationDate", "required":false, "schema":{ "type":"string" } }, { "description":"The start date of the last modified date range filter (format: yyyy-MM-dd)", "in":"query", "name":"startLastModifiedDate", "required":false, "schema":{ "type":"string" } }, { "description":"The end date of the last modified date range filter (format: yyyy-MM-dd)", "in":"query", "name":"endLastModifiedDate", "required":false, "schema":{ "type":"string" } }, { "description":"The field and direction to sort results. Format: field:asc|desc", "in":"query", "name":"sortField", "required":false, "schema":{ "type":"string" } } ], "description":"Retrieves all fallout events that match the search criteria specified in the query parameters.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "errorDescription":"Invalid event type provided", "eventHeaders":[ { "eventType":"TopologyNodeUpdate" } ], "errorCode":"[TOP-101]", "entityId":"100", "eventType":"TopologyNodeUpdate", "event":[ { "name":"DEVICE_9990", "waitingTime":"20", "id":"DEVICE_9990", "businessObjectClass":"LogicalDeviceDAO", "referenceId":"9990" } ] } } }, "schema":{ "$ref":"#/components/schemas/FalloutEvent" } } }, "description":"The fallout events were retrieved sucessfully." }, "204":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"No fallout events found" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get fallout events", "x-internal-id":"topology-v2-fallout-events-get", "x-filename-id":"topology-v2-fallout-events-get" }, "delete":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"The state of the Fallout Events to get deleted.", "in":"query", "name":"state", "required":false, "schema":{ "type":"string" } }, { "description":"The action of the Fallout Events to get deleted.", "in":"query", "name":"action", "required":false, "schema":{ "type":"string" } }, { "description":"The error code of the Fallout Events to get deleted.", "in":"query", "name":"errorCode", "required":false, "schema":{ "type":"string" } }, { "description":"The Target Service of the Fallout Events to get deleted. Supported values for targetService are ATA, SSC & AlarmConsumer.", "in":"query", "name":"targetService", "required":true, "schema":{ "type":"string" } }, { "description":"Event type", "in":"query", "name":"eventType", "required":false, "schema":{ "type":"string" } }, { "description":"Start of Creation date (yyyy-MM-dd)", "in":"query", "name":"startCreationDate", "required":false, "schema":{ "type":"string" } }, { "description":"End of Creation date (yyyy-MM-dd)", "in":"query", "name":"endCreationDate", "required":false, "schema":{ "type":"string" } }, { "description":"Start of LastModified date (yyyy-MM-dd)", "in":"query", "name":"startLastModifiedDate", "required":false, "schema":{ "type":"string" } }, { "description":"End of LastModified date (yyyy-MM-dd)", "in":"query", "name":"endLastModifiedDate", "required":false, "schema":{ "type":"string" } }, { "description":"Set to true to delete all fallout events (ignores other query parameters)", "in":"query", "name":"all", "required":false, "schema":{ "default":false, "type":"boolean" } } ], "description":"Deletes the list of fallout events that matches the search criteria specified in query parameters.", "responses":{ "200":{ "content":{ "application/json":{ "example":"Success", "schema":{ "type":"string" } } }, "description":"Fallout Events with given filters was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Deletes fallout events", "x-internal-id":"topology-v2-fallout-events-delete", "x-filename-id":"topology-v2-fallout-events-delete" } }, "/topology/v2/fallout/events/aggregate":{ "post":{ "tags":[ "Fallout Events Resolution" ], "description":"Returns possible values for a selected filter (like state, action, target service, etc.) based on combination of other selected filters. Used for dynamically populating filter chips on the Fallout Events UI.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Example Aggregate Request":{ "value":{ "filters":[ { "filter":"targetService", "value":[ "ATA", "AlarmConsumer" ] } ], "selectedFilter":"state" } } }, "schema":{ "$ref":"#/components/schemas/FalloutAggregateFilterRequest" } } }, "description":"Selected filter and current combination filters.", "required":true }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Aggregate Response Example for State filter":{ "value":{ "totalResults":5, "hasMore":false, "items":[ { "filter":"state", "plugin":"termsLOV", "label":"PENDING", "filterLabel":"Status", "value":"PENDING" }, { "filter":"state", "plugin":"termsLOV", "label":"IN_PROGRESS", "filterLabel":"Status", "value":"IN_PROGRESS" }, { "filter":"state", "plugin":"termsLOV", "label":"READY_TO_RESUBMIT", "filterLabel":"Status", "value":"READY_TO_RESUBMIT" }, { "filter":"state", "plugin":"termsLOV", "label":"FAILED", "filterLabel":"Status", "value":"FAILED" }, { "filter":"state", "plugin":"termsLOV", "label":"COMPLETED", "filterLabel":"Status", "value":"COMPLETED" } ] } } }, "schema":{ "$ref":"#/components/schemas/FalloutEventFilterResponse" } } }, "description":"Successfully fetched distinct values for the selected filter." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get available values for filters", "x-internal-id":"topology-v2-fallout-events-aggregate-post", "x-filename-id":"topology-v2-fallout-events-aggregate-post" } }, "/topology/v2/fallout/events/eid":{ "delete":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"List of entityIds of fallout events delimited with comma to be deleted", "in":"query", "name":"eids", "required":true, "schema":{ "type":"string" } } ], "description":"Delete the list of fallout events that matches with the entityIds provided in eids query parameter.", "responses":{ "200":{ "content":{ "application/json":{ "example":4, "schema":{ "type":"string" } } }, "description":"Fallout Events with given list of entityIds got deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete fallout events by list of entityIds", "x-internal-id":"topology-v2-fallout-events-eid-delete", "x-filename-id":"topology-v2-fallout-events-eid-delete" } }, "/topology/v2/fallout/events/eid/{eid}":{ "get":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"The unique identifier (eid) of the fallout event to retrieve.", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Retrieves the fallout event that matches the specified Entity Id(eid).", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "errorDescription":"Invalid event type provided", "eventHeaders":[ { "eventType":"TopologyNodeUpdate" } ], "errorCode":"[TOP-101]", "entityId":"100", "eventType":"TopologyNodeUpdate", "event":[ { "name":"DEVICE_9990", "waitingTime":"20", "id":"DEVICE_9990", "businessObjectClass":"LogicalDeviceDAO", "referenceId":"9990" } ] } } }, "schema":{ "$ref":"#/components/schemas/FalloutEvent" } } }, "description":"The fallout event was retrived successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get Fallout Event by Entity Id", "x-internal-id":"topology-v2-fallout-events-eid-{eid}-get", "x-filename-id":"topology-v2-fallout-events-eid-eid-get" }, "put":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Updates the attribute of fallout event that matches the specified entity id (eid). The event can be resubmitted later.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "errorDescription":"Invalid event type provided", "eventHeaders":[ { "eventType":"TopologyNodeUpdate" } ], "errorCode":"[TOP-101]", "entityId":"100", "eventType":"TopologyNodeUpdate", "event":[ { "name":"DEVICE_9990", "waitingTime":"20", "id":"DEVICE_9990", "businessObjectClass":"LogicalDeviceDAO", "referenceId":"9990" } ] } } }, "schema":{ "$ref":"#/components/schemas/FalloutEvent" } } }, "description":"Update an existing Fallout event" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "errorDescription":"Invalid event type provided", "eventHeaders":[ { "eventType":"TopologyNodeUpdate" } ], "errorCode":"[TOP-101]", "entityId":"100", "eventType":"TopologyNodeUpdate", "event":[ { "name":"DEVICE_9990", "waitingTime":"20", "id":"DEVICE_9990", "businessObjectClass":"LogicalDeviceDAO", "referenceId":"9990" } ] } } }, "schema":{ "$ref":"#/components/schemas/FalloutEvent" } } }, "description":"Fallout event updated successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update a fallout event by entityId", "x-internal-id":"topology-v2-fallout-events-eid-{eid}-put", "x-filename-id":"topology-v2-fallout-events-eid-eid-put" }, "delete":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"The entityId of the fallout event to be deleted", "in":"path", "name":"eid", "required":true, "schema":{ "type":"string" } } ], "description":"Deletes the fallout event that matches with the provided eid.", "responses":{ "200":{ "content":{ "application/json":{ "example":1, "schema":{ "type":"string" } } }, "description":"The Fallout Event was deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"delete fallout event by entityId", "x-internal-id":"topology-v2-fallout-events-eid-{eid}-delete", "x-filename-id":"topology-v2-fallout-events-eid-eid-delete" } }, "/topology/v2/fallout/events/filters":{ "post":{ "tags":[ "Fallout Events Resolution" ], "description":"Returns predefined filter options such as state, target system, action, event type, and date range. These values are used to populate UI filter chips.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FalloutFilterRequest" } } } }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Filter Response":{ "value":{ "totalResults":6, "hasMore":false, "items":[ { "filter":"state", "plugin":"termsLOV", "label":"PENDING", "filterLabel":"Status", "value":[ "PENDING" ] }, { "filter":"targetService", "plugin":"termsLOV", "label":"ATA", "filterLabel":"Target System", "value":[ "ATA" ] }, { "filter":"action", "plugin":"termsLOV", "label":"NEW", "filterLabel":"Actions", "value":[ "NEW" ] }, { "filter":"eventType", "plugin":"termsLOV", "label":"TopologyNodeCreate", "filterLabel":"Event Type", "value":[ "TopologyNodeCreate" ] }, { "filter":"creationDate", "metadata":{ "gte":"2025-05-01", "attributeName":"creationDate", "lte":"2025-05-21" }, "plugin":"dateRangeInput" }, { "filter":"lastModifiedDate", "metadata":{ "gte":"2025-05-01", "attributeName":"lastModifiedDate", "lte":"2025-05-21" }, "plugin":"dateRangeInput" } ] } } }, "schema":{ "$ref":"#/components/schemas/FalloutEventFilterResponse" } } }, "description":"Successfully fetched filter options." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Return default filter chips for fallout events", "x-internal-id":"topology-v2-fallout-events-filters-post", "x-filename-id":"topology-v2-fallout-events-filters-post" } }, "/topology/v2/fallout/events/rebuild":{ "post":{ "tags":[ "Fallout Events Resolution" ], "requestBody":{ "content":{ "application/json":{ "examples":{ "Sample Request":{ "value":{ "endCreationDate":"2025-07-16", "targetService":"ATA", "startCreationDate":"2025-07-15", "endLastModifiedDate":"2025-07-16", "errorCode":"[TOP-4006]", "action":"REBUILD", "startLastModifiedDate":"2025-07-15", "state":"PENDING", "eventType":"ORDER_FALLOUT", "eids":[ "101", "102" ] } } }, "schema":{ "$ref":"#/components/schemas/RebuildRequest" } } }, "description":"Triggers a synchronous rebuild of ATA for the specified fallout events by correcting missing dependencies for fallout events in PENDING and FAILED state. The correction uses a DB Link to UIM schema to validate and fetch missing entities. Fallout events in COMPLETED state are ignored. After successful correction, the fallout events are marked as READY_TO_RESUBMIT with action REBUILD. The fallout events have to be resubmitted after successful rebuild. Only fallout events with SOURCE_SYSTEM = 'UIM' and ERROR_CODE in [TOP-4006, TOP-2006] are processed. Request to rebuild fallout events using either EIDs or filters (such as state, action, errorCode, eventType, or date ranges). At least one of them is required. If both `eids` and filter fields are provided, only the EIDs will be used for processing; filters will be ignored. If only filters are provided (and no EIDs), all matching fallout events will be rebuilt. The 'targetService' field is mandatory in both cases. Date ranges must be in the format 'yyyy-MM-dd'.", "required":true }, "responses":{ "200":{ "content":{ "application/json":{ "example":"Fallout Events Rebuild Process Successful", "schema":{ "type":"string" } } }, "description":"Fallout Events Rebuild Process Successful" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Rebuild the fallout events by filters", "x-internal-id":"topology-v2-fallout-events-rebuild-post", "x-filename-id":"topology-v2-fallout-events-rebuild-post" } }, "/topology/v2/fallout/events/rebuild/jobs":{ "post":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"Based on targetService, Fallout jobs will schedule. Supported value for targetService is ATA ", "in":"query", "name":"targetService", "required":true, "schema":{ "type":"string" } } ], "description":"Schedules the fallout events jobs for rebuilding ATA by correcting missing dependencies on the PENDING and FAILED fallout events. To rebuild, connects to UIM Schema. After correction of the dependencies the fallout events has to be resubmitted. This uses the DB Link to UIM Schema for dependencies corrections. The Fallout events in COMPLETED state are ignored. ", "responses":{ "200":{ "content":{ "application/json":{ "example":"Fallout jobs scheduled successfully", "schema":{ "type":"string" } } }, "description":"Fallout jobs for rebuild topology scheduled successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Schedule rebuild fallout event jobs", "x-internal-id":"topology-v2-fallout-events-rebuild-jobs-post", "x-filename-id":"topology-v2-fallout-events-rebuild-jobs-post" }, "delete":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"Based on targetService, Fallout running jobs will be Cancel. Supported value for targetService is ATA. ", "in":"query", "name":"targetService", "required":true, "schema":{ "type":"string" } } ], "description":"Deletes the schedule fallout event jobs for rebuilding ATA.", "responses":{ "200":{ "content":{ "application/json":{ "example":"Scheduled jobs dropped successfully", "schema":{ "type":"string" } } }, "description":"Scheduled fallout jobs dropped successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Cancel running rebuild fallout event Jobs", "x-internal-id":"topology-v2-fallout-events-rebuild-jobs-delete", "x-filename-id":"topology-v2-fallout-events-rebuild-jobs-delete" } }, "/topology/v2/fallout/events/resubmit":{ "post":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"The state of the Fallout Events to resubmit. Default value is READY_TO_RESUBMIT", "in":"query", "name":"state", "required":false, "schema":{ "default":"READY_TO_RESUBMIT", "type":"string" } }, { "description":"The action of the Fallout Events to resubmit. Default value is REBUILD", "in":"query", "name":"action", "required":false, "schema":{ "default":"REBUILD", "type":"string" } }, { "description":"The error code of the Fallout Events to resubmit.", "in":"query", "name":"errorCode", "required":false, "schema":{ "type":"string" } }, { "description":"Based on targetService, event will be resubmitted to target kafka retry topic. Supported values for targetService are ATA, SSC & AlarmConsumer.", "in":"query", "name":"targetService", "required":true, "schema":{ "type":"string" } } ], "description":"Resubmits the fallout events to the target service's retry topic and updates their state to COMPLETED or FAILED. Fallout events that are already in the COMPLETED state will not be resubmitted.The request body is the preferred method for submitting parameters. Query parameters are supported for backward compatibility but will be deprecated in the future.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request Body Example":{ "value":{ "targetService":"ATA", "action":"REBUILD", "state":"READY_TO_RESUBMIT", "eids":[ "91", "92", "93" ], "errorcode":"[TOP-4006]" } } }, "schema":{ "$ref":"#/components/schemas/ResubmitRequest" } } }, "description":"Request body used to resumit fallout events" }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Filtered Request Response":{ "value":{ "processed":10, "targetService":"ATA", "events_to_resolve":{ "ready_to_resubmit":1, "pending":238, "failed":0 } } }, "EIDs Request Response":{ "value":{ "processed":3 } } }, "schema":{ "example":{ "processed":0, "targetService":"ATA", "events_to_resolve":{ "ready_to_resubmit":1, "pending":238, "failed":0 } } } } }, "description":"Fallout Events were resubmitted successfully.\n\n- If `eids` are provided: Only those entity IDs are processed. Response is minimal.\n- If `eids` are NOT provided: Filters like `state`, `action`, and `errorcode` are used to select events.\n- When using filters, `targetService` is mandatory and must be a valid system ID." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Resubmit fallout events", "x-internal-id":"topology-v2-fallout-events-resubmit-post", "x-filename-id":"topology-v2-fallout-events-resubmit-post" } }, "/topology/v2/fallout/events/summary":{ "get":{ "tags":[ "Fallout Events Resolution" ], "parameters":[ { "description":"Based on targetService, will get fallout events summary. Supported values for targetService are ATA, SSC & AlarmConsumer.", "in":"query", "name":"targetService", "required":false, "schema":{ "type":"string" } }, { "description":"Group by one or more of the following fields (comma separated): errorCode, state, action, sourceSystemId, targetService.", "in":"query", "name":"groupBy", "required":false, "schema":{ "type":"string" } }, { "description":"Retrieves the fallout events summary grouped by sourceSystemId. ", "in":"query", "name":"sourceSystemId", "required":false, "schema":{ "type":"string" } } ], "description":"The fallout events summary was retrieved sucessfuly. Optionally, results can be grouped by one or more fields (errorCode, state, action, sourceSystemiI, targetService) using the 'groupBy' query parameter.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "targetService":"ATA", "count":5, "actions":[ { "count":2, "action":"new", "states":{ "pending":2 } }, { "count":2, "action":"resubmit", "states":{ "failed":1, "completed":1 } }, { "count":1, "action":"old", "states":{ "inprogress":1 } } ] } }, "GroupByStateWithGivenTargetService":{ "summary":"Grouped by state for a specific targetService (ATA)", "value":{ "fallouts":[ { "name":"ATA", "count":"20", "groupBy":"state", "groupByItems":[ { "name":"PENDING", "count":"10" }, { "name":"FAILED", "count":"10" } ] } ], "totalCount":"20" } }, "GroupByTargetService":{ "summary":"Grouped by targetService", "value":{ "fallouts":[ { "name":"ATA", "count":10 }, { "name":"AlarmConsumer", "count":20 } ], "totalCount":"30" } }, "GroupByTargetServiceAndState":{ "summary":"Grouped by targetService and state", "value":{ "fallouts":[ { "name":"SSC", "count":"20", "groupBy":"state", "groupByItems":[ { "name":"PENDING", "count":"10" }, { "name":"FAILED", "count":"10" } ] }, { "name":"ATA", "count":"20", "groupBy":"state", "groupByItems":[ { "name":"PENDING", "count":"10" }, { "name":"FAILED", "count":"10" } ] } ], "totalCount":"100" } } }, "schema":{ "oneOf":[ { "$ref":"#/components/schemas/FalloutEventSummary" }, { "$ref":"#/components/schemas/FalloutEventGroupSummary" } ] } } }, "description":"Returns either a detailed summary of fallout events with counts grouped by actions and their respective states when no 'groupBy' parameter is provided, or a grouped summary based on the 'groupBy' query parameter (which can be one or more of errorcode, state, action, sourcesystemid and/or targetService)." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"You aren't authorized to make this request." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get fallout events summary", "x-internal-id":"topology-v2-fallout-events-summary-get", "x-filename-id":"topology-v2-fallout-events-summary-get" } }, "/sia/v1/event":{ "post":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "example":false, "in":"query", "name":"allowCleared", "schema":{ "type":"boolean" } } ], "description":"Create a new Event.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "resourceId":"1050028-1350041", "instanceName":"HYDPX04KP.P01P::HYDPX04KP.P01-129.3A.08-Line-1.10GigE_1", "lastModifiedDate":"2025-03-03T10:29:40.920Z", "sourceSystemID":"ASAN", "edgeLinkEntityId":[ "2670443" ], "resourceHref":"http://localhost:7801/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/10-1050028-1350041", "resourceName":"HYDPX04KP.P01-129.3A.08-Line-1.10GigE_1", "resourceCategory":"ODP", "referenceId":"70000463290", "alarmType":"processingErrorAlarm", "createdDate":"2025-03-03T10:29:40.920Z", "resourceSubType":"", "perceivedSeverity":"major", "probableCause":"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge) Port 700001", "eventStatus":"RAISED", "alarmDetails":"{\"corba\":{\"rcaiIndicator\":\"false\",\"probableCauseQualifier\":\"51118@@0@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@357\",\"serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",\"additionalText\":\"No Info\",\"neTime\":\"20230828123441.0\",\"emsTime\":\"20230828123505.8\",\"corbaEventType\":\"ECI\",\"objectType\":\"OT_EQUIPMENT\",\"perceivedSeverity\":\"PS_CRITICAL\",\"probableCause\":\"ENV\",\"nativeEMSName\":\"External Alarm Unit\",\"layerRate\":\"0\",\"nativeProbableCause\":\"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)\",\"additionalInfo\":{\"LSNExt_GroupName\":\"CHANDIGARH\",\"LSNExt_MEName\":\"PB20_CHD_SEC08_01\",\"LSNExt_ALCV\":\"Unknown\",\"LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",\"LSNExt_AlarmUniqueString\":\"EMS DN=LSN/EMS_BG-40_81, EMS notifId=2949292, CAM ID=3939953\"},\"objectName\":{\"EquipmentHolder\":\"/shelf=1/slot=1\",\"Equipment\":\"1\",\"ManagedElement\":\"LSN/EMS_BG-40_81/51118\",\"EMS\":\"ECI/LightSoft_1\"},\"notificationId\":\"3743573\",\"isClearable\":\"true\",\"affectedTPList\":\"\"}}", "resourceActiveEvent":5, "nodeLinkEntityId":"2670112", "resourceType":"PhysicalPort", "eventDate":"2024-06-19T05:41:02.000Z" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"The new event to be created." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "lastModifiedDate":"2024-08-26T06:21:40.622Z", "sourceSystemID":"LINK", "resourceHref":"http://localhost:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "resourceName":"ODP-REGSK-195 PD", "referenceId":"5008", "resourceCategory":"ODP", "alarmType":"Device Failure", "createdDate":"2024-08-26T06:21:40.622Z", "specificProblem":"Power Failure", "ownerName":"llatham", "perceivedSeverity":"MAJOR", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"voltage=None", "href":"/alarmManagement/v4/alarm/5003", "lang":"en", "nodeLinkEntityId":"93492", "analysisStatus":"PENDING", "eventDate":"2024-06-11T04:32:17.235Z" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"New Event created successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Create a new Event", "x-internal-id":"sia-v1-event-post", "x-filename-id":"sia-v1-event-post" }, "put":{ "tags":[ "Event and Impact Analysis/Event" ], "description":"Update an existing Event.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "sourceSystemID":"LINK", "resourceHref":"http://localhost:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "resourceName":"ODP-REGSK-195 PD", "resourceCategory":"ODP", "referenceId":"5003", "alarmType":"Device Failure", "specificProblem":"Power Failure", "ownerName":"llatham", "perceivedSeverity":"CRITICAL", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"voltage=None", "href":"/alarmManagement/v4/alarm/5003", "nodeLinkEntityId":"93492", "analysisStatus":"PENDING", "eventDate":"2024-06-11T04:32:17.235Z" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Update an existing Event." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "sourceSystemID":"LINK", "resourceHref":"http://localhost:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "resourceName":"ODP-REGSK-195 PD", "referenceId":"5003", "resourceCategory":"ODP", "alarmType":"Device Failure", "specificProblem":"Power Failure", "ownerName":"llatham", "perceivedSeverity":"CRITICAL", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"voltage=None", "href":"/alarmManagement/v4/alarm/5003", "nodeLinkEntityId":"93492", "analysisStatus":"PENDING", "eventDate":"2024-06-11T04:32:17.235Z" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Event updated successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an existing Event", "x-internal-id":"sia-v1-event-put", "x-filename-id":"sia-v1-event-put" } }, "/sia/v1/event/bulkDelete":{ "delete":{ "tags":[ "Event and Impact Analysis/Event" ], "description":"Delete events in bulk and their associated impacts using the given operation records.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":[ { "id":"1" }, { "id":"2" }, { "id":"3" } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/BulkDeleteRecord" }, "type":"array" } } }, "description":"Bulk delete operation records." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ }, "schema":{ "$ref":"#/components/schemas/BulkOperationResult" } } }, "description":"Events deleted successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete events in bulk and their associated impacts", "x-internal-id":"sia-v1-event-bulkDelete-delete", "x-filename-id":"sia-v1-event-bulkdelete-delete" } }, "/sia/v1/event/bulkUpdate":{ "patch":{ "tags":[ "Event and Impact Analysis/Event" ], "description":"Update owner name, event status and event analysis status on the events in bulk using the given operation records.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":[ { "ownerName":"RUSHIPAT", "eventStatus":"CLEARED", "id":"UELINK5003" } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/EventBulkUpdateRecord" }, "type":"array" } } }, "description":"Even bulk update operation documents." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ }, "schema":{ "$ref":"#/components/schemas/BulkOperationResult" } } }, "description":"Events updated successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Bulk update events", "x-internal-id":"sia-v1-event-bulkUpdate-patch", "x-filename-id":"sia-v1-event-bulkupdate-patch" } }, "/sia/v1/event/customerCount/{eventDocId}":{ "get":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The document id of the event.", "example":"UE1741839039068882843", "in":"path", "name":"eventDocId", "required":true, "schema":{ "type":"string" } } ], "description":"Get number of impacted customers by this event.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":100 } }, "schema":{ "type":"number" } } }, "description":"Count of impacted customers retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get number of impacted customers by this event", "x-internal-id":"sia-v1-event-customerCount-{eventDocId}-get", "x-filename-id":"sia-v1-event-customercount-eventdocid-get" } }, "/sia/v1/event/device/eid/{entityId}/events":{ "get":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The topology entity id of the device.", "in":"path", "name":"entityId", "required":true, "schema":{ "type":"string" } } ], "description":"Get all active (except cleared and rejected) events based on device topology entity id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "tenant_id":"tenant1", "sourceSystemID":"LINK", "resourceHref":"http://localhost:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "resourceName":"ODP-REGSK-195 PD", "referenceId":"5003", "resourceCategory":"ODP", "alarmType":"Device Failure", "specificProblem":"Power Failure", "ownerName":"llatham", "perceivedSeverity":"CRITICAL", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"voltage=None", "href":"/alarmManagement/v4/alarm/5003", "lang":"en", "nodeLinkEntityId":"93492", "analysisStatus":"COLLECTED", "eventDate":"2024-06-11T04:32:17.235Z" } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/SmartSearchEvent" }, "type":"array" } } }, "description":"Active events retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get active events with device topology entity id", "x-internal-id":"sia-v1-event-device-eid-{entityId}-events-get", "x-filename-id":"sia-v1-event-device-eid-entityid-events-get" } }, "/sia/v1/event/docid/{docid}":{ "get":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The document id of the event.", "in":"path", "name":"docid", "required":true, "schema":{ "type":"string" } } ], "description":"Get the event based on event document id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "resourceId":"1050028-1350041", "instanceName":"HYDPX04KP.P01P::HYDPX04KP.P01-129.3A.08-Line-1.10GigE_1", "lastModifiedDate":"2025-03-03T10:29:40.920Z", "edgeLinkEntityId":[ "2670443" ], "resourceHref":"http://localhost:7801/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/10-1050028-1350041", "resourceName":"HYDPX04KP.P01-129.3A.08-Line-1.10GigE_1", "referenceId":"70000463290", "alarmType":"processingErrorAlarm", "createdDate":"2025-03-03T10:29:40.920Z", "ownerName":"Unassigned", "perceivedSeverity":"MAJOR", "probableCause":"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge) Port 700001", "eventStatus":"RAISED", "alarmDetails":"{\"corba.rcaiIndicator\":\"false\",\"corba.probableCauseQualifier\":\"51118@@0@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@357\",\"corba.serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",\"corba.additionalText\":\"No Info\",\"corba.neTime\":\"20230828123441.0\",\"corba.emsTime\":\"20230828123505.8\",\"corba.corbaEventType\":\"ECI\",\"corba.objectType\":\"OT_EQUIPMENT\",\"corba.perceivedSeverity\":\"PS_CRITICAL\",\"corba.probableCause\":\"ENV\",\"corba.nativeEMSName\":\"External Alarm Unit\",\"corba.layerRate\":\"0\",\"corba.nativeProbableCause\":\"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)\",\"corba.additionalInfo.LSNExt_GroupName\":\"CHANDIGARH\",\"corba.additionalInfo.LSNExt_MEName\":\"PB20_CHD_SEC08_01\",\"corba.additionalInfo.LSNExt_ALCV\":\"Unknown\",\"corba.additionalInfo.LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",\"corba.additionalInfo.LSNExt_AlarmUniqueString\":\"EMS DN=LSN/EMS_BG-40_81, EMS notifId=2949292, CAM ID=3939953\",\"corba.objectName.EquipmentHolder\":\"/shelf=1/slot=1\",\"corba.objectName.Equipment\":\"1\",\"corba.objectName.ManagedElement\":\"LSN/EMS_BG-40_81/51118\",\"corba.objectName.EMS\":\"ECI/LightSoft_1\",\"corba.notificationId\":\"3743573\",\"corba.isClearable\":\"true\",\"corba.affectedTPList\":\"\"}", "id":"UE174099778093370000463290", "lang":"en", "resourceActiveEvent":5, "nodeLinkEntityId":"2670112", "analysisStatus":"PENDING", "eventDate":"2024-06-19T05:41:02.000Z", "resourceType":"PhysicalPort" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Event retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get the event with document id", "x-internal-id":"sia-v1-event-docid-{docid}-get", "x-filename-id":"sia-v1-event-docid-docid-get" }, "patch":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The document id of the event.", "in":"path", "name":"docid", "required":true, "schema":{ "type":"string" } } ], "description":"Update existing event description, owner name.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "ownerName":"ownerName", "description":"Some description here.." } } }, "schema":{ "additionalProperties":{ }, "type":"object" } } }, "description":"Map containing the values to be updated, this can contain description and owner name only." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "reportId":"REPT1727262659978", "lastModifiedDate":"2024-09-27T05:40:15.758Z", "sourceSystemID":"LINK", "resourceHref":"http://100.77.31.236:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "description":"Some description here..", "resourceName":"ODP-REGSK-195 PD", "referenceId":"5003", "resourceCategory":"ODP", "alarmType":"Device Failure", "createdDate":"2024-09-25T11:10:03.383Z", "specificProblem":"Power Failure", "ownerName":"ownerName", "perceivedSeverity":"critical", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"{\"snmp.Enterprise\":\"1.3.6.1.4.1.637.65.1.1.2\",\"snmp.Specific\":\"1\",\"snmp.Generic\":\"6\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.1\":\"27466410\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.7\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.4\":\"equipmentAlarm\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.12\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.15\":\"1\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.11\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.5\":\"Battery Failure\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.10\":\"notReserved\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.6\":\"minor\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.9\":\"notAck\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.2\":\"JNK_JK60_PHINTER_001/r01sr1/board#12\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.8\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.13\":\"{0.3.0.2.7.7#852/0.3.0.2.7.13#7/0.0.13.3100.0.7.20#1/0.0.13.3100.0.7.20#1/0.0.13.3100.0.7.20#12}\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.3\":\"20240708075440\"}", "id":"UELINK5003", "lang":"en", "nodeLinkEntityId":"93492", "analysisStatus":"ASSIGNED", "eventDate":"2024-06-11T04:32:17.235Z", "reportCreationDate":"2024-09-25T11:10:59.978Z" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Event is updated successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update existing event description, owner name", "x-internal-id":"sia-v1-event-docid-{docid}-patch", "x-filename-id":"sia-v1-event-docid-docid-patch" } }, "/sia/v1/event/event/config/{type}":{ "get":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The ALARMTYPE, EVENTSTATUS or SEVERITY type to return.", "in":"path", "name":"type", "required":true, "schema":{ "type":"string" } } ], "description":"Get Event Type values based on Type.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ "COMMUNICATIONS_ALARM", "PROCESSING_ERROR_ALARM", "ENVIRONMENTAL_ALARM", "QUALITY_OF_SERVICE_ALARM", "EQUIPMENT_ALARM", "INTEGRITY_VIOLATION", "OPERATIONAL_VIOLATION", "PHYSICAL_VIOLATION", "SECURITY_SERVICE", "MECHANISM_VIOLATION", "TIME_DOMAIN_VIOLATION" ] } }, "schema":{ "type":"string" } } }, "description":"Event Types retrieved successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get Event Type values", "x-internal-id":"sia-v1-event-event-config-{type}-get", "x-filename-id":"sia-v1-event-event-config-type-get" } }, "/sia/v1/event/referenceId/{referenceId}":{ "get":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The reference id of the event.", "in":"path", "name":"referenceId", "required":true, "schema":{ "type":"string" } } ], "description":"Get the event based on the external system reference id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "resourceId":"1050028-1350041", "instanceName":"HYDPX04KP.P01P::HYDPX04KP.P01-129.3A.08-Line-1.10GigE_1", "lastModifiedDate":"2025-03-03T10:29:40.920Z", "edgeLinkEntityId":[ "2670443" ], "resourceHref":"http://localhost:7801/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/10-1050028-1350041", "resourceName":"HYDPX04KP.P01-129.3A.08-Line-1.10GigE_1", "referenceId":"70000463290", "alarmType":"processingErrorAlarm", "createdDate":"2025-03-03T10:29:40.920Z", "ownerName":"Unassigned", "perceivedSeverity":"MAJOR", "probableCause":"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge) Port 700001", "eventStatus":"RAISED", "alarmDetails":"{\"corba.rcaiIndicator\":\"false\",\"corba.probableCauseQualifier\":\"51118@@0@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@357\",\"corba.serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",\"corba.additionalText\":\"No Info\",\"corba.neTime\":\"20230828123441.0\",\"corba.emsTime\":\"20230828123505.8\",\"corba.corbaEventType\":\"ECI\",\"corba.objectType\":\"OT_EQUIPMENT\",\"corba.perceivedSeverity\":\"PS_CRITICAL\",\"corba.probableCause\":\"ENV\",\"corba.nativeEMSName\":\"External Alarm Unit\",\"corba.layerRate\":\"0\",\"corba.nativeProbableCause\":\"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)\",\"corba.additionalInfo.LSNExt_GroupName\":\"CHANDIGARH\",\"corba.additionalInfo.LSNExt_MEName\":\"PB20_CHD_SEC08_01\",\"corba.additionalInfo.LSNExt_ALCV\":\"Unknown\",\"corba.additionalInfo.LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",\"corba.additionalInfo.LSNExt_AlarmUniqueString\":\"EMS DN=LSN/EMS_BG-40_81, EMS notifId=2949292, CAM ID=3939953\",\"corba.objectName.EquipmentHolder\":\"/shelf=1/slot=1\",\"corba.objectName.Equipment\":\"1\",\"corba.objectName.ManagedElement\":\"LSN/EMS_BG-40_81/51118\",\"corba.objectName.EMS\":\"ECI/LightSoft_1\",\"corba.notificationId\":\"3743573\",\"corba.isClearable\":\"true\",\"corba.affectedTPList\":\"\"}", "id":"UE174099778093370000463290", "lang":"en", "resourceActiveEvent":5, "nodeLinkEntityId":"2670112", "analysisStatus":"PENDING", "eventDate":"2024-06-19T05:41:02.000Z", "resourceType":"PhysicalPort" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Event retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get the event with reference id", "x-internal-id":"sia-v1-event-referenceId-{referenceId}-get", "x-filename-id":"sia-v1-event-referenceid-referenceid-get" }, "patch":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The reference id of the event.", "in":"path", "name":"referenceId", "required":true, "schema":{ "type":"string" } } ], "description":"Update existing event's event status, severity and analysis status based on given reference id.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "perceivedSeverity":"CRITICAL", "eventStatus":"RAISED", "analysisStatus":"COLLECTED" } } }, "schema":{ "additionalProperties":{ }, "type":"object" } } }, "description":"Map containing the values to be updated, only event status, severity and analysis status can be updated." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "sourceSystemID":"LINK", "resourceHref":"http://localhost:7700/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "resourceName":"ODP-REGSK-195 PD", "referenceId":"UELINK5003", "resourceCategory":"ODP", "alarmType":"Device Failure", "specificProblem":"Power Failure", "ownerName":"llatham", "perceivedSeverity":"CRITICAL", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"voltage=None", "href":"/alarmManagement/v4/alarm/5003", "lang":"en", "nodeLinkEntityId":"93492", "analysisStatus":"COLLECTED", "eventDate":"2024-06-11T04:32:17.235Z" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Event is updated successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update an event with reference id", "x-internal-id":"sia-v1-event-referenceId-{referenceId}-patch", "x-filename-id":"sia-v1-event-referenceid-referenceid-patch" }, "delete":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The reference id of the event to be deleted.", "in":"path", "name":"referenceId", "required":true, "schema":{ "type":"string" } } ], "description":"Delete an Event and associated impacts using event reference id.", "responses":{ "200":{ "content":{ "text/plain":{ "examples":{ } } }, "description":"Event deleted successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Delete an Event and associated impacts", "x-internal-id":"sia-v1-event-referenceId-{referenceId}-delete", "x-filename-id":"sia-v1-event-referenceid-referenceid-delete" } }, "/sia/v1/event/resourceActiveEvents":{ "post":{ "tags":[ "Event and Impact Analysis/Event" ], "description":"Get highest severity active events based on resource ids.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":[ "8-75349-77997", "1-75429", "1-1" ] } }, "schema":{ "items":{ "type":"string" }, "type":"array" } } }, "description":"Inventory resource ids in the format - for which highest severity active events are needed." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "resourceId":"75349-77997", "perceivedSeverity":"WARNING", "id":"UE173668144221125411" }, { "resourceId":"75429-79195", "perceivedSeverity":"INDETERMINATE", "id":"UE173668144232125412" }, { "resourceId":"1-1", "perceivedSeverity":"NONE" } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/ResourceHighestSeverityEvent" }, "type":"array" } } }, "description":"Highest severity active events retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get highest severity active events for resources", "x-internal-id":"sia-v1-event-resourceActiveEvents-post", "x-filename-id":"sia-v1-event-resourceactiveevents-post" } }, "/sia/v1/event/resourceActiveEvents/{resourceId}":{ "get":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The inventory resource id of the resource in the format -.", "in":"path", "name":"resourceId", "required":true, "schema":{ "type":"string" } } ], "description":"Get all active events (all events except cleared and rejected) based on resource id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "tenant_id":"tenant1", "sourceSystemID":"LINK", "resourceHref":"http://localhost:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "resourceName":"ODP-REGSK-195 PD", "referenceId":"5003", "resourceCategory":"ODP", "alarmType":"Device Failure", "specificProblem":"Power Failure", "ownerName":"llatham", "perceivedSeverity":"CRITICAL", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"voltage=None", "href":"/alarmManagement/v4/alarm/5003", "lang":"en", "nodeLinkEntityId":"93492", "analysisStatus":"COLLECTED", "eventDate":"2024-06-11T04:32:17.235Z" } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/SmartSearchEvent" }, "type":"array" } } }, "description":"Active events retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get active events for the resource", "x-internal-id":"sia-v1-event-resourceActiveEvents-{resourceId}-get", "x-filename-id":"sia-v1-event-resourceactiveevents-resourceid-get" } }, "/sia/v1/event/resourceEventsImpacts":{ "get":{ "tags":[ "Event and Impact Analysis/Event" ], "parameters":[ { "description":"The inventory resource id of the resource in the format .", "in":"query", "name":"resourceId", "required":true, "schema":{ "type":"string" } }, { "description":"The type of entity, e.g., EQUIPMENT.", "in":"query", "name":"entityType", "required":true, "schema":{ "type":"string" } } ], "description":"Get all active events and impacts based on resource id.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ "UE1232432536" ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/SmartSearchEvent" }, "type":"array" } } }, "description":"Active events retrieved successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get all events and impacts for the resource", "x-internal-id":"sia-v1-event-resourceEventsImpacts-get", "x-filename-id":"sia-v1-event-resourceeventsimpacts-get" } }, "/sia/v1/event/selectAllDelete":{ "delete":{ "tags":[ "Event and Impact Analysis/Event" ], "description":"Delete events in bulk. The delete operation is performed on all events that match the smart search filters. Events with document IDs specified in excludeList are skipped from the delete operation.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "filters":[ { "filter":"keyword", "value":"UELINK5003" } ] } } }, "schema":{ "$ref":"#/components/schemas/SelectAllDeleteRequest" } } }, "description":"Select all delete events request." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ }, "schema":{ "$ref":"#/components/schemas/BulkOperationResult" } } }, "description":"Events deleted successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Bulk delete events using smart search filter query", "x-internal-id":"sia-v1-event-selectAllDelete-delete", "x-filename-id":"sia-v1-event-selectalldelete-delete" } }, "/sia/v1/event/selectAllUpdate":{ "patch":{ "tags":[ "Event and Impact Analysis/Event" ], "description":"Update owner name, event status and event analysis status on the events in bulk. The given update operation is performed on all events that match the smart search filters. Events with document IDs specified in excludeList are skipped from the update operation.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "filters":[ { "filter":"keyword", "value":"UELINK5003" } ], "operation":{ "eventStatus":"CLEARED" } } } }, "schema":{ "$ref":"#/components/schemas/EventSelectAllUpdateRequest" } } }, "description":"Event select all update request." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ }, "schema":{ "$ref":"#/components/schemas/BulkOperationResult" } } }, "description":"Events updated successfully" }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Bulk update events using smart search filter query", "x-internal-id":"sia-v1-event-selectAllUpdate-patch", "x-filename-id":"sia-v1-event-selectallupdate-patch" } }, "/sia/v1/impact/bulkUpdate":{ "patch":{ "tags":[ "Event and Impact Analysis/Impact" ], "description":"Update owner name, impact severity and analysis status on the impacts in bulk using the given operation records.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":[ { "impactSeverity":"HIGH", "ownerName":"RUSHIPAT", "id":"UELINK5003:30-77078", "analysisStatus":"QUALIFIED" } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/ImpactBulkUpdateRecord" }, "type":"array" } } }, "description":"Bulk update operation records." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ }, "schema":{ "$ref":"#/components/schemas/BulkOperationResult" } } }, "description":"Impacts updated successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Bulk update impacts", "x-internal-id":"sia-v1-impact-bulkUpdate-patch", "x-filename-id":"sia-v1-impact-bulkupdate-patch" } }, "/sia/v1/impact/deviceinterface/{id}":{ "get":{ "tags":[ "Event and Impact Analysis/Impact" ], "parameters":[ { "description":"The device interface inventory id.", "example":"L1059-1", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The event document id.", "example":"UE1741839039068882843", "in":"query", "name":"event", "required":true, "schema":{ "type":"string" } } ], "description":"This operation fetches impacts based on device interface inventory id and related event document id from the inventory system. When the analysis is initiated, analysisStatus on the corresponding event changes to INITIATED. Once the analysis completes, analysisStatus for the event transitions to COLLECTED. However, if the analysis fails,analysisStatus for the event changes to FAILED and errorDetails field is populated with the error details occurred during analysis.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "resourceId":"L1059-1", "instanceName":"HYDR02TCA.H01P::HYDR02TCA.H01.OTS_1", "lastModifiedDate":"2025-03-13T04:12:55.418Z", "edgeLinkEntityId":[ "4560" ], "resourceHref":"http://localhost:7801/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/20-L1059-1", "resourceName":"HYDR02TCA.H01.OTS_1", "referenceId":"882843", "resourceCategory":"OpticalSwitch", "alarmType":"processingErrorAlarm", "createdDate":"2025-03-13T04:10:39.051Z", "ownerName":"Anonymous", "perceivedSeverity":"MAJOR", "probableCause":"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge) DeviceInterface", "eventStatus":"RAISED", "alarmDetails":"{\"corba.rcaiIndicator\":\"false\",\"corba.probableCauseQualifier\":\"51118@@0@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@357\",\"corba.serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",\"corba.additionalText\":\"No Info\",\"corba.neTime\":\"20230828123441.0\",\"corba.emsTime\":\"20230828123505.8\",\"corba.corbaEventType\":\"ECI\",\"corba.objectType\":\"OT_EQUIPMENT\",\"corba.perceivedSeverity\":\"PS_CRITICAL\",\"corba.probableCause\":\"ENV\",\"corba.nativeEMSName\":\"External Alarm Unit\",\"corba.layerRate\":\"0\",\"corba.nativeProbableCause\":\"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)\",\"corba.additionalInfo.LSNExt_GroupName\":\"CHANDIGARH\",\"corba.additionalInfo.LSNExt_MEName\":\"PB20_CHD_SEC08_01\",\"corba.additionalInfo.LSNExt_ALCV\":\"Unknown\",\"corba.additionalInfo.LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",\"corba.additionalInfo.LSNExt_AlarmUniqueString\":\"EMS DN=LSN/EMS_BG-40_81, EMS notifId=2949292, CAM ID=3939953\",\"corba.objectName.EquipmentHolder\":\"/shelf=1/slot=1\",\"corba.objectName.Equipment\":\"1\",\"corba.objectName.ManagedElement\":\"LSN/EMS_BG-40_81/51118\",\"corba.objectName.EMS\":\"ECI/LightSoft_1\",\"corba.notificationId\":\"3743573\",\"corba.isClearable\":\"true\",\"corba.affectedTPList\":\"\"}", "id":"UE1741839039068882843", "lang":"en", "resourceActiveEvent":5, "nodeLinkEntityId":"4361", "analysisStatus":"INITIATED", "eventDate":"2024-06-19T05:41:02.000Z", "resourceType":"DeviceInterface" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Updated Event on which impact analysis was initiated." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Initiate impact analysis for device interface", "x-internal-id":"sia-v1-impact-deviceinterface-{id}-get", "x-filename-id":"sia-v1-impact-deviceinterface-id-get" } }, "/sia/v1/impact/docid/{docid}":{ "patch":{ "tags":[ "Event and Impact Analysis/Impact" ], "parameters":[ { "description":"The document id of the impact entity to be updated.", "in":"path", "name":"docid", "required":true, "schema":{ "type":"string" } } ], "description":"Update existing impact entity owner name, severity, analysis status and comments.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "impactSeverity":"LOW", "ownerName":"OWNER", "analysisStatus":"PENDING" } } }, "schema":{ "additionalProperties":{ }, "type":"object" } } }, "description":"Map containing the values to be updated, only owner name, impact severity, analysis status and comments can be updated." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "impactSeverity":"LOW", "entityType":"Pipe", "lastUpdatedDate":"2024-09-24T11:28:06.680Z", "ownerName":"OWNER", "specName":"Access_Cable", "name":"AC - ODP-REGSK-195 PD - FAT-REGSK-4947 PD", "href":"http://localhost:7700/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/30-77078", "id":"UELINK5003:30-77078", "event":"UELINK5003", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEventImpact" } } }, "description":"Impact entity is updated successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Update impact", "x-internal-id":"sia-v1-impact-docid-{docid}-patch", "x-filename-id":"sia-v1-impact-docid-docid-patch" } }, "/sia/v1/impact/equipment/{id}":{ "get":{ "tags":[ "Event and Impact Analysis/Impact" ], "parameters":[ { "description":"The equipment inventory id.", "example":"UE174183856907914000", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The event document id.", "example":4, "in":"query", "name":"event", "required":true, "schema":{ "type":"string" } } ], "description":"This operation fetches impacts based on equipment inventory id and related event document id from the inventory system. When the analysis is initiated, analysisStatus on the corresponding event changes to INITIATED. Once the analysis completes, analysisStatus for the event transitions to COLLECTED. However, if the analysis fails,analysisStatus for the event changes to FAILED and errorDetails field is populated with the error details occurred during analysis.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "resourceId":"4", "instanceName":"GRND01TXAW.P01P::GRND01TXAW.P01-107.6K.07", "lastModifiedDate":"2025-03-13T04:03:36.395Z", "edgeLinkEntityId":[ "1237", "1239" ], "resourceHref":"http://localhost:7801/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/8-4", "resourceName":"GRND01TXAW.P01-107.6K.07", "referenceId":"14000", "alarmType":"processingErrorAlarm", "createdDate":"2025-03-13T04:02:49.045Z", "ownerName":"Anonymous", "perceivedSeverity":"MAJOR", "probableCause":"Equipment Failure", "resourceSubType":"SHELF", "eventStatus":"RAISED", "id":"UE174183856907914000", "lang":"en", "resourceActiveEvent":5, "nodeLinkEntityId":"1087", "analysisStatus":"INITIATED", "eventDate":"2024-12-27T11:33:36.393Z", "resourceType":"Equipment" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Updated Event on which impact analysis was initiated." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Initiate impact analysis for equipment", "x-internal-id":"sia-v1-impact-equipment-{id}-get", "x-filename-id":"sia-v1-impact-equipment-id-get" } }, "/sia/v1/impact/event/{eventId}":{ "get":{ "tags":[ "Event and Impact Analysis/Impact" ], "parameters":[ { "description":"The event document id.", "example":"UELINK5003", "in":"path", "name":"eventId", "required":true, "schema":{ "type":"string" } }, { "description":"The limit for the pagination.", "example":10, "in":"query", "name":"limit", "required":true, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The offset for the pagination.", "example":0, "in":"query", "name":"offset", "required":true, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Fetch impacts based on related event document id. The response would be in the SmartSearch response format instead of plain array.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "_shards":{ "total":1, "failed":0, "skipped":0, "successful":1 }, "took":7, "totalResults":17, "offset":0, "count":10, "hasMore":true, "limit":0, "timed_out":false, "sort":[ { "label":"Last Updated", "value":"_source.lastUpdatedDate" } ], "items":[ { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"EQUIPMENT", "specification":"Ciena Card", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"ARLN01TXAW.P01-194.2H.06-Line-1", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/8-13", "id":"UE1752056102112716697:8-13", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:8-13", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"PIPE", "specification":"DWDM_Fiber_Channel", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"742-1574.12685 nm / 190.45 THz", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/30-742-04.5", "id":"UE1752056102112716697:30-742-04.5", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:30-742-04.5", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"CONNECTIVITY", "specification":"INNI Connectivity", "technology":"Ethernet", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"ARLN01TXAW.P01 / ARLN03TXAW.P01 / 10GigE / GE10 / 1", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/31-1", "id":"UE1752056102112716697:31-1", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING", "ratecode":"10GigE" }, "_id":"UE1752056102112716697:31-1", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"NETWORK", "specification":"AggregateNetwork", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"West Dallas Aggregation", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/npb/network/5-7", "id":"UE1752056102112716697:5-7", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:5-7", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"LOCATION", "specification":"Property Location", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"ARLN01TXAW.P01", "location":"32.76652,-97.11376", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/npb/networkEntityCode/16-ARLN01TXAW.P01", "id":"UE1752056102112716697:16-1-ARLN01TXAW.P01", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:16-1-ARLN01TXAW.P01", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"NETWORK", "specification":"CircleNetwork", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"DWDM Subnetwork Circle", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/npb/network/5-25", "id":"UE1752056102112716697:5-25", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:5-25", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"NETWORK", "specification":"AccessNetwork", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"Arlington PTN Access", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/npb/network/5-1", "id":"UE1752056102112716697:5-1", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:5-1", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"LOGICAL DEVICE", "specification":"Ciena 3928", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"ARLN01TXAW.P01", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/1-2", "id":"UE1752056102112716697:1-2", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:1-2", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"NETWORK", "specification":"CircleNetwork", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"DFW Metro", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/npb/network/5-6", "id":"UE1752056102112716697:5-6", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:5-6", "_score":0 }, { "_index":"smartsearch-impact-1", "_source":{ "tenant_id":"tenant1", "impactSeverity":"MEDIUM", "entityType":"EQUIPMENT", "specification":"Ciena 3928 Chassis", "lastUpdatedDate":"2025-07-24T04:45:55.685Z", "ownerName":"Unassigned", "name":"ARLN01TXAW.P01-194.2H.06", "href":"http://localhost:7802/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/8-1", "id":"UE1752056102112716697:8-1", "event":"UE1752056102112716697", "lang":"en", "impactType":"DIRECT", "analysisStatus":"PENDING" }, "_id":"UE1752056102112716697:8-1", "_score":0 } ] } } }, "schema":{ "items":{ "$ref":"#/components/schemas/SmartSearchResultsImpact" }, "type":"array" } } }, "description":"List of impacts for the given event document id." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get impacts for an event", "x-internal-id":"sia-v1-impact-event-{eventId}-get", "x-filename-id":"sia-v1-impact-event-eventid-get" } }, "/sia/v1/impact/logicaldevice/{id}":{ "get":{ "tags":[ "Event and Impact Analysis/Impact" ], "parameters":[ { "description":"The logical device inventory id.", "example":"UE1741839039068882846", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The event document id.", "example":300001, "in":"query", "name":"event", "required":true, "schema":{ "type":"string" } } ], "description":"This operation fetches impacts based on logical device inventory id and related event document id from the inventory system. When the analysis is initiated, analysisStatus on the corresponding event changes to INITIATED. Once the analysis completes, analysisStatus for the event transitions to COLLECTED. However, if the analysis fails,analysisStatus for the event changes to FAILED and errorDetails field is populated with the error details occurred during analysis.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "sourceSystemID":"LINK", "resourceHref":"http://localhost:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/1-300001", "resourceName":"AHMD01GJ.P01", "referenceId":"5004", "resourceCategory":"MSOTN", "alarmType":"Device Failure", "specificProblem":"Hardware Failure", "ownerName":"llatham", "perceivedSeverity":"CRITICAL", "probableCause":"Main Board Failure", "eventStatus":"RAISED", "alarmDetails":"failure", "href":"/alarmManagement/v4/alarm/5004", "lang":"en", "nodeLinkEntityId":"2538336", "analysisStatus":"INITIATED", "eventDate":"2024-06-11T04:32:17.235Z" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Updated Event on which impact analysis was initiated." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Initiate impact analysis for logical device", "x-internal-id":"sia-v1-impact-logicaldevice-{id}-get", "x-filename-id":"sia-v1-impact-logicaldevice-id-get" } }, "/sia/v1/impact/physicaldevice/{id}":{ "get":{ "tags":[ "Event and Impact Analysis/Impact" ], "parameters":[ { "description":"The physical device inventory id.", "example":"UE17418383629175053", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The event document id.", "example":83492, "in":"query", "name":"event", "required":true, "schema":{ "type":"string" } } ], "description":"This operation fetches impacts based on physical device inventory id and related event document id from the inventory system. When the analysis is initiated, analysisStatus on the corresponding event changes to INITIATED. Once the analysis completes, analysisStatus for the event transitions to COLLECTED. However, if the analysis fails,analysisStatus for the event changes to FAILED and errorDetails field is populated with the error details occurred during analysis.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "resourceId":"83492", "instanceName":"83492", "lastModifiedDate":"2025-03-13T03:59:58.438Z", "edgeLinkEntityId":[ "95572", "95628" ], "resourceHref":"http://localhost:7801/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83492", "resourceName":"OLT-REGSK-5 PD", "referenceId":"5053", "resourceCategory":"OLT", "alarmType":"processingErrorAlarm", "createdDate":"2025-03-13T03:59:22.770Z", "ownerName":"Anonymous", "perceivedSeverity":"MAJOR", "probableCause":"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge) DeviceInterface", "eventStatus":"RAISED", "alarmDetails":"{\"corba.rcaiIndicator\":\"false\",\"corba.probableCauseQualifier\":\"51118@@0@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@-1@@357\",\"corba.serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",\"corba.additionalText\":\"No Info\",\"corba.neTime\":\"20230828123441.0\",\"corba.emsTime\":\"20230828123505.8\",\"corba.corbaEventType\":\"ECI\",\"corba.objectType\":\"OT_EQUIPMENT\",\"corba.perceivedSeverity\":\"PS_CRITICAL\",\"corba.probableCause\":\"ENV\",\"corba.nativeEMSName\":\"External Alarm Unit\",\"corba.layerRate\":\"0\",\"corba.nativeProbableCause\":\"ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)\",\"corba.additionalInfo.LSNExt_GroupName\":\"CHANDIGARH\",\"corba.additionalInfo.LSNExt_MEName\":\"PB20_CHD_SEC08_01\",\"corba.additionalInfo.LSNExt_ALCV\":\"Unknown\",\"corba.additionalInfo.LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",\"corba.additionalInfo.LSNExt_AlarmUniqueString\":\"EMS DN=LSN/EMS_BG-40_81, EMS notifId=2949292, CAM ID=3939953\",\"corba.objectName.EquipmentHolder\":\"/shelf=1/slot=1\",\"corba.objectName.Equipment\":\"1\",\"corba.objectName.ManagedElement\":\"LSN/EMS_BG-40_81/51118\",\"corba.objectName.EMS\":\"ECI/LightSoft_1\",\"corba.notificationId\":\"3743573\",\"corba.isClearable\":\"true\",\"corba.affectedTPList\":\"\"}", "id":"UE17418383629175053", "lang":"en", "resourceActiveEvent":5, "nodeLinkEntityId":"94483", "analysisStatus":"INITIATED", "eventDate":"2024-06-19T05:41:02.000Z", "resourceType":"PhysicalDevice" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Updated Event on which impact analysis was initiated." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Initiate impact analysis for physical device", "x-internal-id":"sia-v1-impact-physicaldevice-{id}-get", "x-filename-id":"sia-v1-impact-physicaldevice-id-get" } }, "/sia/v1/impact/physicalport/{id}":{ "get":{ "tags":[ "Event and Impact Analysis/Impact" ], "parameters":[ { "description":"The physical port inventory id.", "example":"UE173668252790535192", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The event document id.", "example":"75853-83579", "in":"query", "name":"event", "required":true, "schema":{ "type":"string" } } ], "description":"This operation fetches impacts based on physical port id and related event id from the inventory system. When the analysis is initiated, analysisStatus on the corresponding event changes to INITIATED. Once the analysis completes, analysisStatus for the event transitions to COLLECTED. However, if the analysis fails,analysisStatus for the event changes to FAILED and errorDetails field is populated with the error details occurred during analysis.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":{ "tenant_id":"tenant1", "resourceId":"75853-83579", "instanceName":"75781::75853-83579", "lastModifiedDate":"2025-03-13T03:52:05.091Z", "sourceSystemID":"UA3", "edgeLinkEntityId":[ "2665360" ], "resourceHref":"http://localhost:7700/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/10-75853-83579", "referenceId":"35192", "alarmType":"mechanismViolation", "createdDate":"2025-01-12T11:48:47.898Z", "ownerName":"Anonymous", "perceivedSeverity":"CRITICAL", "probableCause":"Unspecified Reason", "eventStatus":"RAISED", "id":"UE173668252790535192", "lang":"en", "resourceActiveEvent":1, "nodeLinkEntityId":"55591", "analysisStatus":"INITIATED", "eventDate":"2025-01-12T11:28:57.553Z", "resourceType":"PhysicalPort" } } }, "schema":{ "$ref":"#/components/schemas/SmartSearchEvent" } } }, "description":"Updated Event on which impact analysis was initiated." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Initiate impact analysis for physical port", "x-internal-id":"sia-v1-impact-physicalport-{id}-get", "x-filename-id":"sia-v1-impact-physicalport-id-get" } }, "/sia/v1/impact/selectAllUpdate":{ "patch":{ "tags":[ "Event and Impact Analysis/Impact" ], "description":"Update owner name, impact severity and analysis status on the impacts in bulk. The given update operation is performed on all impacts that match the smart search filters. Impacts with document IDs specified in excludeList are skipped from the update operation.", "requestBody":{ "content":{ "application/json":{ "examples":{ "Request":{ "value":{ "excludeList":[ "UELINK5003:2-175295" ], "filters":[ { "filter":"eventLOV", "value":"UELINK5003" } ], "operation":{ "analysisStatus":"PENDING" } } } }, "schema":{ "$ref":"#/components/schemas/ImpactSelectAllUpdateRequest" } } }, "description":"Impact select all update request." }, "responses":{ "200":{ "content":{ "application/json":{ "examples":{ }, "schema":{ "$ref":"#/components/schemas/BulkOperationResult" } } }, "description":"Impacts updated successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Bulk update impacts using smart search filter query", "x-internal-id":"sia-v1-impact-selectAllUpdate-patch", "x-filename-id":"sia-v1-impact-selectallupdate-patch" } }, "/sia/v1/report":{ "get":{ "tags":[ "Event and Impact Analysis/Report" ], "parameters":[ { "description":"The limit for the pagination.", "in":"query", "name":"limit", "required":true, "schema":{ "format":"int32", "type":"integer" } }, { "description":"The offset for the pagination.", "in":"query", "name":"offset", "required":true, "schema":{ "format":"int32", "type":"integer" } } ], "description":"Get impact reports. Impact reports are the events with analysis status as COMPLETED.", "responses":{ "200":{ "content":{ "application/json":{ "examples":{ "Response":{ "value":[ { "tenant_id":"tenant1", "reportId":"REPT1727167456360", "lastModifiedDate":"2024-09-24T07:27:48.559Z", "sourceSystemID":"LINK", "resourceHref":"http://localhost:7001/Inventory/RSOpenAPI/resourceInventoryManagement/v4/resource/4-83482", "resourceName":"ODP-REGSK-195 PD", "referenceId":"5003", "resourceCategory":"ODP", "alarmType":"Device Failure", "createdDate":"2024-09-24T07:27:48.559Z", "specificProblem":"Power Failure", "ownerName":"llatham", "perceivedSeverity":"critical", "probableCause":"Damaged", "eventStatus":"RAISED", "alarmDetails":"{\"snmp.Enterprise\":\"1.3.6.1.4.1.637.65.1.1.2\",\"snmp.Specific\":\"1\",\"snmp.Generic\":\"6\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.1\":\"27466410\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.7\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.4\":\"equipmentAlarm\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.12\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.15\":\"1\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.11\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.5\":\"Battery Failure\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.10\":\"notReserved\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.6\":\"minor\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.9\":\"notAck\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.2\":\"JNK_JK60_PHINTER_001/r01sr1/board#12\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.8\":\"\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.13\":\"{0.3.0.2.7.7#852/0.3.0.2.7.13#7/0.0.13.3100.0.7.20#1/0.0.13.3100.0.7.20#1/0.0.13.3100.0.7.20#12}\",\"snmp.1.3.6.1.4.1.637.65.1.1.1.2.1.3\":\"20240708075440\"}", "lang":"en", "nodeLinkEntityId":"93492", "analysisStatus":"COMPLETED", "eventDate":"2024-06-11T04:32:17.235Z", "reportCreationDate":"2024-09-24T08:44:16.360Z" } ] } }, "schema":{ "items":{ "$ref":"#/components/schemas/SmartSearchEvent" }, "type":"array" } } }, "description":"List of reports." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request isn't valid" }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is unauthorized" }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The request is forbidden" }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"The requested resource not found" }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorType" } } }, "description":"An Internal Server Error has occurred" } }, "summary":"Get impact reports", "x-internal-id":"sia-v1-report-get", "x-filename-id":"sia-v1-report-get" } } } }