SIsimscale
Component Registry

Read the metadata of a component version.

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

Request

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

Path parameters

componentVersionReferencestring required

Response

Ok

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"
}

Changes

No operation changes recorded.