Lightning Type

Get detailed information, such as JSON schema definition, editor configuration, and renderer configuration about each Lightning type.
Resource
/connect/lightning-types/fullyQualifiedName
Available version
64.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
editorConfig​Target String Editor configuration targets for the lightning type. In version 64.0 and later, LightningDesktopGenAi is the only valid value. Optional 64.0
includeSubSchema​Definitions Boolean Specifies whether to include sub-schema definitions (true) or not (false). Optional 64.0
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
rendererConfig​Target String Renderer configuration targets for the lightning type. In version 64.0 and later, LightningDesktopGenAi is the only valid value. Optional 64.0
Response body for GET
Lightning Type Detail