Salesforce · Schema

LayoutItem

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
editableForNew boolean
editableForUpdate boolean
label string
layoutComponents array
lookupIdApiName ['string', 'null']
required boolean
sortable boolean
View JSON Schema on GitHub

JSON Schema

salesforce-layout-item-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "editableForNew": {
      "type": "boolean",
      "example": true
    },
    "editableForUpdate": {
      "type": "boolean",
      "example": true
    },
    "label": {
      "type": "string",
      "example": "Example Title"
    },
    "layoutComponents": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "apiName": {
            "type": "['string', 'null']",
            "example": "example_value"
          },
          "componentType": {
            "type": "string",
            "example": "example_value"
          },
          "label": {
            "type": "string",
            "example": "Example Title"
          }
        },
        "required": [
          "apiName",
          "componentType",
          "label"
        ]
      }
    },
    "lookupIdApiName": {
      "type": "['string', 'null']",
      "example": "example_value"
    },
    "required": {
      "type": "boolean",
      "example": true
    },
    "sortable": {
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "editableForNew",
    "editableForUpdate",
    "label",
    "layoutComponents",
    "lookupIdApiName",
    "required",
    "sortable"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LayoutItem"
}