Salesforce · JSON Structure
Salesforce S Object Describe Structure
Type: object
Properties: 45
Required: 45
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales
SObjectDescribe is a JSON Structure definition published by Salesforce, describing 45 properties, of which 45 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.
Properties
actionOverrides
activateable
associateEntityType
associateParentEntity
childRelationships
compactLayoutable
createable
custom
customSetting
deepCloneable
defaultImplementation
deletable
deprecatedAndHidden
extendedBy
extendsInterfaces
feedEnabled
fields
hasSubtypes
implementedBy
implementsInterfaces
isInterface
isSubtype
keyPrefix
label
labelPlural
layoutable
listviewable
lookupLayoutable
mergeable
mruEnabled
name
namedLayoutInfos
networkScopeFieldName
queryable
recordTypeInfos
replicateable
retrieveable
searchLayoutable
searchable
sobjectDescribeOption
supportedScopes
triggerable
undeletable
updateable
urls
Meta-schema: https://json-structure.org/draft/2020-12/schema
JSON Structure
{
"type": "object",
"name": "SObjectDescribe",
"properties": {
"actionOverrides": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"formFactor": {
"type": "string"
},
"isAvailableInTouch": {
"type": "boolean"
},
"name": {
"type": "string"
},
"pageId": {
"type": "string"
},
"url": {
"type": "['string', 'null']"
}
},
"required": [
"formFactor",
"isAvailableInTouch",
"name",
"pageId",
"url"
]
}
},
"activateable": {
"type": "boolean"
},
"associateEntityType": {
"type": "['string', 'null']"
},
"associateParentEntity": {
"type": "['string', 'null']"
},
"childRelationships": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"cascadeDelete": {
"type": "boolean"
},
"childSObject": {
"type": "string"
},
"deprecatedAndHidden": {
"type": "boolean"
},
"field": {
"type": "string"
},
"junctionIdListNames": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
},
"junctionReferenceTo": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']"
},
"restrictedDelete": {
"type": "boolean"
}
},
"required": [
"cascadeDelete",
"childSObject",
"deprecatedAndHidden",
"field",
"junctionIdListNames",
"junctionReferenceTo",
"relationshipName",
"restrictedDelete"
]
}
},
"compactLayoutable": {
"type": "boolean"
},
"createable": {
"type": "boolean"
},
"custom": {
"type": "boolean"
},
"customSetting": {
"type": "boolean"
},
"deepCloneable": {
"type": "boolean"
},
"defaultImplementation": {
"type": "['string', 'null']"
},
"deletable": {
"type": "boolean"
},
"deprecatedAndHidden": {
"type": "boolean"
},
"extendedBy": {
"type": "['string', 'null']"
},
"extendsInterfaces": {
"type": "['string', 'null']"
},
"feedEnabled": {
"type": "boolean"
},
"fields": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"aggregatable": {
"type": "boolean"
},
"aiPredictionField": {
"type": "boolean"
},
"autoNumber": {
"type": "boolean"
},
"byteLength": {
"type": "integer"
},
"calculated": {
"type": "boolean"
},
"calculatedFormula": {
"type": "['string', 'null']"
},
"cascadeDelete": {
"type": "boolean"
},
"caseSensitive": {
"type": "boolean"
},
"compoundFieldName": {
"type": "['string', 'null']"
},
"controllerName": {
"type": "['string', 'null']"
},
"createable": {
"type": "boolean"
},
"custom": {
"type": "boolean"
},
"defaultValue": {
"type": "object"
},
"defaultValueFormula": {
"type": "['string', 'null']"
},
"defaultedOnCreate": {
"type": "boolean"
},
"dependentPicklist": {
"type": "boolean"
},
"deprecatedAndHidden": {
"type": "boolean"
},
"digits": {
"type": "integer"
},
"displayLocationInDecimal": {
"type": "boolean"
},
"encrypted": {
"type": "boolean"
},
"externalId": {
"type": "boolean"
},
"extraTypeInfo": {
"type": "['string', 'null']"
},
"filterable": {
"type": "boolean"
},
"filteredLookupInfo": {
"type": "['string', 'null']"
},
"formulaTreatNullNumberAsZero": {
"type": "boolean"
},
"groupable": {
"type": "boolean"
},
"highScaleNumber": {
"type": "boolean"
},
"htmlFormatted": {
"type": "boolean"
},
"idLookup": {
"type": "boolean"
},
"inlineHelpText": {
"type": "['string', 'null']"
},
"label": {
"type": "string"
},
"length": {
"type": "integer"
},
"mask": {
"type": "['string', 'null']"
},
"maskType": {
"type": "['string', 'null']"
},
"name": {
"type": "string"
},
"nameField": {
"type": "boolean"
},
"namePointing": {
"type": "boolean"
},
"nillable": {
"type": "boolean"
},
"permissionable": {
"type": "boolean"
},
"picklistValues": {
"type": "array",
"description": "",
"items": {
"type": "object"
}
},
"polymorphicForeignKey": {
"type": "boolean"
},
"precision": {
"type": "integer"
},
"queryByDistance": {
"type": "boolean"
},
"referenceTargetField": {
"type": "['string', 'null']"
},
"referenceTo": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']"
},
"relationshipOrder": {
"type": "['string', 'null']"
},
"restrictedDelete": {
"type": "boolean"
},
"restrictedPicklist": {
"type": "boolean"
},
"scale": {
"type": "integer"
},
"searchPrefilterable": {
"type": "boolean"
},
"soapType": {
"type": "string"
},
"sortable": {
"type": "boolean"
},
"type": {
"type": "string"
},
"unique": {
"type": "boolean"
},
"updateable": {
"type": "boolean"
},
"writeRequiresMasterRead": {
"type": "boolean"
}
},
"required": [
"aggregatable",
"aiPredictionField",
"autoNumber",
"byteLength",
"calculated",
"calculatedFormula",
"cascadeDelete",
"caseSensitive",
"compoundFieldName",
"controllerName",
"createable",
"custom",
"defaultValue",
"defaultValueFormula",
"defaultedOnCreate",
"dependentPicklist",
"deprecatedAndHidden",
"digits",
"displayLocationInDecimal",
"encrypted",
"externalId",
"extraTypeInfo",
"filterable",
"filteredLookupInfo",
"formulaTreatNullNumberAsZero",
"groupable",
"highScaleNumber",
"htmlFormatted",
"idLookup",
"inlineHelpText",
"label",
"length",
"mask",
"maskType",
"name",
"nameField",
"namePointing",
"nillable",
"permissionable",
"picklistValues",
"polymorphicForeignKey",
"precision",
"queryByDistance",
"referenceTargetField",
"referenceTo",
"relationshipName",
"relationshipOrder",
"restrictedDelete",
"restrictedPicklist",
"scale",
"searchPrefilterable",
"soapType",
"sortable",
"type",
"unique",
"updateable",
"writeRequiresMasterRead"
]
}
},
"hasSubtypes": {
"type": "boolean"
},
"implementedBy": {
"type": "['string', 'null']"
},
"implementsInterfaces": {
"type": "['string', 'null']"
},
"isInterface": {
"type": "boolean"
},
"isSubtype": {
"type": "boolean"
},
"keyPrefix": {
"type": "string"
},
"label": {
"type": "string"
},
"labelPlural": {
"type": "string"
},
"layoutable": {
"type": "boolean"
},
"listviewable": {
"type": "['string', 'null']"
},
"lookupLayoutable": {
"type": "['string', 'null']"
},
"mergeable": {
"type": "boolean"
},
"mruEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"namedLayoutInfos": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
},
"networkScopeFieldName": {
"type": "['string', 'null']"
},
"queryable": {
"type": "boolean"
},
"recordTypeInfos": {
"type": "array",
"description": "",
"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"
},
"urls": {
"type": "object",
"properties": {
"layout": {
"type": "string"
}
},
"required": [
"layout"
]
}
},
"required": [
"active",
"available",
"defaultRecordTypeMapping",
"developerName",
"master",
"name",
"recordTypeId",
"urls"
]
}
},
"replicateable": {
"type": "boolean"
},
"retrieveable": {
"type": "boolean"
},
"searchLayoutable": {
"type": "boolean"
},
"searchable": {
"type": "boolean"
},
"sobjectDescribeOption": {
"type": "string"
},
"supportedScopes": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"label",
"name"
]
}
},
"triggerable": {
"type": "boolean"
},
"undeletable": {
"type": "boolean"
},
"updateable": {
"type": "boolean"
},
"urls": {
"type": "object",
"properties": {
"compactLayouts": {
"type": "string"
},
"rowTemplate": {
"type": "string"
},
"approvalLayouts": {
"type": "string"
},
"uiDetailTemplate": {
"type": "string"
},
"uiEditTemplate": {
"type": "string"
},
"listviews": {
"type": "string"
},
"describe": {
"type": "string"
},
"uiNewRecord": {
"type": "string"
},
"quickActions": {
"type": "string"
},
"layouts": {
"type": "string"
},
"sobject": {
"type": "string"
}
},
"required": [
"compactLayouts",
"rowTemplate",
"approvalLayouts",
"uiDetailTemplate",
"uiEditTemplate",
"listviews",
"describe",
"uiNewRecord",
"quickActions",
"layouts",
"sobject"
]
}
},
"required": [
"actionOverrides",
"activateable",
"associateEntityType",
"associateParentEntity",
"childRelationships",
"compactLayoutable",
"createable",
"custom",
"customSetting",
"deepCloneable",
"defaultImplementation",
"deletable",
"deprecatedAndHidden",
"extendedBy",
"extendsInterfaces",
"feedEnabled",
"fields",
"hasSubtypes",
"implementedBy",
"implementsInterfaces",
"isInterface",
"isSubtype",
"keyPrefix",
"label",
"labelPlural",
"layoutable",
"listviewable",
"lookupLayoutable",
"mergeable",
"mruEnabled",
"name",
"namedLayoutInfos",
"networkScopeFieldName",
"queryable",
"recordTypeInfos",
"replicateable",
"retrieveable",
"searchLayoutable",
"searchable",
"sobjectDescribeOption",
"supportedScopes",
"triggerable",
"undeletable",
"updateable",
"urls"
],
"$schema": "https://json-structure.org/draft/2020-12/schema"
}