User Interface API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Object Info Directory Entry
An entry in the Object Info Directory, which is a directory of
objects that User Interface API supports and that the context user can
access.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| apiName | String | The API name of the object. | Small, 42.0 | 42.0 |
| keyPrefix | String | The key prefix of the object. | Small, 47.0 | 47.0 |
| label | String | The label of the object. | Small, 42.0 | 42.0 |
| labelPlural | String | The plural label of the object. | Small, 42.0 | 42.0 |
| nameFields | String[] | A list of the API names of the name fields of the object. Most objects have one name field. For example, the Order object has one name field, OrderNumber. However, objects that use a first and last name have multiple name fields. For example, the Contact object has these name fields: FirstName, LastName, and Name. | Small, 47.0 | 47.0 |
| objectInfoUrl | String | The URL to get a full object info response for this object (/ui-api/object-info/{objectApiName}). | Small, 42.0 | 42.0 |