Skip Navigation

IntegrationProviderDef

Represents the definition that's applicable to an integration provider. This object is available in API version 57.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field	Details
ApexClassId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The apex class that's associated with the definition. This field is a relationship field. Relationship Name ApexClass Relationship Type Lookup Refers To ApexClass
CanUseInIntegrationOrch	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the integration definition can be used in an integration orchestration (`true`) or not (`false`). The default value is `false`. Available in API version 61.0 and later.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description about the integration provider definition.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The developer name of the integration provider definition.
ExternalServiceOperationName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The external service registration that's associated with the integration provider.
FileBasedApexClass	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the file-based apex class.
InputDataProcessorId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The input data processor that's associated with the integration provider. This field is a relationship field. Relationship Name InputDataProcessor Relationship Type Lookup Refers To OmniIntegrationProcConfig
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the integration provider is active (true) or inactive (false). The default value is `false`.
IsManual	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the integration definition mode is manual (`true`) or automatic (`false`). The default value is `false`. Available in API version 61.0 and later.
IsServiceTypeIntegration	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the integration definition mode is Service Type (True) or Process Type (False). The default value is `false`.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the integration provider definition.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description A unique name of the integration provider definition.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description Namespace prefix associated with this object.
OmniUiCardConfigId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The FlexCard component associated with the integration provider. Available in API version 61.0 and later. This field is a relationship field. Relationship Name OmniUiCardConfig Relationship Type Lookup Refers To OmniUiCardConfig
OutputDataProcessorId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The output data processor that's associated with the integration provider. This field is a relationship field. Relationship Name OutputDataProcessor Relationship Type Lookup Refers To OmniIntegrationProcConfig
StorePayload	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the JSON payload from the request and response must be saved in logs. Valid values are: `DontPersistPayload`—The request and response samples aren’t saved in logs. `PersistPayload`—The request and response samples are saved in logs. The default value is `DontPersistPayload`. Available in API version 61.0 and later.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the type of definition that's defined for an integration provider. Possible values are: `Apex` `LowCode`—Low Code