REST API for Active Topology Automation and Service Impact Analysis

All REST Endpoints

Active Topology Automation/Edge

REST APIs for Active Topology Automation, Edge.

Create a new Edge: Method: post
Path: /topology/v2/edge
Delete an existing edge based on the entityId: Method: delete
Path: /topology/v2/edge/eid/{eid}
Delete an existing edge based on the fromNode and the toNode: Method: delete
Path: /topology/v2/edge/fromnode/{fromnode}/tonode/{tonode}
Delete an existing edge based on typeId and referenceId: Method: delete
Path: /topology/v2/edge/typeid/{typeid}/referenceid/{referenceid}
Retrieve a list of communication edges: Method: get
Path: /topology/v2/edge/communication
Retrieve a list of communication edges in a network: Method: get
Path: /topology/v2/edge/communication/network/{network}
Retrieve a list of communication edges terminated on a location: Method: get
Path: /topology/v2/edge/communication/location/eid/{loceid}
Retrieve a list of communication edges terminated on a network entity code: Method: get
Path: /topology/v2/edge/communication/nec/eid/{neceid}
Retrieve a list of communication edges within a specific distance of a device: Method: get
Path: /topology/v2/edge/communication/center-vertex/eid/{eid}
Retrieve a list of communication edges, nodes and alarms in a network: Method: get
Path: /topology/v2/edge/network/{network}
Retrieve a list of containment edges: Method: get
Path: /topology/v2/edge/containment
Retrieve a list of edges: Method: get
Path: /topology/v2/edge
Retrieve a list of Edges: Method: post
Path: /topology/v2/edge/edges
Retrieve a list of edges using a list of entity ids: Method: post
Path: /topology/v2/edge/eids
Retrieve an existing Edge based on enityId: Method: get
Path: /topology/v2/edge/eid/{eid}
Retrieve an existing Edge based on typeId and referenceId: Method: get
Path: /topology/v2/edge/typeid/{typeid}/referenceid/{referenceid}
Retrieve an related device edges based on the device enityId and edge label: Method: get
Path: /topology/v2/edge/device/eid/{eid}
Retrieve the location hierarchy down: Method: get
Path: /topology/v2/edge/vertex/eid/{eid}/hierarchy
Update an existing Edge: Method: put
Path: /topology/v2/edge
Update cost of existing edge: Method: patch
Path: /topology/v2/edge/eid/{eid}
Update cost of existing edge: Method: patch
Path: /topology/v2/edge/typeid/{typeid}/referenceid/{referenceid}

Active Topology Automation/PGX Graph

REST APIs for Active Topology Automation, PGX Graph.

Retrieve alarm types that needs to be excluded while doing path analysis.: Method: get
Path: /topology/v2/graph/excludeAlarmTypes
Retrieve All Edges: Method: get
Path: /topology/v2/graph/edge
Retrieve All Vertices: Method: get
Path: /topology/v2/graph/vertex
Retrieve an existing Edge based on enityId: Method: get
Path: /topology/v2/graph/edge/eid/{eid}
Retrieve an existing Vertex based on enityId: Method: get
Path: /topology/v2/graph/vertex/eid/{eid}
Retrieve cost mappings on communication edge.: Method: get
Path: /topology/v2/graph/costMapping
Retrieve paths that are matching the search criteria, mentioned in the form of properties in request: Method: get
Path: /topology/v2/graph/paths
Retrieve paths that are matching the search criteria, mentioned in the form of properties in request: Method: post
Path: /topology/v2/graph/paths
Retrieve shortest path from source to destination: Method: get
Path: /topology/v2/graph/shortest-path/source/{src}/destination/{dest}
Retrieve the count of Edges: Method: get
Path: /topology/v2/graph/edge/count
Retrieve the count of Vertices: Method: get
Path: /topology/v2/graph/vertex/count

Active Topology Automation/Profile

REST APIs for Active Topology Automation, Profile.

Create a new Profile .: Method: post
Path: /topology/v2/profile
Create a new Profile Edge .: Method: post
Path: /topology/v2/profileEdge
Create a new Profile Vertex.: Method: post
Path: /topology/v2/profileVertex
Delete an existing Profile nodes and edges.: Method: delete
Path: /topology/v2/profile/data/eid/{eid}
Retrieve an existing Profile reference id based on service and version.: Method: get
Path: /topology/v2/profile/referenceId/service/id/{id}/version/{version}
Retrieve Profile based on service id.: Method: get
Path: /topology/v2/profile/service/id/{id}
Retrieve Profile based on type id and reference id.: Method: get
Path: /topology/v2/profile/typeid/{typeid}/referenceid/{referenceid}
Retrieve service configuration versions based on service id and autosuggest version number: Method: get
Path: /topology/v2/profile/service/id/{id}/version/{version}
Retrieve service displayInfo based on autosuggest name: Method: get
Path: /topology/v2/profile/service/name/{name}
Update an existing Profile.: Method: put
Path: /topology/v2/profile

Active Topology Automation/Resource Adapter

REST APIs for Active Topology Automation, Resource Adapter.

Fetch GraphData based on entityType and entityid.: Method: get
Path: /topology/v2/tmf/resourceadapter/edge/paths/{entityType}/{eid}
Fetch layered view pipes based on id.: Method: get
Path: /topology/v2/tmf/resourceadapter/layeredview/pipes/{id}
Fetch overlay services for a given service id: Method: get
Path: /topology/v2/tmf/resourceadapter/layeredview/services/{id}
Fetch Physical Connectors based on id and resource type.: Method: get
Path: /topology/v2/tmf/resourceadapter/{resourceType}/{id}/physicalConnectors
Fetch Physical Ports based on id and resource type.: Method: get
Path: /topology/v2/tmf/resourceadapter/{resourceType}/{id}/physicalPorts
Fetch Pipe/Connectivity Channels.: Method: get
Path: /topology/v2/tmf/resourceadapter/edge/paths/underlay/channels/{id}
Fetch Pipe/Connectivity Underlay layers.: Method: get
Path: /topology/v2/tmf/resourceadapter/edge/paths/underlay/{entityType}/{eid}
Fetch Resource details based on id and depth.: Method: get
Path: /topology/v2/tmf/resourceadapter/resource/id/{id}
Fetch Resource details based on id.: Method: get
Path: /topology/v2/tmf/resourceadapter/id/{id}
Fetch Service Underlay layers.: Method: get
Path: /topology/v2/tmf/resourceadapter/edge/paths/underlay/service/{entityId}
Internal API to fetch Network graph details based on id.: Method: get
Path: /topology/v2/tmf/resourceadapter/network/id/{id}

Active Topology Automation/UI

The REST APIs Internally used from the ATA UI

AutoSuggest search by Device Identifier: Method: get
Path: /topology/v2/ui/autosuggest/device/deviceidentifier
AutoSuggest search by ID: Method: get
Path: /topology/v2/ui/autosuggest/{entityType}/id
AutoSuggest search by Location Code: Method: get
Path: /topology/v2/ui/autosuggest/location/locationcode
AutoSuggest search by Name: Method: get
Path: /topology/v2/ui/autosuggest/{entityType}
AutoSuggest search by static column data: Method: get
Path: /topology/v2/ui/autosuggest/static/{entityType}
Create a Color Preference.: Method: post
Path: /topology/v2/ui/color/preferences
Create a Icon Preference.: Method: post
Path: /topology/v2/ui/icons/preferences
Create a Saved Search.: Method: post
Path: /topology/v2/ui/savedsearch
Delete all existing Color Preferences: Method: delete
Path: /topology/v2/ui/color/preferences/createduser/{createdUser}
Delete all existing Color Preferences: Method: delete
Path: /topology/v2/ui/color/preferences/list
Delete all existing Icon Preferences: Method: delete
Path: /topology/v2/ui/icons/preferences/createduser/{createdUser}
Delete all existing Icon Preferences: Method: delete
Path: /topology/v2/ui/icons/preferences/list
Delete all existing uploaded custom Icons: Method: delete
Path: /topology/v2/ui/icons/delete
Delete an existing Color Preference: Method: delete
Path: /topology/v2/ui/color/preferences/id/{preferenceId}
Delete an existing custom Icon: Method: delete
Path: /topology/v2/ui/icons/delete/id/{id}
Delete an existing Icon Preference: Method: delete
Path: /topology/v2/ui/icons/preferences/id/{preferenceId}
Delete an existing Saved Search: Method: delete
Path: /topology/v2/ui/savedsearch/{id}
Get a saved search by ID: Method: get
Path: /topology/v2/ui/savedsearch/{id}
Get all the Color preferences: Method: get
Path: /topology/v2/ui/color/preferences/createduser/{createdUser}
Get all the Color preferences: Method: get
Path: /topology/v2/ui/color/preferences/list
Get all the Icon preferences: Method: get
Path: /topology/v2/ui/icons/preferences/createduser/{createdUser}
Get all the Icon preferences: Method: get
Path: /topology/v2/ui/icons/preferences/list
Get all the saved searches: Method: get
Path: /topology/v2/ui/savedsearch
Get logout-uri: Method: get
Path: /topology/v2/ui/logout-url
Get the list of a network subnetworks: Method: get
Path: /topology/v2/ui/network/{network}/subnetworks
Rerieve the graph for a list of locations: Method: get
Path: /topology/v2/ui/location/list
Retrieve all existing Custom Icons: Method: get
Path: /topology/v2/ui/icons
Retrieve graph data from list of connectivity eids: Method: get
Path: /topology/v2/ui/event/{eventid}/graph
Retrieve the graph for a list of devices: Method: get
Path: /topology/v2/ui/device/list
Retrieve the graph for a network: Method: get
Path: /topology/v2/ui/network/{network}
Retrieve the graph for a single connectivity: Method: get
Path: /topology/v2/ui/connectivity/{eid}
Retrieve the graph for a specific device: Method: get
Path: /topology/v2/ui/device/{eid}
Retrieve the graph for a specific location: Method: get
Path: /topology/v2/ui/location/{eid}
Retrieve the graph for the connectivity list: Method: get
Path: /topology/v2/ui/connectivity/list
Update an existing Color Preference.: Method: put
Path: /topology/v2/ui/color/preferences/id/{preferenceId}
Update an existing Icon Preference.: Method: put
Path: /topology/v2/ui/icons/preferences/id/{preferenceId}
Update an existing Saved Search.: Method: put
Path: /topology/v2/ui/savedsearch/{id}
Upload a custom Icon.: Method: post
Path: /topology/v2/ui/icons/upload

Active Topology Automation/Vertex

REST APIs for Active Topology Automation, Vertex.

Create a New Vertex: Method: post
Path: /topology/v2/vertex
Create an Event: Method: post
Path: /topology/v2/vertex/event
Delete an existing Vertex: Method: delete
Path: /topology/v2/vertex/eid/{eid}
Delete an existing Vertex based on typeId and referenceId: Method: delete
Path: /topology/v2/vertex/typeid/{typeid}/referenceid/{referenceid}
Retrieve a list of Vertices: Method: post
Path: /topology/v2/vertex/eids
Retrieve a list of Vertices: Method: post
Path: /topology/v2/vertex/vertices
Retrieve Active Events based on device entityId: Method: get
Path: /topology/v2/vertex/device/eid/{entityId}/events
Retrieve All Vertices: Method: get
Path: /topology/v2/vertex
Retrieve an existing Vertex based on entityId: Method: get
Path: /topology/v2/vertex/eid/{eid}
Retrieve an existing Vertex based on entityId: Method: get
Path: /topology/v2/vertex/id/{id}
Retrieve an existing Vertex based on typeId and Id: Method: get
Path: /topology/v2/vertex/typeid/{typeid}/id/{id}
Retrieve an existing Vertex based on typeId and referenceId: Method: get
Path: /topology/v2/vertex/typeid/{typeid}/referenceid/{referenceid}
Retrieve Child Vertices based on entityId: Method: get
Path: /topology/v2/vertex/device/eid/{eid}/children
Retrieve Event Type values: Method: get
Path: /topology/v2/vertex/event/config/{type}
Retrieve Parent Vertices based on entityId: Method: get
Path: /topology/v2/vertex/device/eid/{eid}/parents
Retrieve the event based on entityId: Method: get
Path: /topology/v2/vertex/event/eid/{eid}
Retrieve Vertices within distance: Method: get
Path: /topology/v2/vertex/distant/eid/{eid}
Update an existing Event: Method: put
Path: /topology/v2/vertex/event
Update an existing Vertex: Method: put
Path: /topology/v2/vertex
Update the Active Event Max Severity for the device: Method: put
Path: /topology/v2/vertex/activeEvent/eid/{eid}/severity/{severity}

Event and Impact Analysis/Event

Operations related to events management.

Bulk delete events using smart search filter query.: Method: delete
Path: /sia/v1/event/selectAllDelete
Bulk update events using smart search filter query.: Method: patch
Path: /sia/v1/event/selectAllUpdate
Bulk update events.: Method: patch
Path: /sia/v1/event/bulkUpdate
Create a new Event.: Method: post
Path: /sia/v1/event
Delete an Event and associated impacts.: Method: delete
Path: /sia/v1/event/referenceId/{referenceId}
Delete events in bulk and their associated impacts.: Method: delete
Path: /sia/v1/event/bulkDelete
Get active events for the resource.: Method: get
Path: /sia/v1/event/resourceActiveEvents/{resourceId}
Get active events with device topology entity id.: Method: get
Path: /sia/v1/event/device/eid/{entityId}/events
Get all events and impacts for the resource.: Method: get
Path: /sia/v1/event/resourceEventsImpacts
Get Event Type values.: Method: get
Path: /sia/v1/event/event/config/{type}
Get highest severity active events for resources.: Method: post
Path: /sia/v1/event/resourceActiveEvents
Get number of impacted customers by this event.: Method: get
Path: /sia/v1/event/customerCount/{eventDocId}
Get the event with document id.: Method: get
Path: /sia/v1/event/docid/{docid}
Get the event with reference id.: Method: get
Path: /sia/v1/event/referenceId/{referenceId}
Update an event with reference id.: Method: patch
Path: /sia/v1/event/referenceId/{referenceId}
Update an existing Event.: Method: put
Path: /sia/v1/event
Update an existing Event.: Method: put
Path: /sia/v1/event/patchEvent
Update existing event description, owner name.: Method: patch
Path: /sia/v1/event/docid/{docid}

Event and Impact Analysis/Impact

Operations related to impacts management.

Bulk update impacts using smart search filter query.: Method: patch
Path: /sia/v1/impact/selectAllUpdate
Bulk update impacts.: Method: patch
Path: /sia/v1/impact/bulkUpdate
Get impacts for an event.: Method: get
Path: /sia/v1/impact/event/{eventId}
Initiate impact analysis for device interface.: Method: get
Path: /sia/v1/impact/deviceinterface/{id}
Initiate impact analysis for equipment.: Method: get
Path: /sia/v1/impact/equipment/{id}
Initiate impact analysis for logical device.: Method: get
Path: /sia/v1/impact/logicaldevice/{id}
Initiate impact analysis for physical device.: Method: get
Path: /sia/v1/impact/physicaldevice/{id}
Initiate impact analysis for physical port.: Method: get
Path: /sia/v1/impact/physicalport/{id}
Update impact.: Method: patch
Path: /sia/v1/impact/docid/{docid}

Event and Impact Analysis/Report

Operations related to impact reports management.

Get impact reports.: Method: get
Path: /sia/v1/report

Fallout Events Resolution

REST APIs for Fallout Events Resolution.

Cancel running rebuild fallout event Jobs: Method: delete
Path: /topology/v2/fallout/events/rebuild/jobs
Delete fallout event by entityId: Method: delete
Path: /topology/v2/fallout/events/eid/{eid}
Delete fallout events by list of entityIds: Method: delete
Path: /topology/v2/fallout/events/eid
Deletes fallout events: Method: delete
Path: /topology/v2/fallout/events
Get available values for filters: Method: post
Path: /topology/v2/fallout/events/aggregate
Get Fallout Event by EntityId: Method: get
Path: /topology/v2/fallout/events/eid/{eid}
Get fallout events: Method: get
Path: /topology/v2/fallout/events
Get fallout events summary: Method: get
Path: /topology/v2/fallout/events/summary
Rebuild the fallout events by filters.: Method: post
Path: /topology/v2/fallout/events/rebuild
Resubmit fallout events: Method: post
Path: /topology/v2/fallout/events/resubmit
Return default filter chips for fallout events: Method: post
Path: /topology/v2/fallout/events/filters
Schedule rebuild fallout event jobs: Method: post
Path: /topology/v2/fallout/events/rebuild/jobs
Update a fallout event by entityId: Method: put
Path: /topology/v2/fallout/events/eid/{eid}