SIsimscale
Component Registry

Read an overview of a component.

Changed on
get/component-registry/components/{componentReference}

Request

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

Path parameters

componentReferencestring required

Query parameters

languagestring

Response

Ok

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' | 'MATERIAL'
namestring nullable
state'ACTIVE' | 'ARCHIVED'

Possible states of a component.

Example response

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

Changes

  • 3985cc1cb395Revision changes
    • warning

      added the new MATERIAL enum value to the response property for the response status