TMF629 v4 Customer Management API (Extensible)

For the TMF629 API, extensibility is enabled through Apex lifecycle hooks and customizable GraphQL queries, allowing customers to adjust request and response payloads without compromising TMF compliance. Pre-hooks validate or reshape incoming requests, and post-hooks refine or filter responses across all operations such as GET, POST, PATCH, and DELETE.

Extend the main entity with additional fields
Map a field from a different or related entity
Customize WHERE clauses at the main entity level
Customize WHERE clauses at the sub-resource level
Apply sorting (ORDER BY) on main and sub-resource results

For access methods, prerequisites, and using the API, see TMF629 v4 Customer Management API (Non-Extensible).

Important

Assumptions

The customer or integrator implements the pre-hook and post-hook Apex classes and customizes the GraphQL queries based on the provided interfaces and hooks.

Interfaces and Hooks

The following table lists interfaces and corresponding lifecycle hooks supported for customizing the TMF629 operations.

Interface Name	Hooks Supported	Pre-processing Capabilities	GraphQL / Payload Customization	Post-processing Capabilities
ICustomerManagementGET	`transformRequest` `applyCustomValidations` `customiseGraphQLQuery` `handlePostOperation`	Validate permissions, enforce access rules, apply business validations	Modify GraphQL query fields, filters, transformations	Refine or enrich API responses
ICustomerManagementPOST	`transformRequest` `applyCustomValidations` `customiseMutationPayload` `handlePostOperation`	Validate creation input and business rules	Enrich creation payload with additional fields, metadata, or related entities	Adjust final POST response after persistence
ICustomerManagementPATCH	`transformRequest` `applyCustomValidations` `customiseMutationPayload` `handlePostOperation`	Validate update payloads, enforce conditional rules	Modify or enrich mutation payload before update	Refine response after patch operation
ICustomerManagementDELETE	`transformRequest` `applyCustomValidations` `customiseMutationPayload` `handlePostOperation`	Validate delete permissions, enforce dependency and integrity checks	Add deletion metadata, apply soft-delete logic, archive records	Perform cleanup, logging, or response adjustments