{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "ApprovalSubmission - Data API",
"description": "Represents the instance of an approval request that's submitted for a record of the related object. This object is available in API version 62.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"refers_to"
],
"fields": {
"Comments": {
"type": "textarea",
"properties": "Nillable, Update",
"description": "The comments that the user adds when they submit the request for approval."
},
"DoesSendApprovalEmail": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether approval request emails are sent to approvers and delegates (true) or not (false). The default value is false.",
"required": true
},
"FlowOrchestrationInstanceId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort, Update",
"description": "The ID of the flow orchestration instance record that's associated with the approval. This field is a relationship field.",
"relationship_name": "FlowOrchestrationInstance",
"refers_to": "FlowOrchestrationInstance"
},
"IsEligibleForSmartApproval": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the approval submission is eligible for smart approval (true) or not (false). The default value is false. This field is only available with Advanced Approvals enabled."
},
"IsSmartApprovalRun": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether this approval submission either is run in smart approval mode (true) or not (false). The default value is false. This field is only available with Advanced Approvals enabled."
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The sequentially-generated name of the approval submission record, for example AS-000000001."
},
"OwnerId": {
"type": "reference",
"properties": "Filter, Group, Sort, Update",
"description": "The ID of the user or the group that owns the approval submission record. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"refers_to": "User"
},
"RelatedRecordId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort, Update",
"description": "The API name of the related record that’s submitted for approval.",
"relationship_name": "RelatedRecord",
"refers_to": "The objects that you have access to for approvals.",
"required": true
},
"RelatedRecordObjectName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort, Update",
"description": "The type of record that was submitted for approval.",
"required": true
},
"SmartApprvlBasisSubmissionId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort, Update",
"description": "The previous approval submission used as reference for the auto-approval evaluation. This field is a relationship field. This field is only available with Advanced Approvals enabled.",
"relationship_name": "SmartApprvlBasisSubmission",
"refers_to": "ApprovalSubmission"
},
"Status": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort, Update",
"description": "The status of the approval. Valid values are: Approved Canceled Errored InProgress Recalled Rejected Suspended",
"required": true
},
"SubmittedById": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort, Update",
"description": "The ID of the user who submitted the record for approval. This field is a relationship field.",
"relationship_name": "SubmittedBy",
"refers_to": "User",
"required": true
}
},
"special_access_rules": "This object is available for users with a Salesforce user license of type Salesforce in Enterprise, Performance, Unlimited, and Developer Editions.\n\nThis object is available for users with a\n Salesforce user license of type Salesforce in Enterprise, Performance, Unlimited, and\n Developer Editions.",
"associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **ApprovalSubmissionShare**: Sharing is available for the object.\n\n- **ApprovalSubmissionHistory**: History is available for tracked fields of the object.",
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```",
"field_reference": {
"Comments": {
"field_label": "Comments",
"type": "textarea",
"length": "32000"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"DoesSendApprovalEmail": {
"field_label": "Send Approval Email",
"type": "boolean"
},
"FlowOrchestrationInstanceId": {
"field_label": "Orchestration Run ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Approval Submission ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsEligibleForSmartApproval": {
"field_label": "Eligible For Smart Approval",
"type": "boolean"
},
"IsSmartApprovalRun": {
"field_label": "Smart Approval Run",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Approval Submission Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"RelatedRecordId": {
"field_label": "Related Record ID",
"type": "reference",
"length": "18"
},
"RelatedRecordObjectName": {
"field_label": "Related Record Object Name",
"type": "string",
"length": "255"
},
"SmartApprvlBasisSubmissionId": {
"field_label": "Approval Submission ID",
"type": "reference",
"length": "18"
},
"Status": {
"field_label": "Status",
"type": "picklist",
"length": "255"
},
"SubmittedById": {
"field_label": "User ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}