DescribeSObjectResult

Complete describe result for an sObject

CMSCommunitiesCRMCustomer PortalDigital ExperienceExperience CloudPartner Portal

Properties

Name Type Description
actionOverrides array
activateable boolean
childRelationships array
compactLayoutable boolean
createable boolean
custom boolean
customSetting boolean
deletable boolean
deprecatedAndHidden boolean
feedEnabled boolean
fields array
hasSubtypes boolean
isSubtype boolean
keyPrefix string
label string
labelPlural string
layoutable boolean
listviewable boolean
lookupLayoutable boolean
mergeable boolean
mruEnabled boolean
name string
namedLayoutInfos array
networkScopeFieldName string
queryable boolean
recordTypeInfos array
replicateable boolean
retrieveable boolean
searchLayoutable boolean
searchable boolean
supportedScopes array
triggerable boolean
undeletable boolean
updateable boolean
urls object
View JSON Schema on GitHub

JSON Schema

salesforce-experience-cloud-describesobjectresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DescribeSObjectResult",
  "title": "DescribeSObjectResult",
  "type": "object",
  "description": "Complete describe result for an sObject",
  "properties": {
    "actionOverrides": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "activateable": {
      "type": "boolean"
    },
    "childRelationships": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ChildRelationship"
      }
    },
    "compactLayoutable": {
      "type": "boolean"
    },
    "createable": {
      "type": "boolean"
    },
    "custom": {
      "type": "boolean"
    },
    "customSetting": {
      "type": "boolean"
    },
    "deletable": {
      "type": "boolean"
    },
    "deprecatedAndHidden": {
      "type": "boolean"
    },
    "feedEnabled": {
      "type": "boolean"
    },
    "fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FieldDescribe"
      }
    },
    "hasSubtypes": {
      "type": "boolean"
    },
    "isSubtype": {
      "type": "boolean"
    },
    "keyPrefix": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "labelPlural": {
      "type": "string"
    },
    "layoutable": {
      "type": "boolean"
    },
    "listviewable": {
      "type": "boolean"
    },
    "lookupLayoutable": {
      "type": "boolean"
    },
    "mergeable": {
      "type": "boolean"
    },
    "mruEnabled": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    },
    "namedLayoutInfos": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "networkScopeFieldName": {
      "type": "string"
    },
    "queryable": {
      "type": "boolean"
    },
    "recordTypeInfos": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RecordTypeInfo"
      }
    },
    "replicateable": {
      "type": "boolean"
    },
    "retrieveable": {
      "type": "boolean"
    },
    "searchLayoutable": {
      "type": "boolean"
    },
    "searchable": {
      "type": "boolean"
    },
    "supportedScopes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "triggerable": {
      "type": "boolean"
    },
    "undeletable": {
      "type": "boolean"
    },
    "updateable": {
      "type": "boolean"
    },
    "urls": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}