🔧 Common Resource

System utilities and reference data services

Utility and system services providing health monitoring, system status verification, and reference data lookup services. Public endpoints supporting API integration testing, system monitoring, uptime verification, and validation data access for system reliability and integration workflows.

2
Endpoints
Public
Access Level
Reliable
Uptime
24/7
Available
🟢

System Health & Monitoring

System status verification, connectivity validation, and uptime monitoring with health metrics for automated monitoring and alerting systems.

📊

Reference Data & Validation

Reference data services including lookup tables, validation lists, enum values, and metadata for dropdown population, form validation, and business rule implementation.

🌍

Public Access & Integration

Authentication-free public endpoints for integration testing, system monitoring, automated health checks, and external monitoring system integration.

Available Endpoints

Public Utility Services

Query Parameters

Common endpoints use direct query parameters, not filter classes.

Note: GET /Common/HealthCheck has no parameters. GET /Common/Lookup uses Name query parameter for lookup category selection (e.g., ?Name=TitleID or ?Name=info for available lookups).

Common Use Cases

🔍

Automated Monitoring

24/7 system health monitoring, uptime verification, and automated alerting for DevOps and infrastructure monitoring systems.

📋

Reference Data Management

Dynamic dropdown population, form validation, and business rule implementation using comprehensive lookup data services.

🔗

Integration Testing

Pre-authentication connectivity testing, API availability verification, and integration validation for development workflows.

🏢

Monitoring Integration

Integration with monitoring systems, security platforms, and automated deployment pipelines.

Business Rules & Constraints

Public Access & Security Model

  • Authentication-free access: Both endpoints are publicly accessible without access token requirements
  • Security boundaries: Public endpoints provide system status without exposing sensitive operational data, with rate limiting and CORS enabled for integration testing
  • High availability: Reliable uptime with infrastructure redundancy and failover support

Performance & Reliability Standards

  • Response performance: Fast response times with lookup data caching for efficient access and reduced latency
  • Monitoring integration: Health check endpoint designed for automated monitoring system integration
  • Lookup data: Reference tables for business validation and UI population

Integration Features

  • Pre-flight validation: Useful for connectivity validation, system readiness verification, and integration testing
  • Monitoring compatibility: Compatible with monitoring platforms, dashboards, and alerting systems
  • Metadata services: API endpoint discovery and capability detection through lookup enumeration