---
schema_version: "1"
id: 3c08fc9cd219fbcbe488bc535edb498b49774e3c708aee747d88f195034207c5
title: ICustomerManagementGET Apex Interface
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/comms/guides/Extensibility/ICustomerManagementGET.md
canonical_url: https://developer.salesforce.com/docs/industries/communications/guide/ICustomerManagementGET.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 7e7b195d5aee7355bee74adc2ed43d826a6b1cc7d07fcde5cdeaf6b017b2171f
products:
- Communications Cloud TM Forum API
- Industries Integrations
---
# ICustomerManagementGET Apex Interface
The `ICustomerManagementGET` Apex interface provides extensibility for TMF629 GET operations through Apex pre- and post-hooks and GraphQL query customization. Implementations can validate incoming requests, modify query structures, and refine the response to support business-specific retrieval rules while maintaining TMF-compliant behavior.
This interface supports the following hooks.
- [transformRequest](#transformrequest)
- [applyCustomValidations](#applycustomvalidations)
- [customiseGraphQLQuery](#customisegraphqlquery)
- [handlePostOperation](#handlepostoperation)
**note:** The `configureDefaultValidations` hook is not used for the Customer Management API. If implemented, the method may be invoked, but its return values are ignored.
## Retrieval Lifecycle Use Cases and Hook Mapping
This table lists common use cases and the hooks required for the GET operation.
| **Use Case** | **Hook(s)** | **Description** | **Example Scenarios** | **Benefit** |
| ------------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| **Role-Based Data Filtering** | `applyCustomValidations`, `handlePostOperation` | Enforces access rules by validating user permissions before execution and filtering sensitive data after retrieval. Supports role-based visibility at field and record levels. | • Restrict access to VIP or high-value customer profiles• Hide sensitive fields (e.g., credit score) for frontline agents• Enforce region-based access boundaries | Strengthens data governance and ensures secure, compliant access to customer data |
| **Custom Field Enrichment** | `handlePostOperation` | Adds calculated or derived fields to API responses without changing the base TMF schema, allowing customers to extend or modify as needed. Enables enrichment using internal business rules or external systems. | • Add customer health score• Flag “preferred customer” status• Include aggregated financial or usage insights | Delivers richer, more contextual responses while preserving TMF schema integrity |
| **Dynamic Query Customization** | `customiseGraphQLQuery` | Modifies GraphQL queries dynamically based on client or request context by adding fields, filters, or transformations. | • Mobile app requests only essential fields• Portal requires additional entitlement or hierarchy fields• Apply filters automatically for partner channels | Supports diverse client requirements using a single API and reduces need for API versioning |
| **Business Rule Validation** | `applyCustomValidations` | Applies business and eligibility rules before processing requests, stopping invalid operations early in the lifecycle. | • Ensure customer is “active” before retrieving services• Reject unauthorized or unverified channel requests• Enforce lifecycle or dependency checks | Provides strong business consistency and reduces downstream errors by blocking invalid requests early |
## transformRequest
This hook transforms the request context before processing any operation. It is invoked early in the request lifecycle, allowing implementers to adjust the context for subsequent extensibility hooks.
## Hook Method
`Map transformRequest(Map context)`
## Sample Apex Implementation
```
public Map transformRequest(Map context) {
if (context == null) {
return context;
}
Object idObj = context.get('id');
if (idObj == null || !(idObj instanceof String)) {
return context;
}
String idValue = (String)idObj;
// Check if the ID looks like a Salesforce ID (starts with 001, 003, etc.)
// If not, assume it's an AccountNumber and resolve it
if (idValue.length() == 15 || idValue.length() == 18) {
// Looks like a Salesforce ID, return context as-is
return context;
}
// Query Account objects where AccountNumber matches the provided ID
List accounts = [
SELECT Id, AccountNumber
FROM Account
WHERE AccountNumber = :idValue
LIMIT 1
];
// If found, replace the ID in context with the Salesforce ID
if (!accounts.isEmpty() && accounts[0].AccountNumber != null) {
context.put('id', accounts[0].Id);
}
return context;
}
```
## applyCustomValidations
This hook validates custom business logic before retrieving customer record. If validation fails, it rejects the request and returns an error response.
The handler processes return values as follows.
Success:
- Return a map with validationStatus set to "pass" (case-insensitive).
- The API request continues normally.
- Other fields in the map are logged but not used.
Failure:
- Return a map with validationStatus set to "fail" (case-insensitive).
- The API request is terminated immediately.
- Raise a ValidationException containing
- message: value from validationMessage key (or "Validation failed" by default)
- details: value from validationDetails key (optional)
- The client receives an HTTP 400 error response.
## Hook Method
`Map applyCustomValidations(Map context)`
## Sample Apex Implementation
```
public Map applyCustomValidations(Map context) {
// Input context:
// {
// api: 'CustomerManagement',
// version: '4.0',
// customerId: '001xx000003DHP',
// userId: '005xx000001Sv5',
// requiredFields: ['Id', 'Name']
// }
String customerId = (String) context.get('customerId');
String userId = (String) context.get('userId');
Map validationResult = new Map();
try {
// Check if user has access to this customer
User currentUser = [SELECT Id, Profile.Name FROM User WHERE Id = :userId LIMIT 1];
Account customer = [SELECT Id, BillingCountry FROM Account WHERE Id = :customerId LIMIT 1];
if ('Customer Service Rep'.equals(currentUser.Profile.Name)) {
// Validate customer is in allowed region
if ('US'.equals(customer.BillingCountry)) {
// PASS: User has access
validationResult.put('validationStatus', 'PASS');
validationResult.put('validationMessage', 'User has access to this customer');
} else {
// FAIL: User does not have access to this region
validationResult.put('validationStatus', 'FAIL');
validationResult.put('validationMessage', 'User does not have access to customers in this region');
validationResult.put('validationDetails', new Map{
'denialReason' => 'REGION_RESTRICTION',
'userRegion' => 'US',
'customerRegion' => customer.BillingCountry
});
}
} else {
// PASS: Other profiles have unrestricted access
validationResult.put('validationStatus', 'PASS');
validationResult.put('validationMessage', 'User profile has unrestricted access');
}
} catch (Exception e) {
// FAIL: Error during validation
validationResult.put('validationStatus', 'FAIL');
validationResult.put('validationMessage', 'Validation error: ' + e.getMessage());
validationResult.put('validationDetails', new Map{
'errorType' => e.getTypeName()
});
}
// Return validation result directly (not wrapped in 'result' key)
return validationResult;
}
```
## customiseGraphQLQuery
This hook modifies the GraphQL query before execution to add fields, filters, or transformations. Returns a map with a `spec` key containing a list of `QueryTransformationNode` objects.
## Hook Method
`Map customiseGraphQLQuery(Map graphQLAsMap, Map context)`
## Sample Apex Implementation
```
public Map customiseGraphQLQuery(
Map graphQLAsMap,
Map context
) {
// Create transformation specification to add custom fields and filters
List> transformationNodes = new List>();
// Node 1: Add custom fields to the Account node
// Path: uiapi.query.Account (the Account field in the GraphQL query)
Map addFieldsNode = new Map{
'path' => 'uiapi.query.Account',
'addFields' => new List{'CustomField__c', 'IndustrySegment__c', 'Status'}
};
transformationNodes.add(addFieldsNode);
// Node 2: Add filters to the Account query
// Only retrieve active accounts
Map filterNode = new Map{
'path' => 'uiapi.query.Account',
'addFilters' => new Map{
'clearExistingFilters' => false,
'filterGraphQlSnippet' => '{ Status: { eq: "Active" } }'
}
};
transformationNodes.add(filterNode);
// Return transformation specification
return new Map{
'spec' => transformationNodes
};
}
```
## handlePostOperation
This hook post-processes and transforms the API response after data retrieval.
## Hook Method
`Map handlePostOperation(Map graphQLQueryResultAsMap, Map constructedTMFResponse, Map context)`
## Sample Apex Implementation
```
public Map handlePostOperation(
Map graphQLQueryResultAsMap,
Map constructedTMFResponse,
Map context
) {
// Input GraphQL result:
// {
// items: [{ Id: '001xx000003DHP', Name: 'Acme', AnnualRevenue: 5000000 }],
// count: 1
// }
// Input TMF response:
// {
// customer: [{ id: '001xx000003DHP', name: 'Acme', type: 'Customer' }]
// }
List