Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Authentication and Authorization
• Install and Use cURL
• Send Requests
• Status Codes
• ATA Model Documentation
• ATA Asynchronous Events

Tasks

• Active Topology Automation
  • AutoSuggest search by Device Identifier
  • AutoSuggest search by ID
  • AutoSuggest search by Location Code
  • AutoSuggest search by Name
  • AutoSuggest search by static column data
  • Create a Color Preference.
  • Create a Icon Preference.
  • Create a new Edge
  • Create a new Profile .
  • Create a new Profile Edge .
  • Create a new Profile Vertex.
  • Create a New Vertex
  • Create a Saved Search.
  • Create an Event
  • Delete a custom Icon with id
  • Delete all Color Preferences created by user
  • Delete all existing Color Preferences
  • Delete all existing Icon Preferences
  • Delete all existing uploaded custom Icons
  • Delete all icon preferences created by user
  • Delete an existing Color Preference
  • Delete an existing edge based on the entityId
  • Delete an existing edge based on the fromNode and the toNode
  • Delete an existing edge based on typeId and referenceId
  • Delete an existing Profile nodes and edges.
  • Delete an existing Saved Search
  • Delete an existing Vertex
  • Delete an existing Vertex based on typeId and referenceId
  • Delete Icon Preference by Id
  • Fetch GraphData based on entityType and entityid.
  • Fetch Physical Connectors based on id and resource type.
  • Fetch Physical Ports based on id and resource type.
  • Fetch Resource details based on id.
  • Get a saved search by ID
  • Get all the Color preferences
  • Get all the Color preferences
  • Get all the Icon preferences
  • Get all the Icon preferences
  • Get all the saved searches
  • Get the list of a network subnetworks
  • Rerieve the graph for a list of locations
  • Retrieve a list of communication edges
  • Retrieve a list of communication edges in a network
  • Retrieve a list of communication edges terminated on a location
  • Retrieve a list of communication edges terminated on a network entity code
  • Retrieve a list of communication edges within a specific distance of a device
  • Retrieve a list of communication edges, nodes and alarms in a network
  • Retrieve a list of containment edges
  • Retrieve a list of edges
  • Retrieve a list of Edges
  • Retrieve a list of edges using a list of entity ids
  • Retrieve a list of Vertices
  • Retrieve Active Events based on device entityId
  • Retrieve alarm types that needs to be excluded while doing path analysis.
  • Retrieve All Edges
  • Retrieve all existing Custom Icons
  • Retrieve All Vertices
  • Retrieve All Vertices
  • Retrieve an existing Edge based on enityId
  • Retrieve an existing Edge based on enityId
  • Retrieve an existing Edge based on typeId and referenceId
  • Retrieve an existing Profile reference id based on service and version.
  • Retrieve an existing Vertex based on enityId
  • Retrieve an existing Vertex based on entityId
  • Retrieve an existing Vertex based on entityId
  • Retrieve an existing Vertex based on typeId and Id
  • Retrieve an existing Vertex based on typeId and referenceId
  • Retrieve an related device edges based on the device enityId and edge label
  • Retrieve Child Vertices based on entityId
  • Retrieve cost mappings on communication edge.
  • Retrieve Event Type values
  • Retrieve graph data from list of connectivity eids
  • Retrieve list of Vertices with entity ids
  • Retrieve Parent Vertices based on entityId
  • Retrieve paths that are matching the search criteria, mentioned in the form of properties in request
  • Retrieve paths that are matching the search criteria, mentioned in the form of properties in request
  • Retrieve Profile based on type id and reference id.
  • Retrieve service configuration versions based on service id and autosuggest version number
  • Retrieve service displayInfo based on autosuggest name
  • Retrieve shortest path from source to destination
  • Retrieve the count of Edges
  • Retrieve the count of Vertices
  • Retrieve the event based on entityId
  • Retrieve the graph for a list of devices
  • Retrieve the graph for a network
  • Retrieve the graph for a single connectivity
  • Retrieve the graph for a specific device
  • Retrieve the graph for a specific location
  • Retrieve the graph for the connectivity list
  • Retrieve the location hierarchy down
  • Retrieve Vertices within distance
  • Update an existing Color Preference.
  • Update an existing Edge
  • Update an existing Event
  • Update an existing Icon Preference.
  • Update an existing Profile.
  • Update an existing Saved Search.
  • Update an existing Vertex
  • Update cost of existing edge
  • Update cost of existing edge
  • Update the Active Event Max Severity for the device
  • Upload a custom Icon.
  • Fallout Events Resolution
    • Cancel running rebuild fallout event Jobs
    • Delete a fallout Event
    • Delete fallout events with entity ids
    • Delete fallout events with search criteria
    • Get a fallout event
    • Get fallout events
    • Get fallout events summary
    • Resubmit fallout events
    • Schedule rebuild fallout event jobs
    • Update a fallout event
• Event and Impact Analysis
  • Event
    • Bulk delete events
    • Bulk delete events using filter query
    • Bulk update events
    • Bulk update events using filter query
    • Create a new Event
    • Delete an event with reference id
    • Get active events for the resource
    • Get active events with device topology entity id
    • Get an event with document id
    • Get an event with reference id
    • Get Event Type values
    • Get highest severity active events for resources
    • Get number of impacted customers for an event
    • Patch an event with document id
    • Update an Event
    • Update an event with reference id
  • Impact
    • Bulk update impacts
    • Bulk update impacts using filter query
    • Get impacts for an event
    • Initiate impact analysis for device interface
    • Initiate impact analysis for equipment
    • Initiate impact analysis for logical device
    • Initiate impact analysis for physical device
    • Initiate impact analysis for physical port
    • Update an impact with document id
  • Report
    • Get impact reports