SIsimscale
Reports

PUT /projects/{projectId}/reports/{reportId}

Changed on

Request

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

Path parameters

projectIdstring required
Example:1234123412341234

The project ID

reportIdstring uuid required
Example:159c159c-159c-159c-159c-159c159c159c

The report ID

Request body

namestring required

The name of the report.

descriptionstring

The description of the report.

resultIdsstring[]

The ID of the simulation result for which the report is created. Exactly one entry, or empty when dataId is given.

dataIdstring

The Data ID of the dataflow output for which the report is created. The data must belong to the project and reference a RAMPS result; the report then stores and returns that result's ID as rampsId. When set, resultIds must be empty. Supported for animation and screenshot reports; statistics reports are not supported yet.

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

Accepted

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 new optional request property

    • info

      the request property became optional

    • 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