Salesforce · Schema
FieldRepresentation
Metadata for a single field
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales
Properties
| Name | Type | Description |
|---|---|---|
| apiName | string | |
| label | string | |
| dataType | string | |
| required | boolean | |
| updateable | boolean | |
| createable | boolean | |
| nillable | boolean | |
| referenceToInfos | array |
JSON Schema
{
"type": "object",
"description": "Metadata for a single field",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"dataType": {
"type": "string",
"example": "Address",
"enum": [
"Address",
"Boolean",
"Currency",
"Date",
"DateTime",
"Double",
"Email",
"Id",
"Integer",
"Long",
"MultiPicklist",
"Percent",
"Phone",
"Picklist",
"Reference",
"String",
"TextArea",
"Time",
"Url"
]
},
"required": {
"type": "boolean",
"example": true
},
"updateable": {
"type": "boolean",
"example": true
},
"createable": {
"type": "boolean",
"example": true
},
"nillable": {
"type": "boolean",
"example": true
},
"referenceToInfos": {
"type": "array",
"example": [],
"items": {
"type": "object",
"properties": {
"apiName": {
"type": "string"
},
"nameFields": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "FieldRepresentation"
}