User Interface API Developer Guide
jNewer Version Available
Object Info
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| apiName | String | The object's API name. | Small, 41.0 | 41.0 |
| childRelationships | Child Relationship[] | The object’s child relationships. | Medium, 41.0 | 41.0 |
| createable | Boolean | Indicates whether the object can be created. | Small, 41.0 | 41.0 |
| custom | Boolean | Indicates whether the object is custom. | Small, 41.0 | 41.0 |
| defaultRecordTypeId | String | The ID for the default record type for this object, if any. If there isn’t a default record type, this value is the master record type, which is 012000000000000AAA. If the record is a nested record (for example, in a request for an Account, the User object is a nested record), the value is null. | Medium, 41.0 | 41.0 |
| deleteable | Boolean | Indicates whether the object can be deleted. Only available in API version 41.0. In API version 42.0, we spelled it correctly. | Small, 41.0 | 41.0-41.0 |
| deletable | Boolean | Indicates whether the object can be deleted. | Small, 42.0 | 42.0 |
| dependentFields | Map<String, Object> |
A map of the dependent fields tree structure. Each
nested object is another Map<String, Object>. When the object is empty, it
indicates a leaf of the tree, which is a field that doesn’t control other fields.
An object can have multiple independent trees, which means this property can have
multiple root objects.
Imagine an object with the
picklists Continents__c, Countries__c, and Cities__c. Continents__c is the root.
Cities__c is a leaf. Continents__c and Countries__c are controlling fields.
Countries__c and Cities__c are dependent
picklists.
A field dependency causes the values in a picklist to be dynamically filtered based on the value selected by the user in another field. The field that drives filtering is called the "controlling field." Standard and custom checkboxes and picklists with at least one and less than 300 values can be controlling fields. The field that has its values filtered is called the "dependent field." Custom picklists and multi-select picklists can be dependent fields. |
Big, 42.0 | 42.0 |
| feedEnabled | Boolean | Indicates whether the object can have feeds. | Medium, 41.0 | 41.0 |
| fields | Map<String, Field> | A map of field API name to information about the field. This map only contains fields relevant to the requested layout and mode. | Medium, 41.0 | 41.0 |
| keyPrefix | String | The key prefix for IDs of this object. | Medium, 41.0 | 41.0 |
| label | String | The object's display label. | Small, 41.0 | 41.0 |
| labelPlural | String | The plural form of the object's display label. | Medium, 41.0 | 41.0 |
| layoutable | Boolean | Indicates whether the object can have a layout. | Small, 41.0 | 41.0 |
| mruEnabled | Boolean | Indicates whether the object can appear in Most Recently Used lists. | Small, 41.0 | 41.0 |
| nameFields | String[] | A collection of the API names of the fields used to identify the name field for standard and custom objects. Typically there is one name field per object, except where FirstName and LastName fields are used. | Medium, 41.0 | 41.0 |
| queryable | Boolean | Indicates whether the context user can query the object. | Small, 41.0 | 41.0 |
| recordTypeInfos | Map<String, Record Type Info> | A map of record type IDs to information about the record type. All record types are visible whether the user has access to them. | Medium, 41.0 | 41.0 |
| searchable | Boolean | Indicates whether the object can be searched. | Small, 41.0 | 41.0 |
| themeInfo | Theme Info | Theme information for the object. | Medium, 41.0 | 41.0 |
| updateable | Boolean | Indicates whether the object can be updated. | Small, 41.0 | 41.0 |