Lightning Model Types

Get detailed information about each Lightning type and Apex class type.
Resource
/connect/lightning-model/types
Available version
64.0
HTTP methods
POST
Request body for POST
Lightning Model Types Input
JSON example
{
  "language": "en_US",
  "typeConfigs": [
    {
      "descriptor": "lightningType/lightning__textType",
      "schemaConfig": {
        "subSchemaDefinitions": true
      },
      "editorConfig": {
        "target": "LightningDesktopGenAi"
      },
      "rendererConfig": {
        "target": "LightningDesktopGenAi"
      }
    },
    {
      "descriptor": "apexClassType/c__Hotel",
      "schemaConfig": {
        "subSchemaDefinitions": true
      },
      "editorConfig": {
        "target": "LightningDesktopGenAi"
      },
      "rendererConfig": {
        "target": "LightningDesktopGenAi"
      }
    },
    {
      "descriptor": "apexClassType/c__FlightBookingAgent$Flight",
      "schemaConfig": {
        "subSchemaDefinitions": true
      },
      "editorConfig": {
        "target": "LightningDesktopGenAi"
      },
      "rendererConfig": {
        "target": "LightningDesktopGenAi"
      }
    }
  ]
}
Properties
Name Type Description Required or Optional Available Version
language String Language or locale code, such as es or en_US, to retrieve the title and description of a type. If unspecified, the logged-in user’s language is used. The fallback language is English in case translations don’t exist. Optional 64.0
typeConfigs Lightning Model Types Config[] List of lightning model types configurations. Required 64.0
Response body for POST
Lightning Model Types Collection