User Interface API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Get a Record
-
GET /ui-api/records/{recordId} - recordId—A custom object record or a supported object record.
- Available Version
- 41.0
- Example for GET
-
This example gets the data for fields in the compact layout
for an opportunity record with ID 006R0000001rboIIAQ. The response includes OpportunityCompetitors and
Partners child
records.
GET /ui-api/records/006R0000001rboIIAQ?layoutTypes=Compact&childRelationships=Opportunity.OpportunityCompetitors,Opportunity.Partners - Request Parameters
-
Parameter Name Type Description Required or Optional Available Version childRelationships String[] A collection of child relationship names. The records with those child relationship names are included in the response. Specify names in the format ObjectApiName.ChildRelationshipName or ObjectApiName.ChildRelationshipName.FieldApiName. For example, to specify the Contacts relationship on an Account, use Account.Contacts. You can get child relationships one level deep. To get a relationship name, look in the Object Info response body.
Optional 41.0 includeFieldsInBody Boolean Specifies whether to return a field that’s defined in the request body but not in the layout. The default value is false. When set to true, fields that are not in the layout are also included in the response body. Optional 59.0 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, or if the field doesn’t exist, 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.
Specify names in the format ObjectApiName.FieldName. You can get any field that has a named relationship to this record. There’s no limit to the number of fields you can specify.
Child relationship records don’t have layouts. To get more fields for these records, specify them in the fields parameter.
To return a field whose type is base64, specify the field in the optionalFields parameter.
In API versions 45.0 and later, either fields, optionalFields, or layoutTypes is required. In earlier API versions, either fields or layoutTypes is required.
In all API versions, to specify both fields and layoutTypes, you must specify childRelationships.41.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.
In API versions 45.0 and later, either fields, optionalFields, or layoutTypes is required. In earlier API versions, either fields or layoutTypes is required.
In all API versions, to specify both fields and layoutTypes, you must specify childRelationships.41.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 to build UI that displays a record.
Optional if layoutTypes is specified. If layoutTypes is not specified, this parameter is ignored. 41.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 names in the format ObjectApiName.FieldName. You can get any field that has a named relationship to this record. There’s no limit to the number of fields you can specify.
To return a field whose type is base64, specify the field in the optionalFields parameter.
In API versions 45.0 and later, either fields, optionalFields, or layoutTypes is required. In earlier API versions, optionalFields is optional.
41.0 pageSize Integer The maximum number of child records to return on a page. Optional 41.0 updateMru Boolean To add to the most recently used (MRU) list view, set to true. The default value is false. Optional 47.0 - Response Body
- Record