Lightning - retrieve picklist values available for RecordType

Question

How can I show only picklist values allowed for a specific Record Type?

For example:

Case.Status values are "Pending", "Open", "Closed"

• Case RecordType1 only allows the Pending value
• Case RecordType2 allows Open and Closed values

I'm developing a Lightning component in a Visualforce Page but I haven't found a convenient lightning-way to do this. I'm looking for a stable solution, that allows me to remove the component from the VF page at any time.

In Visualforce I used to invoke the describeLayout API offered with connection.js and it worked well:

sforce.connection.describeLayout(
    selectedObjectType,
    new Array(recordTypeId), {
       onSuccess: handleDescribeLayoutSuccess,
       onFailure: handleDescribeLayoutFailure
    }
); 

So I tried to import connection.js in my Lightning component using ltng:require and retrieving the SessionId with a server-side action. It works well with Locker Service disabled, but when it is enabled the describeLayout response always enter in the onFailure callback.

The data provided to the onFailure function shows the layout describe in XML, but it is treated as an error.

The response data is below (just skipped part of the inner describe):

Remote invocation failed, due to: 
<?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Header>
      <LimitInfoHeader><limitInfo><current>2</current><limit>15000</limit><type>API REQUESTS</type></limitInfo>
      </LimitInfoHeader>
    </soapenv:Header>
    <soapenv:Body>
       <describeLayoutResponse>
         <result><-- correct layout describe, skipped for readability --></result>    
       </describeLayoutResponse>
    </soapenv:Body>
  </soapenv:Envelope> status code: 

Answer 1

You can now use the UI API from your lightning component's apex controller to retrieve this information. It's not ideal because you have to use an API call into your own org, but at least it is now possible.

See the salesforce documentation on the UI API here.

The callout would be /ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}. This retrieves picklist values based on the record type ID you pass it.

Answer 2

I just found this for LWC, that allows you to get the picklist options for a record type https://developer.salesforce.com/docs/component-library/documentation/lwc/lwc.reference_wire_adapters_picklist_values_record

So in theory you could write a generic LWC that you pass the object, record type name, field name and it would return the list of options.

Here is an example from their git repo - https://github.com/trailheadapps/lwc-recipes/tree/master/force-app/main/default/lwc/wireGetPicklistValuesByRecordType

Answer 3

There is a component in Lighting : (check document here)

lightning:recordEditForm

It is working fine without any other apex or controller code :

<lightning:recordEditForm recordId="{!v.case.Id}" recordTypeId="{!v.recordTypeId}" objectApiName="Case">
       <div class="slds-col slds-size_1-of-1">
             <lightning:inputField fieldName="Status" value="{!v.case.Status}"/>
        </div>
</lightning:recordEditForm>

Answer 4

I was able to go get this working with the wire adapters. LWCs now provide getPicklistValues to get picklist values based on record type

import { LightningElement, wire, api } from 'lwc';
 import { getPicklistValues } from 'lightning/uiObjectInfoApi';
 
 
 export default class PicklistTest extends LightningElement {
     @api recordTypeId;
     @api fieldApiName;
     picklistValues;
 
     @wire(getPicklistValues, { recordTypeId: this.recordTypeId, fieldApiName: this.fieldApiName })
     wiredNewWorkload({ data, error }) {
         if (data) {
             this.picklistValues = data.values;
             this.dispatchEvent('picklistvalueload', {
                 detail: this.picklistValues
             });
         }
         if (error) {
             console.error('Error in retrieving picklist values!' + JSON.stringify(error));
         }
     }
 }

recordTypeId and fieldApiName (Case.Status) can be set inside the parent Aura component which can get the picklist values based on picklistvalueload event.