Skip to content

ApiIssue__c

Sobject

apex
global class ApiIssue__c extends SObject

Extends: SObject

Tracks API integration issues for troubleshooting, manual resolution, and automatic retry of failed service calls. Each record captures the error details, request parameters, and links to the originating API call.


Fields

FieldDescription
global Id ApiCall__cLookup to the API Call record that produced this issue.
global ApiCall__c ApiCall__rLookup to the API Call record that produced this issue.
global String Direction__cIndicates whether this issue originated from an inbound or outbound API call.
global String ErrorMessages__cError messages encountered during API call processing.
global String IdempotencyKey__cPreserves the idempotency key from the failed API call.
global String OriginatingRecordId__cThe Salesforce record ID of the originating record associated with this API issue, when different from the triggering record.
global String RequestBody__cThe inbound request body content.
global String RequestMethod__cThe HTTP method of the inbound request (GET, POST, etc.).
global String RequestParameters__cName-value pairs of the request parameters passed to the API service when the call was made.
global String RequestParametersHash__cHash of the request parameters, used to identify duplicate requests and support deduplication during retry processing.
global String RequestPath__cThe inbound request URI path.
global Datetime ResolvedDate__cThe date and time when this failure was resolved, either through replay or manual resolution.
global String ServiceName__cThe fully qualified Apex class name of the API service handler that produced this issue (e.g.
global String Status__cCurrent status: Open (awaiting investigation or resolution) or Resolved (resolved by automatic retry batch job or manual retry via quick action).
global String TriggeringRecordId__cThe 18-character Salesforce record ID that initiated the original API call.

Field Details

ApiCall__c

apex
global Id ApiCall__c

Lookup to the API Call record that produced this issue. Provides access to the full request/response details and processing history.

Field Attributes:

AttributeValue
Data TypeApiCall__c
Requiredfalse

ApiCall__r

apex
global ApiCall__c ApiCall__r

Lookup to the API Call record that produced this issue. Provides access to the full request/response details and processing history.

Field Attributes:

AttributeValue
Data TypeApiCall__c
Requiredfalse

Direction__c

apex
global String Direction__c

Indicates whether this issue originated from an inbound or outbound API call.

Field Attributes:

AttributeValue
Data TypePicklist
Requiredfalse

Picklist Values:

API NameLabelActive
OutboundOutboundYes
InboundInboundNo

ErrorMessages__c

apex
global String ErrorMessages__c

Error messages encountered during API call processing. May contain multiple messages separated by line breaks.

Field Attributes:

AttributeValue
Data TypeLong Text Area(131072)

IdempotencyKey__c

apex
global String IdempotencyKey__c

Preserves the idempotency key from the failed API call. When retried, this key is copied to the new API call so the external system treats the retry as a repeat of the original request.

Field Attributes:

AttributeValue
Data TypeText(255)
Requiredfalse
Uniquefalse
External IDfalse

OriginatingRecordId__c

apex
global String OriginatingRecordId__c

The Salesforce record ID of the originating record associated with this API issue, when different from the triggering record.

Field Attributes:

AttributeValue
Data TypeText(18)
Requiredfalse
Uniquefalse
External IDfalse

RequestBody__c

apex
global String RequestBody__c

The inbound request body content. Captured for failure replay functionality. Truncated to 131072 characters.

Field Attributes:

AttributeValue
Data TypeLong Text Area(131072)

RequestMethod__c

apex
global String RequestMethod__c

The HTTP method of the inbound request (GET, POST, etc.). Captured for failure replay.

Field Attributes:

AttributeValue
Data TypeText(10)
Requiredfalse
Uniquefalse
External IDfalse

RequestParameters__c

apex
global String RequestParameters__c

Name-value pairs of the request parameters passed to the API service when the call was made. Preserved from the original queue record for retry purposes.

Field Attributes:

AttributeValue
Data TypeLong Text Area(131072)

RequestParametersHash__c

apex
global String RequestParametersHash__c

Hash of the request parameters, used to identify duplicate requests and support deduplication during retry processing.

Field Attributes:

AttributeValue
Data TypeText(50)
Requiredfalse
Uniquefalse
External IDfalse

RequestPath__c

apex
global String RequestPath__c

The inbound request URI path. Captured for failure replay functionality.

Field Attributes:

AttributeValue
Data TypeText(255)
Requiredfalse
Uniquefalse
External IDfalse

ResolvedDate__c

apex
global Datetime ResolvedDate__c

The date and time when this failure was resolved, either through replay or manual resolution.

Field Attributes:

AttributeValue
Data TypeDate Time
Requiredfalse

ServiceName__c

apex
global String ServiceName__c

The fully qualified Apex class name of the API service handler that produced this issue (e.g. API_SendEmail).

Field Attributes:

AttributeValue
Data TypeText(100)
Requiredfalse
Uniquefalse
External IDfalse

Status__c

apex
global String Status__c

Current status: Open (awaiting investigation or resolution) or Resolved (resolved by automatic retry batch job or manual retry via quick action).

Field Attributes:

AttributeValue
Data TypePicklist
Requiredfalse

Picklist Values:

API NameLabelActive
OpenOpenYes
ResolvedResolvedYes

TriggeringRecordId__c

apex
global String TriggeringRecordId__c

The 18-character Salesforce record ID that initiated the original API call. Use this to trace the failure back to its source record.

Field Attributes:

AttributeValue
Data TypeText(18)
Requiredfalse
Uniquefalse
External IDfalse