User Interface API Developer Guide

Get Started with User Interface API
User Interface API Resources
Record UI, Get
Record Layout, Get
Object Info, Get
Records, Get, Delete, Patch
Records, Batch Get
Records, Post
Clone Record Defaults, Get
Create Record Defaults, Get
Picklist Values, Get
User Interface API Request Bodies
User Interface API Response Bodies
PDF

Newer Version Available

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

Records, Batch Get

Get data for a batch of records.
Resource
1/ui-api/records/batch/{recordIds}
Available version
39.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
fields String[] Specifies the fields to return. If this property is specified, the response is a union of fields and optionalFields.

If the context user doesn’t have access to a field, an error is returned.

If you’re not sure whether the context user has access to a field and you don’t want the request to fail if they don’t, use the optionalFields parameter instead.

Either fields or layoutTypes is required. 39.0
layoutTypes String[] Specifies the fields to return. If this property is specified, the response is a union of layoutTypes, modes, and optionalFields.
A collection containing any of these values:
  • Compact—Use this value to get a layout that contains a record's key fields.
  • Full—(Default) Use this value to get a full layout.
 Either fields or layoutTypes is required. 39.0
modes String[] The access mode for the record. This value determines which fields to get from a layout. Layouts have different fields for create, edit, and view modes. For example, formula fields are rendered in view mode, but not in create mode because they’re calculated at run time, like formulas in a spreadsheet. A collection containing any of these values:
  • Create—Use this mode if you intend to build UI that lets a user create a record. This mode is used by the /ui-api/record-defaults/create/{apiName} resource.
  • Edit—Use this mode if you intend to build UI that lets a user edit a record. This mode is used by the /ui-api/record-defaults/clone/{recordId} resource.
  • View—(Default) Use this mode if you intend to build UI that displays a record.
 Optional if the layoutTypes parameter is specified. Otherwise, this parameter is ignored. 39.0
optionalFields String[] A collection of optional field names. If a field is accessible to the context user, it’s included in the response. If a field isn’t accessible to the context user, it isn’t included in the response, but it doesn’t cause an error. Specify optional field names using the format: {ObjectApiName}.{FieldName} Optional 39.0
Response body for GET
Batch Results