Ops Center Analyzer Detail View REST API Reference Guide

Version: 11.0.x
Audience: anonymous
Part Number: MK-99ANA004-12

Overview
Analyzer detail view database schema
Common specification of the API functions
Communication protocols and port numbers
Request and response formats
Request format of the API
API request headers
URI format
API request URL
API request length restriction
API request process flow
Request scheduling and throttling
Asynchronous request processing
Caching asynchronous requests
Response format of the API
Response headers descriptions
HTTP status codes descriptions
Timestamps and time zones
Authorization for APIs
Authorization for APIs using the Analyzer detail view local and Active Directory users
Authorization for APIs using the Ops Center Portal users
API parameters
Data subset API resources
Creating a data subset
Getting information about the data subset
Attribute definitions
Creating a custom attribute definition
Getting information about an attribute definition
Updating attribute definition information
Deleting the custom attribute definition
Resource definitions
Creating a custom resource definition
Getting information about a resource definition
Updating resource definition information
Deleting a resource definition
Resource data
Creating or updating resource data
Locking the request at resource level
Time series data points
Deleting resource data
Getting resource data information
Deactivating the resource data
Dataset API resources
Getting information about a dataset
Deleting the dataset
Request API resources
Getting the request status
Getting an audit log
Stopping an API request
Getting the Analyzer detail view server information
Database API resources
Configuring database and API properties
Editing database properties
Editing API properties
Configuring the number of worker threads for the application web server (Jetty)
Increasing the maximum number of open file handles
Viewing the existing schema using REST APIs
Query API resources
Running the MQL query
Best practices for query APIs
Alert API resources
Alert API design
Creating an alert definition
Getting information about alert definitions
Getting information about alert condition violations
Subscribing to push notifications
Websocket
Subscribing to alert notifications
Unsubscribing an alerts notification
Pausing an alert definition evaluation
Restarting an alert definition evaluation
Deleting an alert definition
Updating an alert threshold
Getting the status of an alert request
Getting an alert audit log
Evaluating alert violations
Selecting the data interval
Data hole consideration in the alert violation computation
Editing the threshold value
User, license, and product URL API resources
Access rights for API functions
API authentication
License key authentication
User authentication token
Authentication details for API functions
API request headers
User management API design
Creating a user
Updating specific user information
Changing a password
Deleting a specific user from the Analyzer detail view
Registering a license
Getting the URL of the Analyzer detail view
API server response error codes and messages
API server response error codes and messages
Alert API response error codes and messages
References

Back to home page