capabilities.work

Get a Record UI Representation

A 2-step recipe with Salesforce. We can help you get access.

Recipe · 2 steps

Get a Record UI Representation

Retrieve a Salesforce record's UI representation with object metadata.

  1. Read the object metadata to confirm the object exists and to learn its fields, labels, and CRUD permissions before loading the record.
  2. Load the record's UI API representation using the requested layout so the client receives field values alongside their display metadata.
What you'll need to have ready
  • objectApiName: The API name of the Salesforce object (e.g. Account, Contact, MyObject__c).
  • recordId: The 18-character Salesforce record ID to retrieve.
  • layoutTypes: Layout type used to determine which fields to return (Full or Compact).
  • modes: View mode for the layout (View, Edit, Create).
For your developer

Arazzo workflow salesforce:get-record-ui, 2 operations: getObjectInfo → getRecord. Specs on APIs.io.