SIsimscale
Simulations

Get information about the simulation setup

Changed on
get/projects/{projectId}/simulations/{simulationId}

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/projects/{projectId}/simulations/{simulationId}
  • Auth
    API key in header X-API-KEY

Query parameters

simulationSpecSchemaVersionstring
Example:34.0

Version of the schema the simulation spec should conform to. This can be either the external version like 30.0, or the internal version like internal:549.

Response

Successful operation.

simulationIdstring uuid
namestring required
versionstring required

The schema version of the simulation spec. This can be either the external version like 30.0, or the internal version like internal:549.

createdAtstring date-time
modifiedAtstring date-time
cadIdstring uuid required

The ID of CAD input to the simulation.

stateIdstring uuid required

The ID of CAD state input to the simulation.

meshIdstring uuid

The generated mesh ID which is to be used in the simulation. This field should be left empty for analysis types that do not require a generated mesh like 'INCOMPRESSIBLE_PACEFISH', 'WIND_COMFORT', and 'SIMERICS_ANALYSIS'.

parametersParametricParameters

Changes

  • 010fe1c8e638Revision changes
    • breaking

      the //// response's property type changed from no type to object 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 the optional property ///// to the response with the 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 the optional property ///// to the response with the status

    • info

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

    • info

      removed discriminator from //// response property for the response status

    • info

      removed from the //// response property oneOf list for the response status

  • 494ce2aaf719Revision changes
    • breaking

      added to the /////// response property oneOf list for the response status

    • info

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