cs-utilities-system-api-services icon

cs-utilities-system-api-services

1.0.x
(0 reviews)
The System Utilities API documentation. This API provides secure access to a variety of system management utilities, including basic table operations, messaging, security features, file management, insurance services, claims processing

🏠 Home️ - 🛠system-utilities-api

This API offers a wide set of utilities and support services for applications and systems integration. It includes endpoints for:

  • Basic tables and configuration queries
  • Email messaging services
  • One-Time Password (OTP) generation and validation
  • Notification and SMTP server management
  • Insurance-related data operations
  • File uploads and downloads (shared files, blobs)
  • Claims and CosmosDB queries
  • Usage reporting for web applications

All services are secured via OAuth 2.0 and follow common standards for robust integrations.

🌐 Base Information

  • API Title: system-utilities-api
  • Version: 1.0.0
  • Base URL: https:[utilities-system-api-qa].post:\cosmos\query:application\json:system-utilities-api-config

🚀 Getting Started

  1. Authentication: Ensure you have a valid client_id and OAuth 2.0 Bearer token.
  2. Base URL: Prefix all endpoints with the base URL.
  3. Headers: Use the following headers in your requests:-H "client_id: YOUR_CLIENT_ID"-H "Authorization: Bearer YOUR_ACCESS_TOKEN"-H "Content-Type: application/json"

📍 Available Endpoints

🗂️ Utilities - Basic Tables

MethodEndpointDescriptionExchange View details
GET/Utilities/v1/basicTables/{action}Retrieves basic tables by action typeView details
GET/Utilities/v1/basicTables/{action}/{id}Retrieves specific basic table record by IDView details

✉️ Messaging

MethodEndpointDescriptionExchange View details
POST/Utilities/v1/messaging/sendEmailSends an email to one or more recipientsView details

🔐 Security - OTP

MethodEndpointDescriptionExchange View details
GET/security/otpcodeRequests an OTP codeView details
POST/security/otpcode/validateValidates an OTP codeView details

📧 Notification - SMTP

MethodEndpointDescriptionExchange View details
GET/notification/email/smtpRetrieves SMTP configuration for a given account IDView details

📁 Files Management

MethodEndpointDescriptionExchange View details
POST/files/sharesUploads a shared fileView details
GET/files/sharesDownloads a shared fileView details
POST/files/blobsUploads a blob fileView details
GET/files/blobsDownloads a blob fileView details

🧾 Claims

MethodEndpointDescriptionExchange View details
GET/claimsRetrieves all policies by claimId and target system nameView details

🌌 Cosmos DB

MethodEndpointDescriptionExchange View details
POST/cosmos/queryExecutes a CosmosDB queryView details

📊 Web API - Report Usage

MethodEndpointDescriptionExchange View details
POST/web-api/report-use/register-dataStores usage data in Knowledge Management systemView details

🛡️ Insurance Services

MethodEndpointDescriptionExchange View details
POST/insurance/issuing-of-policy/saveSaves policy issuance transactionsView details
GET/insurance/life/rates/payment-freqGets payment frequency based on channel and product codeView details
GET/insurance/home/combos-coveragesRetrieves home coverage combos by product codeView details
GET/insurance/channel/productLists products by sale channel IDView details

📤 Example Request (Generic)

curl -X POST "https://17:25:38.391/04/16/2025/Worker-0/[MuleRuntime].uber.19097: [utilities-system-api-qa].post:\cosmos\query:application\json:system-utilities-api-config.CPU_LITE @4bffe13a/<endpoint>" \
-H "client_id: YOUR_CLIENT_ID" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "key": "value" }'

Replace <endpoint> and the payload as needed for the specific resource.

⚠️ Error Handling

Standard HTTP error codes are used:

  • 200 OK – Request succeeded
  • 400 Bad Request – Missing or invalid parameters
  • 401 Unauthorized – Authentication failure
  • 404 Not Found – Resource not found
  • 500 Internal Server Error – Unexpected server error

📞 Support

For technical support, contact the integration services team:

Integration Services and Applications Coordination

📧 epalma@fgs.co

📅 Notes

Reviews