Salesforce · JSON Structure

Salesforce Ui Field Representation Structure

Metadata for a single field

Type: object Properties: 8
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

FieldRepresentation is a JSON Structure definition published by Salesforce, describing 8 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

apiName label dataType required updateable createable nillable referenceToInfos

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "Metadata for a single field",
  "name": "FieldRepresentation",
  "properties": {
    "apiName": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "dataType": {
      "type": "string",
      "enum": [
        "Address",
        "Boolean",
        "Currency",
        "Date",
        "DateTime",
        "Double",
        "Email",
        "Id",
        "Integer",
        "Long",
        "MultiPicklist",
        "Percent",
        "Phone",
        "Picklist",
        "Reference",
        "String",
        "TextArea",
        "Time",
        "Url"
      ]
    },
    "required": {
      "type": "boolean"
    },
    "updateable": {
      "type": "boolean"
    },
    "createable": {
      "type": "boolean"
    },
    "nillable": {
      "type": "boolean"
    },
    "referenceToInfos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "apiName": {
            "type": "string"
          },
          "nameFields": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}