Newer Version Available

This content describes an older version of this product. View Latest

Object Info

The metadata for an object.
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 type, or if there’s only a master type, this value is null. Medium, 41.0 41.0
deleteable Boolean Indicates whether the object can be deleted. Small, 41.0 41.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 object can be queried by the context user. 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 or not 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