latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Component Registry

Read the metadata of a component group.

get/component-registry/component-groups/{componentGroupReference}

Path parameters

componentGroupReferencestring required

Query parameters

languagestring

Response

componentGroupReferencestring

Reference to a component group.

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

It is expressed as a string where the levels are separated with a dot (.).

descriptionstring

hasChildrenboolean

multiLanguageDescriptionobject nullable

multiLanguageNameobject nullable

namestring

state'ACTIVE' | 'ARCHIVED'

Possible states of a component group.

Example response

{
  "componentGroupReference": "simscale.cad.data-types"
}