3555323 - Naming convention for defining "fieldId" in custom or background fields referenced in Application or Candidate templates - Recruiting Management

To ensure consistency and improve compatibility across APIs, we aim to establish a unified naming convention for defining fieldId in custom or background fields referenced in Application or Candidate templates. 

Following these conventions will help maintain API stability and guarantee seamless functionality.

SAP SuccessFactors Recruiting Management 

Recommended Naming Convention:

The camelCase format (either lowerCamelCase or UpperCamelCase) is the preferred naming convention for fieldId definitions.

 Example:

• lowerCamelCase: firstName
• UpperCamelCase: FirstName

Guidelines:

These naming conventions are strongly recommended for newly developed APIs.

Consistency and adherence to existing conventions within an API suite for a single product are critical to ensuring API stability and compatibility.

Avoid using other naming conventions such as:

• lowercase (e.g., firstname)
• lowercase-dashed (e.g., first-name)
• lowercase_underscore (e.g., first_name)
• UPPERCASE_Underscore (e.g., FIRST_NAME)

Impact of Non-Compliance:

Using naming conventions that deviate from the recommended camelCase format (e.g., fields with underscores, hyphens, or other special characters) can lead to unexpected or erroneous results in REST API responses.

For instance: Invalid examples:

• first_name
• FIRST_NAME
• First_Name
• first-name 

Naming convention, fieldId, field definition, API, Application template, Candidate templates,  , KBA , LOD-SF-RCM-API , Webservices & APIs , LOD-SF-RCM-CAN , General Candidate Issues (not Offers, not Profiles) , LOD-SF-RCM-APP , Applicants and Job Applications , How To