SIsimscale
Component Registry

Read the metadata of a component group.

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

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/component-registry/component-groups/{componentGroupReference}
  • Auth
    API key in header X-API-KEY

Path parameters

componentGroupReferencestring required

Query parameters

languagestring

Response

Ok

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
hasIconboolean
multiLanguageDescriptionobject nullable
multiLanguageNameobject nullable
namestring
state'ACTIVE' | 'ARCHIVED'

Possible states of a component group.

Example response

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

Changes