Salesforce · Schema

RecordRepresentation

A Salesforce record with field values and UI metadata

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
id string The 18-character Salesforce record ID
apiName string The API name of the object type
childRelationships object Child relationship data indexed by relationship name
eTag string ETag for optimistic concurrency control
fields object Field values indexed by field API name
recordTypeId string The record type ID
recordTypeInfo object Record type metadata
systemModstamp string
lastModifiedById string
lastModifiedDate string
createdById string
createdDate string
View JSON Schema on GitHub

JSON Schema

salesforce-ui-record-representation-schema.json Raw ↑
{
  "type": "object",
  "description": "A Salesforce record with field values and UI metadata",
  "properties": {
    "id": {
      "type": "string",
      "description": "The 18-character Salesforce record ID",
      "example": "abc123"
    },
    "apiName": {
      "type": "string",
      "description": "The API name of the object type",
      "example": "example_value"
    },
    "childRelationships": {
      "type": "object",
      "description": "Child relationship data indexed by relationship name",
      "example": "example_value"
    },
    "eTag": {
      "type": "string",
      "description": "ETag for optimistic concurrency control",
      "example": "example_value"
    },
    "fields": {
      "type": "object",
      "description": "Field values indexed by field API name",
      "example": "example_value"
    },
    "recordTypeId": {
      "type": "string",
      "description": "The record type ID",
      "example": "500123"
    },
    "recordTypeInfo": {
      "type": "object",
      "description": "Record type metadata",
      "example": "example_value",
      "properties": {
        "available": {
          "type": "boolean"
        },
        "defaultRecordTypeMapping": {
          "type": "boolean"
        },
        "master": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "recordTypeId": {
          "type": "string"
        }
      }
    },
    "systemModstamp": {
      "type": "string",
      "format": "date-time",
      "example": "2026-01-15T10:30:00Z"
    },
    "lastModifiedById": {
      "type": "string",
      "example": "500123"
    },
    "lastModifiedDate": {
      "type": "string",
      "format": "date-time",
      "example": "2026-01-15T10:30:00Z"
    },
    "createdById": {
      "type": "string",
      "example": "500123"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time",
      "example": "2026-01-15T10:30:00Z"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RecordRepresentation"
}