BFF API - SOM GUI API Specification

Endpoints

Dynamic Mapper API

Overview

The Dynamic Mapper API provides operations for managing dynamic parameter mappings within different domains. It allows users to retrieve, create, update, and delete dynamic parameters, enabling flexible data management.

Get Dynamic Mapper Domains

GET /dynamicMappers

• Description: Retrieves a list of available dynamic mapper domains.
• Authentication: Required (Bearer Token)
• Responses:
  • 200 OK: Returns a list of dynamic mapper domains.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Dynamic Parameters

GET /dynamicMappers/{domain}/dynamicParameters

• Description: Retrieves a paginated list of dynamic parameters for a specific domain.
• Authentication: Required (Bearer Token)
• Parameters:
  • domain (path, required): The domain name.
  • category (query, optional): Filter by category.
  • key (query, optional): Filter by key.
  • source (query, optional): Filter by source.
  • value (query, optional): Filter by value.
• Responses:
  • 200 OK: Returns a list of dynamic parameters with metadata.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Domain not found.
  • 500 Internal Server Error: Unexpected server error.

Add Dynamic Parameter

POST /dynamicMappers/{domain}/dynamicParameters

• Description: Creates a new dynamic parameter within the specified domain.
• Authentication: Required (Bearer Token)
• Parameters:
  • domain (path, required): The domain name.
• Request Body:
  • category (string, required): Category of the parameter.
  • key (string, required): Parameter key.
  • source (string, optional): Source information.
  • value (string, required): Value of the parameter.
  • condition (string, optional): Condition for parameter use.
  • isDynamic (boolean, optional, default: false): Indicates whether the parameter is dynamic.
• Responses:
  • 201 Created: Returns the newly created dynamic parameter.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Update Dynamic Parameter

PUT /dynamicMappers/{domain}/dynamicParameters/{id}

• Description: Updates an existing dynamic parameter within a specific domain.
• Authentication: Required (Bearer Token)
• Parameters:
  • domain (path, required): The domain name.
  • id (path, required): The parameter ID.
• Request Body:
  • category (string, required): Category of the parameter.
  • key (string, required): Parameter key.
  • source (string, optional): Source information.
  • value (string, required): Value of the parameter.
  • condition (string, optional): Condition for parameter use.
  • isDynamic (boolean, optional, default: false): Indicates whether the parameter is dynamic.
• Responses:
  • 200 OK: Returns the updated parameter.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Parameter not found.
  • 500 Internal Server Error: Unexpected server error.

Delete Dynamic Parameter

DELETE /dynamicMappers/{domain}/dynamicParameters/{id}

• Description: Deletes a specific dynamic parameter within a domain.
• Authentication: Required (Bearer Token)
• Parameters:
  • domain (path, required): The domain name.
  • id (path, required): The parameter ID.
• Responses:
  • 204 No Content: Parameter deleted successfully.
  • 400 Bad Request: Invalid request.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Parameter not found.
  • 500 Internal Server Error: Unexpected server error.