ApiSetting__mdt
Sobject
global class ApiSetting__mdt extends SObjectExtends: SObject
Configures outbound web service handlers with endpoint paths, retry behavior, circuit breaker settings, and failure logging options.
Fields
| Field | Description |
|---|---|
| global Id ApiCredential__c | The parent object containing the information used by the web service handler to authenticate against the Web Service Endpoint they are calling |
| global ApiCredential__mdt ApiCredential__r | The parent object containing the information used by the web service handler to authenticate against the Web Service Endpoint they are calling |
| global List ApiMocks__r | Reciprocal relationship for ApiMock__mdt.ApiSetting__c. |
| global Id BypassFeatureFlag__c | Optional. |
| global FeatureFlag__mdt BypassFeatureFlag__r | Optional. |
| global Boolean CircuitBreakerEnabled__c | Enable circuit breaker pattern to prevent cascading failures when the external service is down |
| global Decimal CircuitBreakerFailureThreshold__c | Number of consecutive failures before opening the circuit (default: 10 for high tolerance) |
| global Decimal CircuitBreakerSuccessThreshold__c | Number of consecutive successes in half-open state to close the circuit (default: 2) |
| global Decimal CircuitBreakerTimeout__c | Seconds to wait before attempting to close the circuit (default: 60) |
| global String ClassName__c | The fully qualified name of the API handler class |
| global String Direction__c | Indicates whether this API setting applies to inbound requests or outbound calls. |
| global String EndpointPath__c | Relative path for a service call; prefixed by the URL provided either by a Named Credential or the Endpoint URL field |
| global Boolean IdempotencyEnabled__c | Idempotency ensures that processing the same API request multiple times produces the same result as processing it once. |
| global Boolean IsActive__c | Controls whether this API route is active. |
| global Boolean LogIssues__c | When enabled, failed API calls create an ApiIssue__c record for troubleshooting and triage. |
| global Decimal MaxRetryCount__c | Maximum number of retry attempts for failed web service calls. |
| global Boolean MockingEnabled__c | When enabled, the service returns mock responses from associated ApiMock__mdt records instead of executing real logic. |
| global Decimal Priority__c | Routing priority for this API setting. |
| global Id RequiredFeatureFlag__c | Optional. |
| global FeatureFlag__mdt RequiredFeatureFlag__r | Optional. |
| global Boolean ResolveIssues__c | When enabled, allows manual resolution of API issues via the ApiIssue__c object. |
| global Decimal RetryBackoffSeconds__c | The number of seconds to wait between retry attempts when using linear backoff strategy. |
| global Boolean RetryIssues__c | When enabled, allows automatic retry of API issues via batch processing. |
Field Details
ApiCredential__c
global Id ApiCredential__cThe parent object containing the information used by the web service handler to authenticate against the Web Service Endpoint they are calling
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | ApiCredential__mdt |
| Required | false |
| Unique | false |
ApiCredential__r
global ApiCredential__mdt ApiCredential__rThe parent object containing the information used by the web service handler to authenticate against the Web Service Endpoint they are calling
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | ApiCredential__mdt |
| Required | false |
| Unique | false |
ApiMocks__r
global List<ApiMock__mdt> ApiMocks__rReciprocal relationship for ApiMock__mdt.ApiSetting__c .
BypassFeatureFlag__c
global Id BypassFeatureFlag__cOptional. The service is SKIPPED when the Feature Flag is enabled.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | FeatureFlag__mdt |
| Required | false |
| Unique | false |
BypassFeatureFlag__r
global FeatureFlag__mdt BypassFeatureFlag__rOptional. The service is SKIPPED when the Feature Flag is enabled.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | FeatureFlag__mdt |
| Required | false |
| Unique | false |
CircuitBreakerEnabled__c
global Boolean CircuitBreakerEnabled__cEnable circuit breaker pattern to prevent cascading failures when the external service is down
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Checkbox |
| Default Value | false |
CircuitBreakerFailureThreshold__c
global Decimal CircuitBreakerFailureThreshold__cNumber of consecutive failures before opening the circuit (default: 10 for high tolerance)
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Number(3,0) |
| Required | false |
| Unique | false |
| External ID | false |
CircuitBreakerSuccessThreshold__c
global Decimal CircuitBreakerSuccessThreshold__cNumber of consecutive successes in half-open state to close the circuit (default: 2)
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Number(2,0) |
| Required | false |
| Unique | false |
| External ID | false |
CircuitBreakerTimeout__c
global Decimal CircuitBreakerTimeout__cSeconds to wait before attempting to close the circuit (default: 60)
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Number(5,0) |
| Required | false |
| Unique | false |
| External ID | false |
ClassName__c
global String ClassName__cThe fully qualified name of the API handler class
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Text(100), case-insensitive |
| Required | false |
| Unique | true |
| External ID | false |
Direction__c
global String Direction__cIndicates whether this API setting applies to inbound requests or outbound calls.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Picklist |
| Required | false |
Picklist Values:
| API Name | Label | Active |
|---|---|---|
Outbound | Outbound | Yes |
Inbound | Inbound | No |
EndpointPath__c
global String EndpointPath__cRelative path for a service call; prefixed by the URL provided either by a Named Credential or the Endpoint URL field
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Text(255) |
| Required | false |
| Unique | false |
| External ID | false |
IdempotencyEnabled__c
global Boolean IdempotencyEnabled__cIdempotency ensures that processing the same API request multiple times produces the same result as processing it once. When enabled: Inbound — the framework checks for a duplicate Idempotency-Key header and returns the cached response without re-execution. Outbound — a UUID key is auto-generated and sent as a header so the receiving system can detect retries.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Checkbox |
| Default Value | false |
IsActive__c
global Boolean IsActive__cControls whether this API route is active. Inactive routes are skipped during request routing.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Checkbox |
| Default Value | true |
LogIssues__c
global Boolean LogIssues__cWhen enabled, failed API calls create an ApiIssue__c record for troubleshooting and triage.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Checkbox |
| Default Value | false |
MaxRetryCount__c
global Decimal MaxRetryCount__cMaximum number of retry attempts for failed web service calls. Set to 0 to disable retries. Works with Retry Backoff Seconds to control retry behavior.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Number(2,0) |
| Required | false |
| Unique | false |
| External ID | false |
MockingEnabled__c
global Boolean MockingEnabled__cWhen enabled, the service returns mock responses from associated ApiMock__mdt records instead of executing real logic.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Checkbox |
| Default Value | false |
Priority__c
global Decimal Priority__cRouting priority for this API setting. Lower values indicate higher priority. Used to resolve conflicts when multiple routes match.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Number(3,0) |
| Required | false |
| Unique | false |
| External ID | false |
| Default Value | 100 |
RequiredFeatureFlag__c
global Id RequiredFeatureFlag__cOptional. The service is aborted when the Feature Flag is not enabled.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | FeatureFlag__mdt |
| Required | false |
| Unique | false |
RequiredFeatureFlag__r
global FeatureFlag__mdt RequiredFeatureFlag__rOptional. The service is aborted when the Feature Flag is not enabled.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | FeatureFlag__mdt |
| Required | false |
| Unique | false |
ResolveIssues__c
global Boolean ResolveIssues__cWhen enabled, allows manual resolution of API issues via the ApiIssue__c object.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Checkbox |
| Default Value | false |
RetryBackoffSeconds__c
global Decimal RetryBackoffSeconds__cThe number of seconds to wait between retry attempts when using linear backoff strategy. Works with Max Retry Count to control retry timing.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Number(3,0) |
| Required | false |
| Unique | false |
| External ID | false |
RetryIssues__c
global Boolean RetryIssues__cWhen enabled, allows automatic retry of API issues via batch processing.
Field Attributes:
| Attribute | Value |
|---|---|
| Data Type | Checkbox |
| Default Value | false |