latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Component Registry

Read an overview of a component.

get/component-registry/components/{componentReference}

Path parameters

componentReferencestring required

Query parameters

languagestring

Response

componentReferencestring

Reference to a component.

Components are organized into a group hierarchy which serves as a qualification mechanism to avoid collisions and also to group components semantically.

The fully qualified reference of a component follows the following syntax: [component_group]:[component].

componentType'DATA_TYPE' | 'METHOD' | 'WORKFLOW_TYPE' | 'PHYSICS_AI_MODEL' | 'ENGINEERING_AI_AGENT'

namestring nullable

state'ACTIVE' | 'ARCHIVED'

Possible states of a component.

Example response

{
  "componentReference": "simscale.cad.data-types:cad-model"
}