User Interface API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with User Interface API
User Interface API Features
Work with Records
Get Child Records
Build UI for Picklists
Upload Binary Files
Prevent Record Duplication with Idempotent Record Writes
Upload Files
Work with Actions
Manage Favorites
Work with List Views
Manage Apps
User Interface API Resources
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

Get Child Records

User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results.
There are multiple resources that return child records. All of them share some common functionality.
Specify a Child Relationship
Specify child relationships in the format ObjectApiName.ChildRelationshipName. For example, to specify the Contacts relationship on an account, use Account.Contacts.
Specify spanning relationships in the format ObjectApiName.ChildRelationshipName.FieldApiName. For example, to specify the account billing address for an opportunity, use Opportunity.Account.BillingAddress.
Paginated Responses
The child relationships records in the response are paginated and include URLs to get the next page and previous pages of child records. Use the pageSize parameter to specify the number of records per page. The default is 5.
Responses Include One Level of Child Relationships
User Interface API gets the first set of child relationships that it finds, it doesn’t get the next level of child relationships. For example, this request gets the Opportunities on an Account record. If an opportunity in the response has a child relationship with another object, the API doesn’t return that information.
GET /ui-api/record-ui/001R0000003IG0vIAG?childRelationships=Account.Opportunities
In this shortened response body, you see the first set of child relationships on the Account record, which in this case is three Opportunity records. The records in the next level of child relationships—on the Opportunity object—don’t appear because it would make the response body too large.
...response shortened...
"records" : {
    "001RM000003TXRbYAO" : {
      "apiName" : "Account",
      "childRelationships" : {
        "Opportunities" : {
          "count" : 3,
          "currentPageUrl" : "/services/data/v41.0/ui-api/records/001RM000003TXRbYAO/child-relationships/Opportunities?
              fields=%5BOpportunity.Name%2C%20Opportunity.Id%5D&page=1&pageSize=5",
          "nextPageUrl" : null,
          "previousPageUrl" : null,
          "records" : [ {
            "apiName" : "Opportunity",
            "childRelationships" : { },
            "fields" : {
              "AccountId" : {
                "displayValue" : null,
                "value" : "001RM000003TXRbYAO"
              },
              "Id" : {
                "displayValue" : null,
                "value" : "006RM000002XCGxYAO"
              },
              "Name" : {
                "displayValue" : null,
                "value" : "Acme - 1,200 Widgets"
              }
            },
            "id" : "006RM000002XCGxYAO",
            "recordTypeId" : "012000000000000000",
            "recordTypeInfo" : null
          },

Resources That Return Child Records

Get Child Records for a Specific Record and Child Relationship
This example returns all the Contacts related to the Account record 001R0000003I6CoIAK. 
/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts
The response is paginated. Use the pageSize parameter to specify the number of records per page. The default is 5. 
{   
    "count" : 5,
    "currentPageUrl" :
    "/services/data/v41.0/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts?page=1&pageSize=5",
    "nextPageUrl" :
    "/services/data/v41.0/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts?page=2&pageSize=5",
    "previousPageUrl" : null,
    "records" : [ {
        "apiName" : "Contact",
        "childRelationships" : { },
        "fields" : {
            "AccountId" : {
                "displayValue" : null,
                "value" : "001R0000003I6CoIAK"
            },
            "Id" : { 
                "displayValue" : null,
                "value" : "003R0000007qXwQIAU"
            },
            "Name" : { 
                "displayValue" : null,
                "value" : "John Smith"
            }
        },
        "id" : "003R0000007qXwQIAU",
        "recordTypeId" : "012000000000000000",
        "recordTypeInfo" : null
    },
    ...
}
Get a Record and Include Child Records
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
Get a Batch of Records and Include Child Records
This example gets the Account.Name field and Account.Contacts child records for two accounts.
GET /ui-api/records/batch/001R0000003I6CeIAK,001R0000003I6CgIAK?
  fields=Account.Name&childRelationships=Account.Contacts
Get Record Data and Metadata and Include Child Records
The response for this request includes layout information, metadata, and record data. The record data includes child relationship data for Contacts and Opportunities. 
GET /ui-api/record-ui/001R0000003I6CoIAK?childRelationships=Account.Contacts,Account.Opportunities