API Names in Salesforce

 In Salesforce, an API Name is a unique identifier for metadata components like fields, objects, or custom settings that enables external systems, scripts, and integrations to reference Salesforce data programmatically. The API name remains consistent, even if the label displayed in the user interface changes, making it essential for maintaining integration stability.

Key Characteristics of API Names

  1. Field and Object API Names:

    • Standard object and field API names generally mirror their label names, but with spaces removed.
    • Custom fields and objects have the suffix __c, denoting them as custom.
      • Example: A custom object called "Project" would have an API name of Project__c.
      • A custom field called "Start Date" on the Project object would have an API name of Start_Date__c.

  2. Case-Sensitivity:

    • API names in Salesforce are case-sensitive, so it’s essential to match them exactly when using them in code or integrations.

  3. Usage:

    • API names are used in SOQL queries, Apex code, integration tools (like REST/SOAP APIs), custom formulas, reports, and any other context where data needs to be programmatically accessed.

  4. Examples of Common API Names:

    • Standard Field: Account.Name (for the Name field on the Account object)
    • Custom Field: Project__c.Start_Date__c
    • Standard Object: Contact, Opportunity
    • Custom Object: Project__c, Expense__c

 Example Usage in SOQL

If you wanted to query a custom field Start_Date__c on a custom object Project__c, your SOQL query would look like this:

SELECT Name, Start_Date__c FROM Project__c WHERE Status__c = 'Active'

Knowing the correct API names is essential for ensuring your SOQL queries, Apex code, and integrations work accurately in Salesforce. Let me know if you’d like to see more examples with API names in specific contexts!

Comments

Post a Comment

Popular posts from this blog

18 - LWC - BEST PRACTICES - For accessing HTML elements and their values in JavaScript

 In Lightning Web Components (LWC) , best practices for accessing HTML elements and their values in JavaScript involve using template.querySelector , template.querySelectorAll , and data-* attributes. Here’s a guide to help you follow these best practices effectively: 1. Use template.querySelector and template.querySelectorAll Since IDs can be unpredictable in LWC , the template.querySelector method is generally preferred. You can use CSS selectors , including class names, tag names, and data-* attributes, to locate elements. html Copy code <!-- template.html --> < lightning-input class = "my-input" data-id = "specialInput" value = "Sample Value" > </ lightning-input > javascript Copy code // component.js // Accessing the element const inputElement = this . template . querySelector ( '.my-input' ); // Getting the value const inputValue = inputElement. value ; 2. Use data-* Attributes for Specific Identifiers For ele...
Read more

6 - Object Relationships (Lookup and Master-Detail and Junction Objects)

 Here's a tabular comparison of the Lookup and Master-Detail relationship types in Salesforce: Feature Lookup Relationship Master-Detail Relationship Definition and Usage Loosely coupled; records are linked but can exist independently Tightly coupled; child record depends on the parent for existence Data Integrity and Ownership Child record does not inherit parent’s sharing or ownership Child inherits sharing, permissions, and ownership from the parent Roll-up Summary Fields Not available Available; aggregates values from child to parent Required Field Optional; child can exist without a parent Required; child must have a parent Cascade Delete Optional (not automatic) Automatic; deleting parent deletes all related child records Security and Access Child has independent sharing settings Child inherits sharing settings from the parent Hierarchy Depth Flexible; supports multi-level relationships Limited to strict parent-child hierarchy with up to two relationships This structure pro...
Read more