Salesforce · Schema

ObjectInfoRepresentation

Metadata about a Salesforce object

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
apiName string
label string
labelPlural string
keyPrefix string
createable boolean
updateable boolean
deleteable boolean
queryable boolean
fields object Field metadata indexed by field API name
recordTypeInfos object
themeInfo object
View JSON Schema on GitHub

JSON Schema

salesforce-ui-object-info-representation-schema.json Raw ↑
{
  "type": "object",
  "description": "Metadata about a Salesforce object",
  "properties": {
    "apiName": {
      "type": "string",
      "example": "example_value"
    },
    "label": {
      "type": "string",
      "example": "Example Title"
    },
    "labelPlural": {
      "type": "string",
      "example": "example_value"
    },
    "keyPrefix": {
      "type": "string",
      "example": "example_value"
    },
    "createable": {
      "type": "boolean",
      "example": true
    },
    "updateable": {
      "type": "boolean",
      "example": true
    },
    "deleteable": {
      "type": "boolean",
      "example": true
    },
    "queryable": {
      "type": "boolean",
      "example": true
    },
    "fields": {
      "type": "object",
      "description": "Field metadata indexed by field API name",
      "example": "example_value"
    },
    "recordTypeInfos": {
      "type": "object",
      "example": "example_value"
    },
    "themeInfo": {
      "type": "object",
      "example": "example_value",
      "properties": {
        "color": {
          "type": "string"
        },
        "iconUrl": {
          "type": "string"
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ObjectInfoRepresentation"
}