Lightning Model Types

Get detailed information about each Lightning type and Apex class type.

Resource

1/connect/lightning-model/types

Available version

64.0

HTTP methods

POST

Request body for POST

Lightning Model Types Input

JSON example

1{
2  "language": "en_US",
3  "typeConfigs": [
4    {
5      "descriptor": "lightningType/lightning__textType",
6      "schemaConfig": {
7        "subSchemaDefinitions": true
8      },
9      "editorConfig": {
10        "target": "LightningDesktopGenAi"
11      },
12      "rendererConfig": {
13        "target": "LightningDesktopGenAi"
14      }
15    },
16    {
17      "descriptor": "apexClassType/c__Hotel",
18      "schemaConfig": {
19        "subSchemaDefinitions": true
20      },
21      "editorConfig": {
22        "target": "LightningDesktopGenAi"
23      },
24      "rendererConfig": {
25        "target": "LightningDesktopGenAi"
26      }
27    },
28    {
29      "descriptor": "apexClassType/c__FlightBookingAgent$Flight",
30      "schemaConfig": {
31        "subSchemaDefinitions": true
32      },
33      "editorConfig": {
34        "target": "LightningDesktopGenAi"
35      },
36      "rendererConfig": {
37        "target": "LightningDesktopGenAi"
38      }
39    }
40  ]
41}

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

Connect REST API Developer Guide

Lightning Model Types