latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Component Registry

Read the metadata of a component version.

get/component-registry/component-versions/{componentVersionReference}

Path parameters

componentVersionReferencestring required

Response

componentVersionReferencestring

Reference to a component version.

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

Component versions follow the convention of semantic versioning.

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

descriptionstring

multiLanguageDescriptionobject nullable

multiLanguageNameobject nullable

namestring

releaseNotesstring nullable

state'SNAPSHOT' | 'RELEASE_CANDIDATE' | 'RELEASED' | 'DEPRECATED' | 'ARCHIVED'

Possible states of a component version.

Example response

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