SIsimscale
Reports

POST /projects/{projectId}/reports/from-state

Changed on

Request

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

Path parameters

projectIdstring required
Example:1234123412341234

The project ID

Request body

namestring required

The name of the report.

descriptionstring

The description of the report.

resultIdsstring[] required

The IDs of the results for which the report should be created.

reportIdstring uuid

If provided, the newly created report will have this value for its UUID.

trigger'API_GENERIC' | 'WORKBENCH_GENERIC' | 'WORKBENCH_ANIMATION_RECORDING' | 'AI_AGENT_GENERIC' | 'AI_AGENT_PREVIEW'

Identifies where/why a report was triggered (the creating flow). Defaults to API_GENERIC for callers that do not specify it. AI_AGENT_PREVIEW marks ephemeral preview images created for the AI agent; these are cleaned up automatically.

Response

Created

reportIdstring uuid required

The ID of the report.

namestring required

The name of the report.

descriptionstring

The description of the report.

createdAtstring date-time required

The time the report was created.

startedAtstring date-time

The time the report was started.

finishedAtstring date-time

The time the report was finished.

status'READY' | 'QUEUED' | 'RUNNING' | 'FINISHED' | 'CANCELED' | 'FAILED' required

Status of the report operation.

rampsIdstring uuid

The RAMPS result of a dataflow output for which the report was created; absent for reports on simulation results (resultIds).

resultIdsstring[]

The resultIds the report has been created for.

statisticsResultobject

Result of a STATISTICS report. Contains one entry per requested part identifier, part group identifier, or cutting plane identifier, each mapping to a StatisticsResultEntry. Null entries indicate that the part or plane was not found in the model.

Changes

  • 0c004cba3198Revision changes
    • info

      added the optional property to the response with the status

  • ef7bda66fd28Revision changes
    • breaking

      the //////// response property's min was decreased from 0.01 to 0.00 for the response status

    • breaking

      the //////// response property's min was decreased from 0.01 to 0.00 for the response status

    • breaking

      the /////// response property's min was decreased from 0.01 to 0.00 for the response status

    • breaking

      the /////// response property's min was decreased from 0.01 to 0.00 for the response status

    • info

      the //////// request property's min was decreased from 0.01 to 0.00

    • info

      the //////// request property's min was decreased from 0.01 to 0.00