--- schema_version: "1" id: 988b72920a4d0377482ed0181f1d4e2bf33590255fbc54b853cff97b34e8354b title: Id Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_methods_system_id.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm source_site: developer.salesforce.com content_type: documentation content_hash: 2cc33d57767bcaaabf57a3bde4d9f1ef5d23c14cd792b3cfd976146a93ea9b93 description: Contains methods for the ID primitive data type.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Marks a trigger record with a custom error message, specifies if the error message should be escaped, and prevents any DML operation from occurring.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Returns the token for the sObject corresponding to this ID. This method is primarily used with describe information.Converts an 18-character Id value to a 15-character case-sensitive string.Converts the specified String into an ID and returns the ID.Converts the specified string into an ID and returns the ID. If restoreCasing is true, and the string represents an 18-character ID that has incorrect casing, the method returns an 18-character ID that is correctly aligned with its encoded casing. --- # Id Class Contains methods for the ID primitive data type. ## Namespace [System](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_System.htm "The System namespace provides classes and methods for core Apex functionality.") ## Example: Getting an sObject Token From an ID This sample shows how to use the getSObjectType method to obtain an sObject token from an ID. The updateOwner method in this sample accepts a list of IDs of the sObjects to update the ownerId field of. This list contains IDs of sObjects of the same type. The second parameter is the new owner ID. Note that since it is a future method, it doesn’t accept sObject types as parameters; this is why it accepts IDs of sObjects. This method gets the sObject token from the first ID in the list, then does a describe to obtain the object name and constructs a query dynamicallly. It then queries for all sObjects and updates their owner ID fields to the new owner ID. public with sharing class MyDynamicSolution { @Future public static void updateOwner(List objIds, ID newOwnerId) { // Validate input Assert.isNotNull(objIds); Assert.isTrue(objIds.size() > 0); Assert.isNotNull(newOwnerId); // Get the sObject token from the first ID // (the List contains IDs of sObjects of the same type). Schema.SObjectType token = objIds\[0\].getSObjectType(); // Using the token, do a describe // and construct a query dynamically. Schema.DescribeSObjectResult dr = token.getDescribe(); String queryString = 'SELECT ownerId FROM ' + dr.getName() + ' WHERE '; for(ID objId : objIds) { queryString += 'Id=\\'' + objId + '\\' OR '; } // Remove the last ' OR' queryString = queryString.subString(0, queryString.length() - 4); sObject\[\] objDBList = Database.query(queryString, AccessLevel.USER\_MODE); Assert.isTrue(objDBList.size() > 0); // Update the owner ID on the sObjects for(Integer i=0;i, &, ", \\, \\u2028, \\u2029, and \\u00a9. As a result, HTML markup is not rendered; instead, it is displayed as text in the Salesforce user interface. #### Example Trigger.new\[0\].Id.addError('bad'); ### addError(errorMsg, escape) Marks a trigger record with a custom error message, specifies if the error message should be escaped, and prevents any DML operation from occurring. #### Signature public Void addError(String errorMsg, Boolean escape) #### Parameters - **errorMsg**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The error message to mark the record with. - **escape**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") Indicates whether any HTML markup in the custom error message should be escaped (true) or not (false). This parameter is ignored in both Lightning Experience and the Salesforce mobile app, and the HTML is always escaped. The escape parameter only applies in Salesforce Classic. #### Return Value Type: Void #### Usage The escaped characters are: \\n, <, \>, &, ", \\, \\u2028, \\u2029, and \\u00a9. As a result, HTML markup is not rendered; instead, it is displayed as text in the Salesforce user interface. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note_warning.png) #### Warning Be cautious if you specify false for the escape argument. Unescaped strings displayed in the Salesforce user interface can represent a vulnerability in the system because these strings might contain harmful code. If you want to include HTML markup in the error message, call this method with a false _escape_ argument. Make sure that you escape any dynamic content, such as input field values. Otherwise, specify true for the _escape_ argument or call [addError(String errorMsg)](#apex_System_Id_addError "Marks a trigger record with a custom error message and prevents any DML operation from occurring.") instead. #### Example Trigger.new\[0\].Id.addError('Fix & resubmit', false); ### addError(exceptionError) Marks a trigger record with a custom error message and prevents any DML operation from occurring. #### Signature public Void addError(Exception exceptionError) #### Parameters - **exceptionError**: Type: [System.Exception](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_classes_exception_methods.htm "An exception denotes an error that disrupts the normal flow of code execution. You can use Apex built-in exceptions or create custom exceptions. All exceptions have common methods.") An Exception object or a custom exception object that contains the error message to mark the record with. #### Return Value Type: Void #### Usage This method is similar to the [addError(exceptionError)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_System_SObject_addError_3 "Marks a trigger record with a custom error message and prevents any DML operation from occurring.") sObject method. This method escapes any HTML markup in the specified error message. The escaped characters are: \\n, <, \>, &, ", \\, \\u2028, \\u2029, and \\u00a9. As a result, HTML markup is not rendered; instead, it is displayed as text in the Salesforce user interface. #### Example public with sharing class MyException extends Exception{} This trigger marks the first record in Trigger.new with the exception. trigger AddErrorExample on Account (before insert) { Trigger.new\[0\].Id.addError(new MyException('Invalid Id')); } ### addError(exceptionError, escape) Marks a trigger record with a custom error message and prevents any DML operation from occurring. #### Signature public Void addError(Exception exceptionError, Boolean escape) #### Parameters - **exceptionError**: Type: [System.Exception](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_classes_exception_methods.htm "An exception denotes an error that disrupts the normal flow of code execution. You can use Apex built-in exceptions or create custom exceptions. All exceptions have common methods.") An Exception object or a custom exception object that contains the error message to mark the record with. - **escape**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") Indicates whether any HTML markup in the custom error message should be escaped (true) or not (false). This parameter is ignored in both Lightning Experience and the Salesforce mobile app, and the HTML is always escaped. The escape parameter only applies in Salesforce Classic. #### Return Value Type: Void #### Usage The escaped characters are: \\n, <, \>, &, ", \\, \\u2028, \\u2029, and \\u00a9. As a result, HTML markup is not rendered; instead, it is displayed as text in the Salesforce user interface. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note_warning.png) #### Warning Be cautious if you specify false for the escape argument. Unescaped strings displayed in the Salesforce user interface can represent a vulnerability in the system because these strings might contain harmful code. If you want to include HTML markup in the error message, call this method with a false _escape_ argument. Make sure that you escape any dynamic content, such as input field values. Otherwise, specify true for the _escape_ argument or call [addError(Exception e)](#apex_System_Id_addError_3 "Marks a trigger record with a custom error message and prevents any DML operation from occurring.") instead. #### Example public with sharing class MyException extends Exception{} This trigger marks the first record in Trigger.new with an unescaped exception. trigger AddErrorIdEscapeExample on Account (before insert) { Trigger.new\[0\].Id.addError(new MyException('Invalid Id & other issues'), false); } ### getSObjectType() Returns the token for the sObject corresponding to this ID. This method is primarily used with describe information. #### Signature public Schema.SObjectType getSObjectType() #### Return Value Type: [Schema.SObjectType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Schema_SObjectType.htm#apex_class_Schema_SObjectType "A Schema.sObjectType object is returned from the field describe result using the getReferenceTo method, or from the sObject describe result using the getSObjectType method.") #### Usage For more information about describes, see [Understanding Apex Describe Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_dynamic_describe_objects_understanding.htm). #### Example account a = new account(name = 'account'); insert as user a; Id myId = a.id; Assert.areEqual(Schema.Account.SObjectType, myId.getSobjectType()); ### to15() Converts an 18-character Id value to a 15-character case-sensitive string. #### Signature public static string to15() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Example String Id\_15\_char = '0D5B000001DVM9t'; String Id\_18\_char = '0D5B000001DVM9tkAh'; ID testId = Id\_18\_char; Assert.areEqual(testId.to15(),Id\_15\_char); ### valueOf(toID) Converts the specified String into an ID and returns the ID. #### Signature public static ID valueOf(String toID) #### Parameters - **toID**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: [ID](#apex_methods_system_id "Contains methods for the ID primitive data type.") #### Example Id myId = Id.valueOf('001xa000003DIlo'); #### Versioned Behavior Changes In API version 54.0 and later, assignment of an invalid 15 or 18 character ID to a variable results in a System.StringException exception. ### valueOf(str, restoreCasing) Converts the specified string into an ID and returns the ID. If restoreCasing is true, and the string represents an 18-character ID that has incorrect casing, the method returns an 18-character ID that is correctly aligned with its encoded casing. #### Signature public static Id valueOf(String str, Boolean restoreCasing) #### Parameters - **str**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") String to be converted to an ID - **restoreCasing**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") If set to true, and str represents an 18-character ID, the method returns an 18-character ID that is correctly aligned with its casing. #### Return Value Type: [Id](#apex_methods_system_id "Contains methods for the ID primitive data type.") The return value depends on both the str and the restoreCasing parameter values. ![Note](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note.png) #### Note If the str is invalid, the method throws a System.StringException exception. | Parameters | restoreCasing=true | restoreCasing=false | | --- | --- | --- | | Valid 15-character str value | Because the 15-character input value can’t be encoded for casing, the method throws a System.StringException. | The method returns a 15-character ID. | | Valid 18-character str value | The method returns an 18-character ID that is correctly aligned with its encoded casing. | The method doesn’t attempt to correctly align the casing of the 18-character ID and returns an 18-character ID. |