REST API for Unified Topology for Inventory and Automation

UTIA REST Endpoints

UTIA

UTIA Schemas

AutoSuggest search by Device Identifier: Method: get
Path: /ui/autosuggest/device/deviceidentifier
AutoSuggest search by ID: Method: get
Path: /ui/autosuggest/{entityType}/id
AutoSuggest search by Location Code: Method: get
Path: /ui/autosuggest/location/locationcode
AutoSuggest search by Name: Method: get
Path: /ui/autosuggest/{entityType}
AutoSuggest search by static column data: Method: get
Path: /ui/autosuggest/static/{entityType}
Create a new Edge: Method: post
Path: /edge
Create a new Profile .: Method: post
Path: /profile
Create a new Profile Edge .: Method: post
Path: /profileEdge
Create a new Profile Vertex.: Method: post
Path: /profileVertex
Create a New Vertex: Method: post
Path: /vertex
Create a Saved Search.: Method: post
Path: /ui/savedsearch
Create an Event: Method: post
Path: /vertex/event
Delete an existing edge based on the entityId: Method: delete
Path: /edge/eid/{eid}
Delete an existing edge based on the fromNode and the toNode: Method: delete
Path: /edge/fromnode/{fromnode}/tonode/{tonode}
Delete an existing edge based on typeId and referenceId: Method: delete
Path: /edge/typeid/{typeid}/referenceid/{referenceid}
Delete an existing Profile nodes and edges.: Method: delete
Path: /profile/data/eid/{eid}
Delete an existing Saved Search: Method: delete
Path: /ui/savedsearch/{id}
Delete an existing Vertex: Method: delete
Path: /vertex/eid/{eid}
Delete an existing Vertex based on typeId and referenceId: Method: delete
Path: /vertex/typeid/{typeid}/referenceid/{referenceid}
Fetch Physical Connectors based on id and resource type.: Method: get
Path: /tmf/resourceadapter/{resourceType}/{id}/physicalConnectors
Fetch Physical Ports based on id and resource type.: Method: get
Path: /tmf/resourceadapter/{resourceType}/{id}/physicalPorts
Fetch Resource details based on id.: Method: get
Path: /tmf/resourceadapter/id/{id}
Get a saved search by ID: Method: get
Path: /ui/savedsearch/{id}
Get all the saved searches: Method: get
Path: /ui/savedsearch
Get the list of a network subnetworks: Method: get
Path: /ui/network/{network}/subnetworks
Rerieve the graph for a list of locations: Method: get
Path: /ui/location/list
Retrieve a list of communication edges: Method: get
Path: /edge/communication
Retrieve a list of communication edges in a network: Method: get
Path: /edge/communication/network/{network}
Retrieve a list of communication edges terminated on a location: Method: get
Path: /edge/communication/location/eid/{loceid}
Retrieve a list of communication edges terminated on a network entity code: Method: get
Path: /edge/communication/nec/eid/{neceid}
Retrieve a list of communication edges within a specific distance of a device: Method: get
Path: /edge/communication/center-vertex/eid/{eid}
Retrieve a list of communication edges, nodes and alarms in a network: Method: get
Path: /edge/network/{network}
Retrieve a list of containment edges: Method: get
Path: /edge/containment
Retrieve a list of edges: Method: get
Path: /edge
Retrieve a list of Edges: Method: post
Path: /edge/edges
Retrieve a list of edges using a list of entity ids: Method: post
Path: /edge/eids
Retrieve a list of Vertices: Method: post
Path: /vertex/eids
Retrieve a list of Vertices: Method: post
Path: /vertex/vertices
Retrieve Active Events based on device entityId: Method: get
Path: /vertex/device/eid/{entityId}/events
Retrieve alarm types that needs to be excluded while doing path analysis.: Method: get
Path: /graph/excludeAlarmTypes
Retrieve All Edges: Method: get
Path: /graph/edge
Retrieve All Vertices: Method: get
Path: /graph/vertex
Retrieve All Vertices: Method: get
Path: /vertex
Retrieve an existing Edge based on enityId: Method: get
Path: /edge/eid/{eid}
Retrieve an existing Edge based on enityId: Method: get
Path: /graph/edge/eid/{eid}
Retrieve an existing Edge based on typeId and referenceId: Method: get
Path: /edge/typeid/{typeid}/referenceid/{referenceid}
Retrieve an existing Profile reference id based on service and version.: Method: get
Path: /profile/referenceId/service/id/{id}/version/{version}
Retrieve an existing Vertex based on enityId: Method: get
Path: /graph/vertex/eid/{eid}
Retrieve an existing Vertex based on entityId: Method: get
Path: /vertex/eid/{eid}
Retrieve an existing Vertex based on entityId: Method: get
Path: /vertex/id/{id}
Retrieve an existing Vertex based on typeId and Id: Method: get
Path: /vertex/typeid/{typeid}/id/{id}
Retrieve an existing Vertex based on typeId and referenceId: Method: get
Path: /vertex/typeid/{typeid}/referenceid/{referenceid}
Retrieve an related device edges based on the device enityId and edge label: Method: get
Path: /edge/device/eid/{eid}
Retrieve Child Vertices based on entityId: Method: get
Path: /vertex/device/eid/{eid}/children
Retrieve cost mappings on communication edge.: Method: get
Path: /graph/costMapping
Retrieve Event Type values: Method: get
Path: /vertex/event/config/{type}
Retrieve Parent Vertices based on entityId: Method: get
Path: /vertex/device/eid/{eid}/parents
Retrieve paths that are matching the search criteria, mentioned in the form of properties in request: Method: get
Path: /graph/paths
Retrieve paths that are matching the search criteria, mentioned in the form of properties in request: Method: post
Path: /graph/paths
Retrieve Profile based on type id and reference id.: Method: get
Path: /profile/typeid/{typeid}/referenceid/{referenceid}
Retrieve service configuration versions based on service id and autosuggest version number: Method: get
Path: /profile/service/id/{id}/version/{version}
Retrieve service displayInfo based on autosuggest name: Method: get
Path: /profile/service/name/{name}
Retrieve shortest path from source to destination: Method: get
Path: /graph/shortest-path/source/{src}/destination/{dest}
Retrieve the count of Edges: Method: get
Path: /graph/edge/count
Retrieve the count of Vertices: Method: get
Path: /graph/vertex/count
Retrieve the event based on entityId: Method: get
Path: /vertex/event/eid/{eid}
Retrieve the graph for a list of devices: Method: get
Path: /ui/device/list
Retrieve the graph for a network: Method: get
Path: /ui/network/{network}
Retrieve the graph for a single connectivity: Method: get
Path: /ui/connectivity/{eid}
Retrieve the graph for a specific device: Method: get
Path: /ui/device/{eid}
Retrieve the graph for a specific location: Method: get
Path: /ui/location/{eid}
Retrieve the graph for the connectivity list: Method: get
Path: /ui/connectivity/list
Retrieve the location hierarchy down: Method: get
Path: /edge/vertex/eid/{eid}/hierarchy
Retrieve Vertices within distance: Method: get
Path: /vertex/distant/eid/{eid}
Update an existing Edge: Method: put
Path: /edge
Update an existing Event: Method: put
Path: /vertex/event
Update an existing Profile.: Method: put
Path: /profile
Update an existing Saved Search.: Method: put
Path: /ui/savedsearch/{id}
Update an existing Vertex: Method: put
Path: /vertex
Update cost of existing edge: Method: patch
Path: /edge/eid/{eid}
Update cost of existing edge: Method: patch
Path: /edge/typeid/{typeid}/referenceid/{referenceid}