SObjectDescribe

Full metadata description of an sObject including fields and relationships

CloudCRMCustomer ManagementEnterpriseSales

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
queryable	boolean
recordTypeInfos	array
replicateable	boolean
retrieveable	boolean
searchLayoutable	boolean
searchable	boolean
triggerable	boolean
undeletable	boolean
updateable	boolean
urls	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SObjectDescribe",
  "title": "SObjectDescribe",
  "type": "object",
  "description": "Full metadata description of an sObject including fields and relationships",
  "properties": {
    "actionOverrides": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "activateable": {
      "type": "boolean"
    },
    "childRelationships": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cascadeDelete": {
            "type": "boolean"
          },
          "childSObject": {
            "type": "string"
          },
          "deprecatedAndHidden": {
            "type": "boolean"
          },
          "field": {
            "type": "string"
          },
          "junctionIdListNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "junctionReferenceTo": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "relationshipName": {
            "type": "string",
            "nullable": true
          },
          "restrictedDelete": {
            "type": "boolean"
          }
        }
      }
    },
    "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",
      "nullable": true
    },
    "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"
      }
    },
    "queryable": {
      "type": "boolean"
    },
    "recordTypeInfos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "active": {
            "type": "boolean"
          },
          "available": {
            "type": "boolean"
          },
          "defaultRecordTypeMapping": {
            "type": "boolean"
          },
          "developerName": {
            "type": "string"
          },
          "master": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "recordTypeId": {
            "type": "string"
          }
        }
      }
    },
    "replicateable": {
      "type": "boolean"
    },
    "retrieveable": {
      "type": "boolean"
    },
    "searchLayoutable": {
      "type": "boolean"
    },
    "searchable": {
      "type": "boolean"
    },
    "triggerable": {
      "type": "boolean"
    },
    "undeletable": {
      "type": "boolean"
    },
    "updateable": {
      "type": "boolean"
    },
    "urls": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}