Sign in
latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Reports

put/projects/{projectId}/reports/{reportId}

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[] 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

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.

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.