Component Registry

Read the configuration schema of a method version.

Changed on
get/component-registry/methods/{componentVersionReference}/configuration-schema

Request

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

Path parameters

componentVersionReferencestring required

Query parameters

resolveDependenciesboolean

Response

Ok

docstring
expertboolean
labelstring
listboolean
modelFieldNamestring
multiLanguageDocobject
multiLanguageLabelobject
namestring
nonEmptyboolean
optionalboolean
schemaDefinitionFieldIndexinteger
schema_element_typestring required
uiFieldIndexinteger
defaultSubtypeboolean
fieldsobject
polymorphicboolean
typeNamestring
inlineboolean

Changes

    • breaking

      the ////// response's property type changed from object to no type for status

    • breaking

      the ///////// response's property type changed from object to no type for status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added subschema #2 to the ////// response property allOf list for the response status

    • info

      added subschema #2 to the ///////// response property allOf list for the response status

    • info

      added discriminator to ////// response property for the response status

    • info

      added discriminator to ///////// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the /// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the /////// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the /// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the // response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the // response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the ////// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the //// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the //////// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the ////// response property for the response status

    • info

      added SimulationConnectionsField discriminator mapping keys to the ////////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the /// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the /////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the ///// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the ///////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the /// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the // response property for the response status

    • info

      added MaterialField discriminator mapping keys to the // response property for the response status

    • info

      added MaterialField discriminator mapping keys to the ////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the //// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the //////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the ////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the ////////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the //////// response property for the response status

    • info

      added MaterialField discriminator mapping keys to the //////////// response property for the response status