---
schema_version: "1"
id: b3631dd48f8a5d194cbcec1beb9288f25f08bf5d42ca7ed8ddeb158c9cc121ca
title: IOrganizationPartyManagementGET Apex Interface
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/comms/guides/Extensibility/TMF632/IOrganizationPartyManagementGET.md
canonical_url: https://developer.salesforce.com/docs/industries/communications/guide/IOrganizationPartyManagementGET.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: f989476d4ecafff3f4125068e069faaca054ad1391cb4ca9d0fbc0d286850b19
products:
- Communications Cloud TM Forum API
- Industries Integrations
---
# IOrganizationPartyManagementGET Apex Interface
The `IOrganizationPartyManagementGET` Apex interface provides extensibility for 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)
- [configureDefaultValidations](#configuredefaultvalidations)
- [applyCustomValidations](#applycustomvalidations)
- [customiseGraphQLQuery](#customisegraphqlquery)
- [handlePostOperation](#handlepostoperation)
## Retrieve Operation Use Cases
| **Use Case** | **Hook(s)** | **Description** | **Example Scenarios** | **Benefit** |
| -------------------------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **External-ID Resolution** | `transformRequest` | Transforms a legacy or external identifier into the canonical resource ID expected by the retrieve operation and adds it to the shared request context as `{ id }`. | - Resolve a legacy customer key to a Contact ID - Map a partner-system identifier to `{ id }` - Normalize identifiers from migrated systems - Translate an account-specific reference into the canonical ID | Allows legacy clients and external integrations to retrieve resources using familiar identifiers without changing the shared API contract. |
| **Role-Based or Regional Access Control** | `applyCustomValidations` | Applies authorization and data-governance rules before the query executes. Access can be evaluated using the caller's role, region, business unit, channel, or other request context. | - Restrict access to customers outside the user's assigned region - Permit only supervisors to retrieve high-value customer records - Block partner channels from accessing internal-only resources - Enforce business-unit data boundaries | Enforces data-governance policies and prevents unauthorized access to protected records. |
| **Toggle or Add Validation Flags** | `configureDefaultValidations` | Enables, disables, or extends built-in validation flags for retrieve requests according to organization-specific policies. | - Require record-existence validation - Enable stricter identifier validation - Disable checks that do not apply to trusted internal channels - Apply different validation policies by tenant or environment | Allows each organization to relax or tighten retrieval checks without modifying the shared implementation. |
| **Add Custom Fields or Server-Side Filters** | `customiseGraphQLQuery` | Modifies the GraphQL query before execution by adding custom fields, relationships, filters, or server-side constraints. | - Add organization-specific Contact fields - Include entitlement or customer-hierarchy data - Apply regional, tenant, or lifecycle-status filters - Request a reduced field set for mobile clients | Returns richer, client-specific data without changing the base schema or introducing additional API versions. |
| **Response Enrichment** | `handlePostOperation` | Processes the query result before it is returned to the client. It can add calculated values, derived fields, audit metadata, or information from related systems. | - Add a calculated customer health score - Include retrieval audit metadata - Flag preferred or high-risk customers - Add aggregated financial, service, or usage insights | Delivers derived fields and audit metadata while preserving the underlying API schema. |
## 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
Resolve an external ID to a Salesforce Contact ID.
```
global class OrganizationGetTransformRequestExt implements comms_apex_ext.IOrganizationPartyManagementGET {
global static Map transformRequest(Map context) {
if (context == null) {
return context;
}
Object idObj = context.get('id');
if (!(idObj instanceof String)) {
return context;
}
String idValue = (String) idObj;
// A 15- or 18-character value already looks like a Salesforce Id; leave it as-is.
if (idValue.length() == 15 || idValue.length() == 18) {
return context;
}
// Otherwise treat it as an external key and resolve it to an Account Id.
List accounts = [
SELECT Id FROM Account WHERE External_Id__c = :idValue LIMIT 1
];
if (!accounts.isEmpty()) {
context.put('id', accounts[0].Id);
}
return context;
}
// ... other hooks return null / empty map ...
}
```
## configureDefaultValidations
This hook enables, disables, or modifies the built-in validation rules before they execute.
## Hook Method
`Map configureDefaultValidations(Map defaultValidationConfiguration, Map context)`
## Sample Apex Implementation
Add a custom flag consumed by applyCustomValidations.
```
global class OrganizationGetConfigValidationsExt implements comms_apex_ext.IOrganizationPartyManagementGET {
global static Map configureDefaultValidations(
Map defaultValidationConfiguration,
Map context
) {
Map overrides = defaultValidationConfiguration != null
? defaultValidationConfiguration.clone()
: new Map();
overrides.put('segmentAccessCheck', true); // your own flag, read in applyCustomValidations
return overrides;
}
// ... other hooks return null / empty map ...
}
```
## 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
Role-based/regional access control.
```
global class OrganizationGetRbacExt implements comms_apex_ext.IOrganizationPartyManagementGET {
global static Map applyCustomValidations(Map context) {
String organizationId = (String) context.get('id');
Map result = new Map();
try {
User currentUser = [SELECT Id, Profile.Name FROM User WHERE Id = :UserInfo.getUserId() LIMIT 1];
if ('Customer Service Rep'.equals(currentUser.Profile.Name) && organizationId != null) {
Account a = [SELECT Id, BillingCountry FROM Account WHERE Id = :organizationId LIMIT 1];
if (!'US'.equals(a.BillingCountry)) {
result.put('validationStatus', 'fail');
result.put('validationMessage', 'User does not have access to organizations in this region');
result.put('validationDetails', new Map{
'statusCode' => 'BAD_REQUEST',
'errorCode' => 'REGION_RESTRICTION'
});
}
}
} catch (Exception e) {
result.put('validationStatus', 'fail');
result.put('validationMessage', 'Validation error: ' + e.getMessage());
}
return result; // empty => proceed; validationStatus="fail" => HTTP 400
}
// ... other hooks return null / empty map ...
}
```
## customiseGraphQLQuery
This hook modifies the GraphQL query before execution to add fields, filters, or transformations.
## Hook Method
`Map customiseGraphQLQuery(Map graphQLAsMap, Map context)`
## Sample Apex Implementation
Add custom fields and a filter: For the Organization GET, target the `organizationData`, which represents the Account node.
```
global class OrganizationGetCustomGraphQLExt implements comms_apex_ext.IOrganizationPartyManagementGET {
global static Map customiseGraphQLQuery(
Map graphQLAsMap,
Map context
) {
List> nodes = new List>();
// Add custom Account fields.
nodes.add(new Map{
'path' => 'organizationData',
'addFields' => new List{ 'Industry', 'AnnualRevenue' }
});
// Only return active accounts (append to any existing WHERE clause).
nodes.add(new Map{
'path' => 'organizationData',
'addFilters' => new Map{
'clearExistingFilters' => false,
'filterGraphQlSnippet' => '{ Active__c: { eq: true } }'
}
});
return new Map{ 'nodes' => nodes };
}
// ... other hooks return null / empty map ...
}
```
## 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
Enrich the response in place.
```
global class OrganizationGetEnrichExt implements comms_apex_ext.IOrganizationPartyManagementGET {
global static Map handlePostOperation(
Map graphQLQueryResultAsMap,
Map constructedTMFResponse,
Map context
) {
if (constructedTMFResponse != null) {
constructedTMFResponse.put('retrievedBy', UserInfo.getName());
constructedTMFResponse.put('lastRetrievedAt',
DateTime.now().format('yyyy-MM-dd\'T\'HH:mm:ss\'Z\''));
}
// Returning null keeps the mutated constructedTMFResponse as the final payload.
return null;
}
// ... other hooks return null / empty map ...
}
```
## Full Implementation Example
Here's a complete sample Apex implementation using all supported hooks.
```
/**
* Complete TMF632 Organization (Party Management) GET API extension,
* demonstrating all five lifecycle hooks with business logic.
*/
global class OrganizationPartyManagementGETExtension implements comms_apex_ext.IOrganizationPartyManagementGET {
// Hook 1: normalize / resolve the request context.
global static Map transformRequest(Map context) {
if (context != null) {
context.put('transformedBy', 'apex');
}
return context;
}
// Hook 2: keep default validations unchanged (GET has none).
global static Map configureDefaultValidations(
Map defaultValidationConfiguration,
Map context
) {
return new Map();
}
// Hook 3: block requests for disallowed fields.
global static Map applyCustomValidations(Map context) {
if (context != null && context.get('fields') instanceof List