AlphaX
  • WORKSPACE
    • Data Table List View
      • AI View
    • Map
  • Analysis
    • Overview
    • Anomalies
      • Batch Detection
      • Change Point Detection
      • Streaming Detection
      • User interface
        • Anomaly List View
        • Anomaly Edit View
        • Anomaly Chart View
        • Anomaly Share View
      • Analysis List View
    • TOOLBOX
      • Analysis
        • Charts
          • Charts View
          • Drawings View
          • Data View
        • Table
        • Anomaly
      • Reports
        • Reports List View
          • Create a New Report
        • Reports Manage View
      • Device
        • Devices List View
          • Create New Device Registration
        • Devices Manage View
      • API Endpoints
        • API Endpoints List View
          • Create a New Feed
        • API Endpoints Manage View
      • Integrations
        • Integrations List View
          • App
        • Integrations Manage View
      • Dashboards
        • Dashboards List View
          • Create a New Dashboard
        • Dashboards Manage View
      • Alerts
        • Events Hub List View
        • Events Hub Manage View
        • Event Data Format
        • Event Acknowledgement
      • Calculations
        • Calculations List View
          • Create a New Calculation
        • Calculations Manage View
      • Controls
        • Controls List View
          • Create a New Control Element
        • Controls Manage View
  • Data Hub
    • API Queries
      • API Queries List View
      • API Queries Modal View
      • Testing API Queries
      • Common Issues & Troubleshooting
    • ADMINISTRATION
      • People
        • Users
          • Users List View
            • Create a New User Account
          • Users Manage View
        • Roles
          • Roles List View
            • Create a New Access Role
          • Roles Manage View
        • Contacts
          • Contacts List View
            • Create New Contact
          • Contacts Manage View
      • Configuration
        • Asset Hierarchy
          • Asset Hierarchy List View
            • Create New Entity
          • Asset Hierarchy Manage View
        • Attributes
          • Asset Classes
            • Asset Classes List View
              • Create New Asset Class
            • Asset Classes Manage View
          • Battery Types
            • Battery Types List View
              • Create New Battery Type
            • Battery Types Manage View
          • Device Categories
            • Device Categories List View
              • Create New Device Category
            • Device Categories Manage View
          • Feed Types
            • Feed Types List View
              • Create a New Feed Type
            • Feed Types Manage View
          • Manufactures
            • Manufacturers List View
              • Create a New Manufacture
            • Manufactures Manage View
          • Models
            • Models List View
              • Create a New Model
            • Models Manage View
          • Network Types
            • Network Types List View
              • Create New Network Type
            • Network Types Manage View
          • Power Sources
            • Power Sources List View
              • Create A New Power Source
            • Power Sources Manage View
          • Sensor Types
            • Sensor Types List View
              • Create New Sensor Type
            • Sensor Types Manage View
          • Status Labels
            • Status Labels List View
              • Create New Status Label
            • Status Labels Manage View
          • Suppliers
            • Suppliers List View
              • Create New Supplier
            • Suppliers Manage View
      • System Logs
        • System Logs List View
        • Email Message Log
        • SMS Message Log
        • API Transaction Log
        • Create a New Service Log Report
Powered by GitBook
On this page
  • Page Header
  • Filter and Tools Bar
  • Table Columns and Functionality
  • Actions Buttons Explanations Table
  • Key Features of the API Endpoints View
  • Conclusion
  1. Analysis
  2. TOOLBOX
  3. API Endpoints

API Endpoints List View

The API Endpoints window manages, customizes, and organizes API connections with options for filtering, editing, exporting, and deleting.

PreviousAPI EndpointsNextCreate a New Feed

Last updated 4 months ago

The API Endpoints window in AlphaX Cloud provides a user-friendly interface for managing API connections. It features a searchable table with sortable columns (Entity, Type, Name, URL, and Actions). Users can create, edit, copy, or delete endpoints. Tools include column visibility customization, export options, and maximization for full-screen viewing. Pagination ensures efficient navigation of large datasets.

Page Header

  1. "Create" Button

    • A blue button labelled "Create" allows users to create a new API endpoint. Clicking it opens a new interface to set up a new endpoint.

Filter and Tools Bar

  1. Filter Input

    • A Filter search box allows users to search and quickly find specific API endpoints by name, entity, or type.

  2. Functional Buttons

Column Visibility: Toggles the visibility of specific table columns, allowing users to customize the view.

Export: Exports the list of API endpoints to a file (e.g., CSV), enabling offline analysis or sharing.

Maximize: Expands the view to full-screen mode for better visibility of the table content.

Table Columns and Functionality

Column Name
Description
Sorting Option

Entity

Displays the organization, council, or entity that owns the API endpoint and etc.

Users can sort the data alphabetically or reverse alphabetically by clicking the column header.

Type

Shows the type of API endpoint (e.g., "Conduit V7").

Users can sort the data alphabetically by endpoint type.

Name

Lists the names of the endpoints (e.g., "Test" or "SCC-CAM20"), used for easy identification.

Users can sort the data alphabetically to find a specific name quickly.

URL

Contains the API endpoint URL, which can be copied and used to fetch data.

Users can sort URLs alphabetically to organize them by structure or host.

Actions

Offers three management buttons: Copy, Manage, and Delete.

Sorting is not applicable to this column.

Actions Buttons Explanations Table

Action
Purpose
Details

Copy to Clipboard

Copies the full API URL to the clipboard.

  • The copied URL can be pasted into a browser's address bar.

  • When accessed, it downloads a file with the selected and aggregated data.

Manage

Opens a new tab labelled "Edit API Endpoint" to modify endpoint details.

  • Users can update or edit the API endpoint's configuration.

  • Provides an option to save changes or cancel to retain the original data.

Delete

Opens a new tab labelled "Delete API Endpoint" with a confirmation prompt.

  • Prompt Message: "Are you sure you want to delete Endpoint [Name of Endpoint]?"

  • Options,

(1) No: Cancels the deletion and closes the tab. (2) Confirm: Permanently deletes the API endpoint.

Key Features of the API Endpoints View

  • Sorting: The Entity, Type, Name, and URL columns have sorting capabilities, enabling users to organize data for easier navigation.

  • Search and Export: The filter bar and export options streamline endpoint management by enabling quick searches and offline data analysis.

  • Direct Access to Data: The Copy to Clipboard action ensures fast and simple access to API endpoint data.

Navigating Pages

  1. Use Pagination Buttons: Click the "Previous" or "Next" buttons to navigate through different pages of the events list.

Conclusion

The API Endpoints View is a robust and versatile interface for managing API endpoints in AlphaX. It combines efficient data organization, customization, and management options with straightforward access to endpoint data. This layout ensures an optimal user experience for managing multiple API integrations.

API Endpoints List View