🔧 Common Resource

Health checks and lookup data

Two publicly accessible utility endpoints: HealthCheck returns API operational status for monitoring, and Lookup provides ID type definitions.

2
Endpoints
Public
No Auth Required
Utility
Resource Type
57
Lookup Categories

Usage Notes

When

  • Check API availability and health
  • Retrieve lookup values for type IDs used across all resources

Requirements

  • No authentication required at the HTTP level for either endpoint.
  • SDK trap: client.Common.HealthCheck() and client.Common.GetLookupAsync(...) both call EnsureValidTokenAsync() before sending, so SDK callers still need a prior LoginAsync(). To probe the API without authenticating, call /common/HealthCheck or /common/lookup directly via HTTP.

Notes

  • HealthCheck for monitoring and availability verification.
  • Lookup returns categorised type-ID definitions for the resources across the API; always retrieve at runtime rather than hardcoding numeric IDs.

Description

Common provides two public utility endpoints: HealthCheck for API status and Lookup for type ID definitions used across all resources.

Available Endpoints

GET HealthCheck Returns success response if API is operational
GET Lookup Returns ID-Value pairs for lookup categories