• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use cURL
• Authenticate
• Send Requests
• Application Notes
  • Network Functions
• Reference
  • Status Codes
  • Error Messages

Tasks

• admin
  • Get Information on SDM Servers
  • Login
  • Logout
• device configuration
  • Add a configuration element
  • Assign a Device to Element Manager for FCAPS Management
  • Create a Configuration Element
  • Delete a Configuration Element
  • Delete Pending Configuration Modifications
  • Get a Configuration Element Instance
  • Get a List of Configuration Element Instances
  • Get a List of Devices Associated with Element Manager
  • Get a List of Top-level Configuration Element Types
  • Get Additional Attribute Metadata
  • Get Additional Element Metadata
  • Get Device Configuration Management Summary Information
  • Get Pending Configuration Modifications
  • Load a Configuration for a Targeted Device
  • Unassign a Device from Element Manager to Stop FCAPS Management
  • Update a Configuration Element
  • Update a Configuration Password
  • Update the Configuration on a Device
• fault
  • Get a List of Alarms
  • Get a List of Northbound Trap Receivers
  • Get Information of a Targeted Northbound Trap Receiver
  • Initiate a Request for Synchronization of Events or Alarms
• fraud protection
  • Send FPL incremental updates from the FDP to the OCSDM Server
  • Upload a Fraud Protection List File to the OCSDM Server
• inventory
  • device
    • Get Device Information
    • Get Device License Information
    • Get Device Management Summary Information
    • Lock or Unlock a Device
  • device group
    • Add a Device Group
    • Delete a Device Group
    • Get Device Group Information
    • Get Existing Device Groups
    • Update a Device Group
• network function
  • Add an NF
  • Delete an NF
  • Get a Targeted NF
  • Get Information on an NF Group
  • Get List of NFs in Device Management
  • Get NF Device Groups
  • Lock or Unlock Devices
  • Move an NF to Another Device Group Parent
  • Submit a Request to Resynchronize an NF
  • Update NF Information
• network function category
  • Get a Targeted Category
  • Get Additional Category Metadata
  • Get Additional NF Metadata
  • Get NF Supported product Categories
• performance
  • Deregister key performance indicators (KPIs) for devices
  • Display a list of device information that supports performance
  • Display the supported KPIs
  • Register KPIs for devices
  • Retrieve KPI statistics for devices
  • Update registered KPIs for devices
• plugin
  • Get All Plug-ins
  • Get Plug-in Information
  • Perform a Plug-in Action
  • Remove a Plug-in
  • Update Plug-in Information
  • Upload a Plug-in
• route sets management
  • Add a route to routeSet.
  • Add an associated device to a route set
  • Commit/Rollback/Cancel a route set update.
  • Create a new route Set
  • Delete a particular Route Set by Id
  • Delete associated device from specified route set
  • Delete Route Entry by ID
  • Execute some action on CSV file import
  • Execute user action on Add route set task.
  • GET all associated device from a perticular route set
  • Get All Existing Route Sets
  • Get All or subset of route entries from a perticular routeset
  • GET all route updates on devices.
  • Get Route Entry by ID
  • Get Route Sets by specifying a Route Set Id.
  • GET status of add route set task by restoring LRT from device.
  • Get status of update task by task id
  • GET the list of templates on the SDM Server
  • Get the status of the file import task
  • Import a CSV File in to route Set
  • Modify a perticular RouteSet
  • Modify Route Entry by Id
  • POST to Lock/Unlock/OverrideLock a RouteSet
  • Update all associated SBC devices with specified route sets.
  • Update specified SBC devices with specified route set
• security
  • Get User Account Information
  • Get User Information
  • Get Users