--- schema_version: "1" id: 2edfd69866cdc68ba73bc51a07c374426cef45bdb5128113c0dc5a2467552063 title: ProcessSubmitRequest Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_ProcessSubmitRequest.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm source_site: developer.salesforce.com content_type: documentation content_hash: d4962473e7de8045ff196303a408a307ecb01c24876130a3e367cdf4a125bb37 description: Use the ProcessSubmitRequest class to submit a record for approval.Returns the ID of the record that has been submitted for approval. For example, it can return an account, contact, or custom object record.Returns the developer name or ID of the process definition. If getProcessDefinitionNameOrId() returns a value other than null, getSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false).Returns the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup.Sets the ID of the record to be submitted for approval. For example, it can specify an account, contact, or custom object record.Sets the developer name or ID of the process definition to be evaluated. If the process definition name or ID is not null, setSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false). Sets the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup. If you don’t set a submitter ID, the process uses the current user as the submitter. --- # ProcessSubmitRequest Class Use the ProcessSubmitRequest class to submit a record for approval. ## Namespace [Approval](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_Approval.htm "The Approval namespace provides classes and methods for approval processes.") ## Usage You must specify the Approval namespace when creating an instance of this class. The constructor for this class takes no arguments. For example: Approval.ProcessSubmitRequest psr = new Approval.ProcessSubmitRequest(); ## Inherited Methods In addition to the methods listed, the ProcessSubmitRequest class has access to all the methods in its parent class, [ProcessRequest Class](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessRequest.htm#apex_ProcessRequest "The ProcessRequest class is the parent class for the ProcessSubmitRequest and ProcessWorkitemRequest classes. Use the ProcessRequest class to write generic Apex that can process objects from either class."). - [getComments()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessRequest.htm#apex_Approval_ProcessRequest_getComments "Returns the comments that have been added previously to the approval request.") - [getNextApproverIds()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessRequest.htm#apex_Approval_ProcessRequest_getNextApproverIds "Returns the list of user IDs of user specified as approvers.") - [setComments(comments)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessRequest.htm#apex_Approval_ProcessRequest_setComments "Sets the comments to be added to the approval request.") - [setNextApproverIds(nextApproverIds)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessRequest.htm#apex_Approval_ProcessRequest_setNextApproverIds "If the next step in your approval process is another Apex approval process, you specify exactly one user ID as the next approver. If not, you cannot specify a user ID and this method must be null. This method sets the ActorId field of the associated ProcessInstanceWorkItem.") ## Example To view sample code, refer to [Approval Processing Example](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_process_example.htm). ## ProcessSubmitRequest Methods The following are methods for ProcessSubmitRequest. All are instance methods. - **[getObjectId()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_getObjectId)** Returns the ID of the record that has been submitted for approval. For example, it can return an account, contact, or custom object record. - **[getProcessDefinitionNameOrId()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_getProcessDefinitionNameOrId)** Returns the developer name or ID of the process definition. - **[getSkipEntryCriteria()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_getSkipEntryCriteria)** If getProcessDefinitionNameOrId() returns a value other than null, getSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false). - **[getSubmitterId()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_getSubmitterId)** Returns the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup. - **[setObjectId(recordId)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_setObjectId)** Sets the ID of the record to be submitted for approval. For example, it can specify an account, contact, or custom object record. - **[setProcessDefinitionNameOrId(nameOrId)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_setProcessDefinitionNameOrId)** Sets the developer name or ID of the process definition to be evaluated. - **[setSkipEntryCriteria(skipEntryCriteria)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_setSkipEntryCriteria)** If the process definition name or ID is not null, setSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false). - **[setSubmitterId(userID)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ProcessSubmitRequest.htm#apex_Approval_ProcessSubmitRequest_setSubmitterId)** Sets the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup. If you don’t set a submitter ID, the process uses the current user as the submitter. ### getObjectId() Returns the ID of the record that has been submitted for approval. For example, it can return an account, contact, or custom object record. #### Signature public String getObjectId() #### 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.") ### getProcessDefinitionNameOrId() Returns the developer name or ID of the process definition. #### Signature public String getProcessDefinitionNameOrId() #### 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.") #### Usage The default is null. If the return value is null, when a user submits a record for approval Salesforce evaluates the entry criteria for all processes applicable to the user. ### getSkipEntryCriteria() If getProcessDefinitionNameOrId() returns a value other than null, getSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false). #### Signature public Boolean getSkipEntryCriteria() #### Return Value 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.") ### getSubmitterId() Returns the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup. #### Signature public String getSubmitterId() #### 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.") ### setObjectId(recordId) Sets the ID of the record to be submitted for approval. For example, it can specify an account, contact, or custom object record. #### Signature public Void setObjectId(String recordId) #### Parameters - **recordId**: 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: Void ### setProcessDefinitionNameOrId(nameOrId) Sets the developer name or ID of the process definition to be evaluated. #### Signature public Void setProcessDefinitionNameOrId(String nameOrId) #### Parameters - **nameOrId**: 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 process definition developer name or process definition ID. The record is submitted to this specific process. If set to null, submission of a record approval follows standard evaluation; that is, every entry criteria of the process definition in the process order is evaluated and the one that satisfies is picked and submitted. #### Return Value Type: Void #### Usage If the process definition name or ID is not set via this method, then by default it is null. If it is null, the submission of a record for approval evaluates entry criteria for all processes applicable to the submitter. The order of evaluation is based on the process order of the setup. ### setSkipEntryCriteria(skipEntryCriteria) If the process definition name or ID is not null, setSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false). #### Signature public Void setSkipEntryCriteria(Boolean skipEntryCriteria) #### Parameters - **skipEntryCriteria**: 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, request submission skips the evaluation of entry criteria for the process set in [setProcessDefinitionNameOrId(nameOrId)](#apex_Approval_ProcessSubmitRequest_setProcessDefinitionNameOrId "Sets the developer name or ID of the process definition to be evaluated."). If the process definition name or ID is not specified, this parameter is ignored and standard evaluation is followed based on process order. If set to false, or if this method isn’t called, the entry criteria is not skipped. #### Return Value Type: Void ### setSubmitterId(userID) Sets the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup. If you don’t set a submitter ID, the process uses the current user as the submitter. #### Signature public Void setSubmitterId(String userID) #### Parameters - **userID**: 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 user ID on behalf of which the record is submitted. If set to null, the current user is the submitter. If the submitter is not set with this method, the default submitter is null (the current user). #### Return Value Type: Void