Salesforce Experience Cloud · Schema
ObjectInfoRepresentation
Object metadata for UI rendering
CMSCommunitiesCRMCustomer PortalDigital ExperienceExperience CloudPartner Portal
Properties
| Name | Type | Description |
|---|---|---|
| apiName | string | API name of the object |
| associateEntityType | string | |
| associateParentEntity | string | |
| childRelationships | array | |
| createable | boolean | |
| custom | boolean | |
| defaultRecordTypeId | string | |
| deletable | boolean | |
| feedEnabled | boolean | |
| fields | object | Map of field API names to field metadata |
| keyPrefix | string | |
| label | string | |
| labelPlural | string | |
| layoutable | boolean | |
| mruEnabled | boolean | |
| nameFields | array | |
| queryable | boolean | |
| recordTypeInfos | object | |
| searchable | boolean | |
| themeInfo | object | |
| updateable | boolean |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ObjectInfoRepresentation",
"title": "ObjectInfoRepresentation",
"type": "object",
"description": "Object metadata for UI rendering",
"properties": {
"apiName": {
"type": "string",
"description": "API name of the object"
},
"associateEntityType": {
"type": "string"
},
"associateParentEntity": {
"type": "string"
},
"childRelationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"childObjectApiName": {
"type": "string"
},
"fieldName": {
"type": "string"
},
"junctionIdListNames": {
"type": "array",
"items": {
"type": "string"
}
},
"junctionReferenceTo": {
"type": "array",
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "string"
}
}
}
},
"createable": {
"type": "boolean"
},
"custom": {
"type": "boolean"
},
"defaultRecordTypeId": {
"type": "string"
},
"deletable": {
"type": "boolean"
},
"feedEnabled": {
"type": "boolean"
},
"fields": {
"type": "object",
"description": "Map of field API names to field metadata",
"additionalProperties": {
"type": "object",
"properties": {
"apiName": {
"type": "string"
},
"compound": {
"type": "boolean"
},
"compoundComponentName": {
"type": "string"
},
"compoundFieldName": {
"type": "string"
},
"controllerName": {
"type": "string"
},
"controllingFields": {
"type": "array",
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean"
},
"custom": {
"type": "boolean"
},
"dataType": {
"type": "string"
},
"extraTypeInfo": {
"type": "string"
},
"filterable": {
"type": "boolean"
},
"filteredLookupInfo": {
"type": "object"
},
"highScaleNumber": {
"type": "boolean"
},
"htmlFormatted": {
"type": "boolean"
},
"inlineHelpText": {
"type": "string"
},
"label": {
"type": "string"
},
"length": {
"type": "integer"
},
"nameField": {
"type": "boolean"
},
"polymorphicForeignKey": {
"type": "boolean"
},
"precision": {
"type": "integer"
},
"reference": {
"type": "boolean"
},
"referenceTargetField": {
"type": "string"
},
"referenceToInfos": {
"type": "array",
"items": {
"type": "object"
}
},
"relationshipName": {
"type": "string"
},
"required": {
"type": "boolean"
},
"scale": {
"type": "integer"
},
"searchPrefilterable": {
"type": "boolean"
},
"sortable": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"updateable": {
"type": "boolean"
}
}
}
},
"keyPrefix": {
"type": "string"
},
"label": {
"type": "string"
},
"labelPlural": {
"type": "string"
},
"layoutable": {
"type": "boolean"
},
"mruEnabled": {
"type": "boolean"
},
"nameFields": {
"type": "array",
"items": {
"type": "string"
}
},
"queryable": {
"type": "boolean"
},
"recordTypeInfos": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"defaultRecordTypeMapping": {
"type": "boolean"
},
"master": {
"type": "boolean"
},
"name": {
"type": "string"
},
"recordTypeId": {
"type": "string"
}
}
}
},
"searchable": {
"type": "boolean"
},
"themeInfo": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"iconUrl": {
"type": "string",
"format": "uri"
}
}
},
"updateable": {
"type": "boolean"
}
}
}