SIsimscale
Simulations

Create a simulation setup

Changed on
post/projects/{projectId}/simulations

Request

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

Request body

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

Response

Successful creation of the simulation setup

simulationIdstring uuid
namestring

The name of the simulation.

Example response

{
  "simulationId": "260d260d-260d-260d-260d-260d260d260d",
  "name": "My first simulation"
}

Changes

  • 010fe1c8e638Revision changes
    • breaking

      removed from the //// request property oneOf list

    • breaking

      the //// request property type changed from no type to object

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      removed discriminator from //// request property

  • 494ce2aaf719Revision changes
    • info

      added VOCE_CHABOCHE discriminator mapping keys to the /////// request property

    • info

      added to the /////// request property oneOf list