Object Layout

Gets layout metadata for the specified object type and parameters.

Parameters

  • API version (string, optional)
  • Object API name (string, required)
  • Form factor (string, optional)—“Large” (default), “Medium”, or “Small”
  • Layout type (string, optional)—”Full” (default) or “Compact”
  • Mode (string, optional)—”View” (default, “Create”, or “Edit”
  • Record type ID (string, optional)—The ID of the RecordType object for the new record. If not provided, the default record type is used.

iOS

Swift
1requestForLayout(withObjectAPIName:formFactor:layoutType:mode:recordTypeId:apiVersion:)
Objective-C
1- (SFRestRequest *)
2requestForLayoutWithObjectAPIName:(nonnull NSString *)objectAPIName 
3                       formFactor:(nullable NSString *)formFactor 
4                       layoutType:(nullable NSString *)layoutType 
5                             mode:(nullable NSString *)mode 
6                     recordTypeId:(nullable NSString *)recordTypeId 
7                       apiVersion:(nullable NSString *)apiVersion;

Android

Kotlin
1fun getRequestForObjectLayout(apiVersion: String?, objectAPIName: String?,
2    formFactor: String?, layoutType: String?, mode: String?, 
3    recordTypeId: String?): RestRequest
Java
1public static RestRequest getRequestForObjectLayout(
2    String apiVersion, String objectAPIName, String formFactor, 
3    String layoutType, String mode, String recordTypeId)