Sign in
latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Simulation Runs

List available results for a simulation runs

get/projects/{projectId}/simulations/{simulationId}/runs/{runId}/results

Query parameters

limitinteger

The number of items to return.

pageinteger

The page number. Use in combination with limit.

typestring

The result type. The possible values are SOLUTION_FIELD, CONVERGENCE_PLOT, PLOT, TABLE.

The result type. The possible values are 'SOLUTION_FIELD', 'CONVERGENCE_PLOT', 'PLOT', 'TABLE'.

categorystring

The result category. For solution fields values include 'SOLUTION', 'AVERAGED_SOLUTION', 'TRANSIENT_SOLUTION', 'STATISTICAL_SURFACE_SOLUTION', etc. For convergence plots values include 'RESIDUALS_PLOT', 'NUMBER_OF_NEWTON_ITERATIONS', etc. For plots values include 'FORCE_PLOT', 'MOMENT_PLOT', 'FORCE_COEFFICIENTS_PLOT', 'PROBE_POINT_PLOT', 'AREA_AVERAGE', 'FACE_CALC', etc.

The result category. For solution fields values include 'SOLUTION', 'AVERAGED_SOLUTION', 'TRANSIENT_SOLUTION', 'STATISTICAL_SURFACE_SOLUTION', etc. For convergence plots values include 'RESIDUALS_PLOT', 'NUMBER_OF_NEWTON_ITERATIONS', etc. For plots values include 'FORCE_PLOT', 'MOMENT_PLOT', 'FORCE_COEFFICIENTS_PLOT', 'PROBE_POINT_PLOT', 'AREA_AVERAGE', 'FACE_CALC', etc.

quantitystring

The result quantity, only applies to plot result types. Valid values include 'Ux', 'Uy', 'Uz', 'p', 'k', 'omega', 'T', 'displacement', 'von Mises stress', etc.

The result quantity, only applies to plot result types. Valid values include 'Ux', 'Uy', 'Uz', 'p', 'k', 'omega', 'T', 'displacement', 'von Mises stress', etc.

namestring

The name that was defined for extra simulation result outputs

The name that was defined for extra simulation result outputs.

directionnumber

The result direction, only applies to Pedestrian Wind Comfort analysis

The result direction, only applies to Pedestrian Wind Comfort analysis.

Response

Successful operation

Example response

{
  "_links": {
    "first": {
      "href": "/projects?page={firstPage}&limit={limit}"
    },
    "prev": {
      "href": "/projects?page={previousPage}&limit={limit}"
    },
    "self": {
      "href": "/projects?page={currentPage}&limit={limit}"
    },
    "next": {
      "href": "/projects?page={nextPage}&limit={limit}"
    },
    "last": {
      "href": "/projects?page={lastPage}&limit={limit}"
    }
  },
  "_embedded": [
    {
      "type": "SOLUTION_FIELD",
      "resultId": "840c840c-840c-840c-840c-840c840c840c",
      "category": "STATISTICAL_SURFACE_SOLUTION",
      "modifiedAt": "2020-03-04T17:29:42Z",
      "download": {
        "format": "PVD",
        "uncompressedSizeInBytes": 4000,
        "url": "https://httpbin.org/bytes/4000",
        "compression": "ZIP64"
      }
    },
    {
      "type": "SOLUTION_FIELD",
      "resultId": "744e744e-744e-744e-744e-744e744e744e",
      "category": "TRANSIENT_SOLUTION",
      "direction": 0,
      "modifiedAt": "2020-03-04T17:29:42Z",
      "download": {
        "format": "ENSIGHT_GOLD",
        "uncompressedSizeInBytes": 8000,
        "url": "https://httpbin.org/bytes/8000",
        "compression": "ZIP64"
      }
    },
    {
      "type": "PLOT",
      "resultId": "148a148a-148a-148a-148a-148a148a148a",
      "category": "PROBE_POINT_PLOT",
      "name": "Probe point 1",
      "quantity": "p",
      "direction": 0,
      "modifiedAt": "2020-03-04T17:29:42Z",
      "download": {
        "format": "CSV",
        "uncompressedSizeInBytes": 2000,
        "url": "https://httpbin.org/bytes/2000",
        "compression": "NONE"
      }
    },
    {
      "type": "TABLE",
      "resultId": "670e670e-670e-670e-670e-670e670e670e",
      "category": "PROBE_POINT_PLOT",
      "name": "Probe point 1",
      "direction": 0,
      "modifiedAt": "2020-03-04T17:29:42Z",
      "download": {
        "format": "CSV",
        "uncompressedSizeInBytes": 1000,
        "url": "https://httpbin.org/bytes/1000",
        "compression": "NONE"
      }
    }
  ]
}