API Enhancements for Module Masters

  • Updated on May 4, 2026
  • Published on Apr 24, 2026
  • 1 minute(s) read
Prev Next

APIs for ITSM Module Masters (Example: Incident Masters, Service Request Masters, Change Management Masters, Problem Management Masters and Knowledge Management Masters) are enhanced, to provide better‑performance, in addition to the following benefits.

These APIs are optimized for:

  • AI use cases

  • Future mobile and integration platforms

  • Internal workflows and analytics

  • Low‑latency master data retrieval

The new API is based on React.JS frontend and .NET Core backend that allows users to:

  • Authenticate using an API key

  • Discover available APIs

  • Execute API requests directly from the browser

  • Inspect requests, responses, and response times

  • Test APIs without external tools like Postman

These APIs return structured, clean data in sub‑second response times. These new APIs are build on a new API layer, with .NET Core and are connected to the Apex Aspen database. These APIs are lightweight, Fast and standardized.

Key Benefits

🚀 Performance

  • Typical responses in < 1 second

  • Optimized queries and streamlined payloads

🤖 AI‑Ready

  • Predictable, structured responses

  • Suitable for training data ingestion, inference, and orchestration

🔌 Integration Friendly

  • Usable for:

    • Mobile apps

    • Workflow engines

    • Internal integration services

    • Future external integrations

🔐 Controlled Access

  • API‑key based authentication

  • Data visibility based on assigned user persona

Supported User Personas

Access is governed by persona mapping. Users can only retrieve data they are authorized to see.

Primary Persona: Analyst

  • Explores master data

  • Fetches structured datasets

  • Supports reporting, validation, and analysis

Authentication

Supported

  • ✅ API Key or Bearer Token

How API Key Works

  • Generated from the Apex system

  • Same key is used in:

    • API Explorer UI

    • Direct API calls

Figure: API Key Authentication

In the following sections, let’s go through the Incident Management Masters APIs.

  1. List all the Incident Management Master APIs. The following output displays all the Incident Masters list, such as category master, classification master, closure code, impact, urgency, etc…
    API Request EndPoint: https://Domain-name/API/v1/Master/IM

    Figure: List Incident Management API Masters

  2. The following API further helps you to fetch all the categories and it’s values inside the Incident Master.
    API Request EndPoint: https://domain-name/API/v1/Master/IM/category

    Method: Get

    Figure: List categories inside Incident Masters

  3. The following API further helps you to fetch all the categories for a specific instance (tenant) which in this example is IT for the Incident Master.
    API Request EndPoint: https://domain-name/API/v1/Master/IM/category?instance=IT
    Method: Get

    Figure: List categories for specific Instance inside Incident Masters

  4. The following API provides you details of all the possible channels/medium through which the Incident is raised.
    API Request Endpoint: https://domain-name/API/v1/Master/IM/Medium
    Method: Get

    Figure: List Medium/Channels to raise Incident API

  5. The following output displays all the Service Request Masters parameters, which are essentially used to create a Service Request. Example: configuration item, category, classification, instance, workgroup, closure code, etc…
    API Request EndPoint: https://Domain-name/API/v1/Master/SR
    Method: Get

    Figure: List essential Parameters for Service Request Master