--- title: "GET /projects/{projectId}/reports" method: GET path: "/projects/{projectId}/reports" tags: ["Reports"] --- # GET /projects/{projectId}/reports `GET /projects/{projectId}/reports` ## Path parameters - `projectId` string, required ## Query parameters - `simulationId` string, uuid - `runId` string, uuid - `limit` integer - `page` integer ## Response `200` Ok - object - `_links` CollectionLinks - `first` object - `href` string — First page of the collection. - `prev` object - `href` string — Previous page in the collection. - `self` object - `href` string — Current page of the collection. - `next` object - `href` string — Next page in the collection. - `last` object - `href` string — Last page of the collection. - `_meta` CollectionMeta - `total` integer — Total number of resources in the collection. - `_embedded` ReportingReportResponse[] - `reportId` string, uuid, required — The ID of the report. - `name` string, required — The name of the report. - `description` string — The description of the report. - `createdAt` string, date-time, required — The time the report was created. - `startedAt` string, date-time — The time the report was started. - `finishedAt` string, date-time — The time the report was finished. - `status` 'READY' | 'QUEUED' | 'RUNNING' | 'FINISHED' | 'CANCELED' | 'FAILED', required — Status of the report operation. - `resultIds` string[] — The resultIds the report has been created for. - `reportProperties` union — Public counterpart of ReportProperties whose STATISTICS variant omits the server-resolved resolution hints (cadAssociations, topologyLabelByName). Used by the public ReportResponse; the report request and the internal report representation use ReportProperties, which carries those fields. - ReportingAnimationReportProperties - `reportType` string, required - `modelSettings` ReportingModelSettings, required - `parts` ReportingPart[] — The parts to show or hide in the report (see hideSelectedParts). - `partIdentifier` string, required — The identifier of the part in the result. - `parentIdentifier` string — The identifier of the parent of the part in the result. This value is necessary in cases where multiple parts appear in the result with the same name/identifier. - `opacity` number, double - `renderMode` 'SURFACES_WITH_WIREFRAME' | 'WIREFRAME' | 'SURFACES' | 'SURFACES_WITH_MESH' | 'MESH' - `solidColor` ReportingColor - … - `hideSelectedParts` boolean, required — If set to true, the parts array indicates the hidden parts, while the rest of the model parts are visible (blacklist). On the other hand, if set to false, then the parts array indicate the visible parts while the rest of the model parts are hidden (whitelist). If the parts array is empty, then setting this value to true will hide all the model parts, while setting it to false will show all the model parts. - `showVolumes` boolean — If set to false, then volumes will be hidden unless they are mentioned explicitly, i.e. when a volume is included in the parts array, and hideSelectedParts is set to false. - `scalarField` ReportingScalarField - `fieldName` string, required - `component` string - `dataType` 'POINT' | 'CELL', required - `scalarSettings` ReportingScalarSettings[] - `scalarField` ReportingScalarField, required - … - `minimumRange` number, float — The minimum value for the color scheme to fill. Default is the minimum value of the scalar. - `maximumRange` number, float — The maximum value for the color scheme to fill. Default is the maximum value of the scalar. - `nodeAverageValue` boolean — Specify if the scalar result should be shown as a node averaged result or not. - `numberOfDivisions` integer — The number of divisions in the legend. If set to 0, this will create a continuous (gradient) legend with a smooth interpolation between the colors. - `colorScheme` 'NORMAL' | 'NORMAL_INVERTED' | 'BLACK_TO_WHITE' | 'WHITE_TO_BLACK' | 'GREEN_TO_BROWN' | 'WHITE_TO_BROWN' | 'METAL_CASTING' | 'BLUE_TO_WHITE_TO_RED' | 'THERMAL_1' | 'THERMAL_2' | 'THERMAL_3' — The color scheme to use to map scalar values on the model and legend bar. - `colorLegendScaling` 'FULL_RANGE' | 'VISIBLE_ITEMS' | 'VISIBLE_ITEMS_WITH_INNER_VOLUME' — How the color legend range is scaled when minimumRange/maximumRange are not given. FULL_RANGE uses the whole dataset (all parts, shown or hidden). VISIBLE_ITEMS scales to only the currently visible items. VISIBLE_ITEMS_WITH_INNER_VOLUME additionally folds in the inner volume behind visible faces. Ignored when minimumRange/maximumRange are provided (an explicit range always wins). - `belowRangeColor` ReportingColor - … - `aboveRangeColor` ReportingColor - … - `vectorSettings` ReportingVectorSettings[] — The settings for the different vectors of the model. - `vectorField` ReportingVectorField, required - … - `scaleFactor` number, double, required - `solidColor` ReportingColor - … - `coloring` 'BY_VECTOR_FIELD' | 'SOLID_COLOR', required - `minimumClampingRange` number, float — The minimum length of (non-zero) vectors will be drawn as. Must not be larger than maximumClampingRange. Default value is the minimum length of the specified vector field. - `maximumClampingRange` number, float — The maximum length of (non-zero) vectors will be drawn as. Must not be smaller than minimumClampingRange. Default value is the maximum length of the specified vector field. - `minimumFilteringRange` number, float — The required minimum length of the vectors in order to be drawn. Must not be larger than maximumFilteringRange. Default value is the minimum length of the specified vector field. - `maximumFilteringRange` number, float — The required maximum length of the vectors in order to be drawn. Must not be smaller than minimumFilteringRange. Default value is the maximum length of the specified vector field. - `opacity` number, double - `renderMode` 'SURFACES_WITH_WIREFRAME' | 'WIREFRAME' | 'SURFACES' | 'SURFACES_WITH_MESH' | 'MESH' - `solidColor` ReportingColor - `r` number, double, required - `g` number, double, required - `b` number, double, required - `filters` ReportingFilters - `cuttingPlanes` ReportingCuttingPlane[] - `name` string, required - `center` ReportingVector3D, required - … - `normal` ReportingVector3D, required - … - `opacity` number, double - `clipping` boolean, required - `vectorGridSpacing` number, double — This field is required if projectVectorsOntoPlane is set to true. - `scalarField` ReportingScalarField - … - `vectorField` ReportingVectorField - … - `solidColor` ReportingColor - … - `projectVectorsOntoPlane` boolean, required — If a vectorField is provided, this flag will project the vector field onto the cutting plane. - `renderMode` 'SURFACES_WITH_WIREFRAME' | 'WIREFRAME' | 'SURFACES' | 'SURFACES_WITH_MESH' | 'MESH' - `isoSurfaces` ReportingIsoSurface[] - `isoScalar` ReportingScalarField - … - `isoValue` number, float — The iso scalar value. Should be within the selected scalar range. Default value is the average between the min and max in the range. - `scalarField` ReportingScalarField - … - `solidColor` ReportingColor - … - `vectorField` ReportingVectorField - … - `opacity` number, double - `isoVolumes` ReportingIsoVolume[] - `isoScalar` ReportingScalarField - … - `minimumIsoValue` number, float — The iso scalar minimum value. Should be within the selected scalar range and smaller than the maximumIsoValue. Default value is the third of the range between min and max. - `maximumIsoValue` number, float — The iso scalar maximum value. Should be within the selected scalar range and larger than the minimumIsoValue. Default value is 2 thirds of the range between min and max. - `scalarField` ReportingScalarField - … - `solidColor` ReportingColor - … - `vectorField` ReportingVectorField - … - `opacity` number, double - `displacement` ReportingDisplacement - `field` ReportingVectorField, required - … - `scaleFactor` number, double, required - `particleTraces` ReportingParticleTrace[] - `seedSettings` ReportingSeedSettings, required - … - `visualizationStyle` union, required - … - `traceBothDirections` boolean, required — If set to true, the trace will be computed both forwards and backwards from the seed points. - `scalarField` ReportingScalarField - … - `solidColor` ReportingColor - … - `cameraSettings` union, required - ReportingUserInputCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `up` ReportingVector3D, required - … - `eye` ReportingVector3D, required - … - `center` ReportingVector3D, required - … - `frontPlaneFrustumHeight` number — required only for orthogonal projection type. - `fieldOfViewYDegrees` number — The total field of view in Y direction in degrees. Required onlyf for perspective projection type. - ReportingTopViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE' | 'X_POSITIVE' | 'Y_NEGATIVE' | 'Y_POSITIVE' | 'Z_NEGATIVE' | 'Z_POSITIVE', required - ReportingFortyFiveViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_POSITIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_POSITIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_POSITIVE_Z_POSITIVE', required - `outputSettings` union, required - ReportingTimeStepAnimationOutputSettings - `name` string, required - `format` 'GIF' | 'MP4', required - `resolution` ReportingResolutionInfo, required - … - `frameRate` integer, required - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - … - `type` string, required - `fromFrameIndex` integer, required - `toFrameIndex` integer — Index of the last frame to include (inclusive). Defaults to the last available frame when not provided. - `skipFrames` integer, required - ReportingParticleTraceAnimationOutputSettings - `name` string, required - `format` 'GIF' | 'MP4', required - `resolution` ReportingResolutionInfo, required - … - `frameRate` integer, required - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - … - `type` string, required - `frameIndex` integer — Default is the last frame (time step) in the result. - `steps` integer, required — The number of steps to generate for the particle trace animation. - ReportingShapeAnimationOutputSettings - `name` string, required - `format` 'GIF' | 'MP4', required - `resolution` ReportingResolutionInfo, required - … - `frameRate` integer, required - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - … - `type` string - `frameIndex` integer — Frame (or frequency) for which to create a mode shape animation.Default is the last frame in the result. - `steps` integer, required — The number of steps to generate for the shape animation - `range` 'FULL' | 'HALF' | 'QUARTER', required — How to deform the model for the animation. FULL implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape; do the same for the negative maximum deformation, then back (x_0 -> +x_max -> x_0 -> -x_max -> x_0). HALF implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape (x_0 -> +x_max -> x_0). QUARTER implies animating from the original, undeformed shape to the maxiumum displaced position (x_0 -> +x_max) - ReportingScreenshotReportProperties - `reportType` string, required - `modelSettings` ReportingModelSettings, required - `parts` ReportingPart[] — The parts to show or hide in the report (see hideSelectedParts). - `partIdentifier` string, required — The identifier of the part in the result. - `parentIdentifier` string — The identifier of the parent of the part in the result. This value is necessary in cases where multiple parts appear in the result with the same name/identifier. - `opacity` number, double - `renderMode` 'SURFACES_WITH_WIREFRAME' | 'WIREFRAME' | 'SURFACES' | 'SURFACES_WITH_MESH' | 'MESH' - `solidColor` ReportingColor - … - `hideSelectedParts` boolean, required — If set to true, the parts array indicates the hidden parts, while the rest of the model parts are visible (blacklist). On the other hand, if set to false, then the parts array indicate the visible parts while the rest of the model parts are hidden (whitelist). If the parts array is empty, then setting this value to true will hide all the model parts, while setting it to false will show all the model parts. - `showVolumes` boolean — If set to false, then volumes will be hidden unless they are mentioned explicitly, i.e. when a volume is included in the parts array, and hideSelectedParts is set to false. - `scalarField` ReportingScalarField - `fieldName` string, required - `component` string - `dataType` 'POINT' | 'CELL', required - `scalarSettings` ReportingScalarSettings[] - `scalarField` ReportingScalarField, required - … - `minimumRange` number, float — The minimum value for the color scheme to fill. Default is the minimum value of the scalar. - `maximumRange` number, float — The maximum value for the color scheme to fill. Default is the maximum value of the scalar. - `nodeAverageValue` boolean — Specify if the scalar result should be shown as a node averaged result or not. - `numberOfDivisions` integer — The number of divisions in the legend. If set to 0, this will create a continuous (gradient) legend with a smooth interpolation between the colors. - `colorScheme` 'NORMAL' | 'NORMAL_INVERTED' | 'BLACK_TO_WHITE' | 'WHITE_TO_BLACK' | 'GREEN_TO_BROWN' | 'WHITE_TO_BROWN' | 'METAL_CASTING' | 'BLUE_TO_WHITE_TO_RED' | 'THERMAL_1' | 'THERMAL_2' | 'THERMAL_3' — The color scheme to use to map scalar values on the model and legend bar. - `colorLegendScaling` 'FULL_RANGE' | 'VISIBLE_ITEMS' | 'VISIBLE_ITEMS_WITH_INNER_VOLUME' — How the color legend range is scaled when minimumRange/maximumRange are not given. FULL_RANGE uses the whole dataset (all parts, shown or hidden). VISIBLE_ITEMS scales to only the currently visible items. VISIBLE_ITEMS_WITH_INNER_VOLUME additionally folds in the inner volume behind visible faces. Ignored when minimumRange/maximumRange are provided (an explicit range always wins). - `belowRangeColor` ReportingColor - … - `aboveRangeColor` ReportingColor - … - `vectorSettings` ReportingVectorSettings[] — The settings for the different vectors of the model. - `vectorField` ReportingVectorField, required - … - `scaleFactor` number, double, required - `solidColor` ReportingColor - … - `coloring` 'BY_VECTOR_FIELD' | 'SOLID_COLOR', required - `minimumClampingRange` number, float — The minimum length of (non-zero) vectors will be drawn as. Must not be larger than maximumClampingRange. Default value is the minimum length of the specified vector field. - `maximumClampingRange` number, float — The maximum length of (non-zero) vectors will be drawn as. Must not be smaller than minimumClampingRange. Default value is the maximum length of the specified vector field. - `minimumFilteringRange` number, float — The required minimum length of the vectors in order to be drawn. Must not be larger than maximumFilteringRange. Default value is the minimum length of the specified vector field. - `maximumFilteringRange` number, float — The required maximum length of the vectors in order to be drawn. Must not be smaller than minimumFilteringRange. Default value is the maximum length of the specified vector field. - `opacity` number, double - `renderMode` 'SURFACES_WITH_WIREFRAME' | 'WIREFRAME' | 'SURFACES' | 'SURFACES_WITH_MESH' | 'MESH' - `solidColor` ReportingColor - `r` number, double, required - `g` number, double, required - `b` number, double, required - `filters` ReportingFilters - `cuttingPlanes` ReportingCuttingPlane[] - `name` string, required - `center` ReportingVector3D, required - … - `normal` ReportingVector3D, required - … - `opacity` number, double - `clipping` boolean, required - `vectorGridSpacing` number, double — This field is required if projectVectorsOntoPlane is set to true. - `scalarField` ReportingScalarField - … - `vectorField` ReportingVectorField - … - `solidColor` ReportingColor - … - `projectVectorsOntoPlane` boolean, required — If a vectorField is provided, this flag will project the vector field onto the cutting plane. - `renderMode` 'SURFACES_WITH_WIREFRAME' | 'WIREFRAME' | 'SURFACES' | 'SURFACES_WITH_MESH' | 'MESH' - `isoSurfaces` ReportingIsoSurface[] - `isoScalar` ReportingScalarField - … - `isoValue` number, float — The iso scalar value. Should be within the selected scalar range. Default value is the average between the min and max in the range. - `scalarField` ReportingScalarField - … - `solidColor` ReportingColor - … - `vectorField` ReportingVectorField - … - `opacity` number, double - `isoVolumes` ReportingIsoVolume[] - `isoScalar` ReportingScalarField - … - `minimumIsoValue` number, float — The iso scalar minimum value. Should be within the selected scalar range and smaller than the maximumIsoValue. Default value is the third of the range between min and max. - `maximumIsoValue` number, float — The iso scalar maximum value. Should be within the selected scalar range and larger than the minimumIsoValue. Default value is 2 thirds of the range between min and max. - `scalarField` ReportingScalarField - … - `solidColor` ReportingColor - … - `vectorField` ReportingVectorField - … - `opacity` number, double - `displacement` ReportingDisplacement - `field` ReportingVectorField, required - … - `scaleFactor` number, double, required - `particleTraces` ReportingParticleTrace[] - `seedSettings` ReportingSeedSettings, required - … - `visualizationStyle` union, required - … - `traceBothDirections` boolean, required — If set to true, the trace will be computed both forwards and backwards from the seed points. - `scalarField` ReportingScalarField - … - `solidColor` ReportingColor - … - `cameraSettings` union, required - ReportingUserInputCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `up` ReportingVector3D, required - … - `eye` ReportingVector3D, required - … - `center` ReportingVector3D, required - … - `frontPlaneFrustumHeight` number — required only for orthogonal projection type. - `fieldOfViewYDegrees` number — The total field of view in Y direction in degrees. Required onlyf for perspective projection type. - ReportingTopViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE' | 'X_POSITIVE' | 'Y_NEGATIVE' | 'Y_POSITIVE' | 'Z_NEGATIVE' | 'Z_POSITIVE', required - ReportingFortyFiveViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_POSITIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_POSITIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_POSITIVE_Z_POSITIVE', required - `outputSettings` ReportingScreenshotOutputSettings, required - `name` string, required - `format` 'PNG', required - `resolution` ReportingResolutionInfo, required - `x` integer, required - `y` integer, required - `frameIndex` integer — Default to the last timestep or frame in the result. - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - `r` number, double, required - `g` number, double, required - `b` number, double, required - union — Configuration for a statistics (bulk calculation) report. Computes scalar field statistics (minimum, maximum, average, integral, and area/volume-weighted equivalents) over model geometry at a chosen time step. At least one of partIdentifiers, partGroupIdentifiers, or cuttingPlanes must be provided. Parts are named surfaces or volumes that exist in the simulation result (e.g. wall patches in a CFD model or solid bodies in a structural model). Use partIdentifiers to get independent results per part, or partGroupIdentifiers to combine several parts into one aggregated result. Cutting planes are user-defined infinite planes that slice through the model geometry. They are specified by a point on the plane and a normal vector, and statistics are computed over the intersection. - object - `reportType` string, required - `partIdentifiers` string[], required — Names of individual model parts for which to compute statistics independently. Each name must exactly match a part name present in the simulation result. Each part produces a separate entry in the statisticsResult, keyed by part name. - `partGroupIdentifiers` ReportingStatisticsPartGroup[] — Named groups of parts whose bulk values are aggregated into a single combined result entry. Useful when several parts form a logical unit (e.g. all wall patches) and a single aggregated metric is needed. Each group produces one entry in the statisticsResult, keyed by the group identifier. - `identifier` string, required — Unique label for this group. Used as the key for this group's entry in the statisticsResult map returned when the report is finished. - `partNames` string[], required — Names of the model parts to include in this group. Each name must exactly match a part name present in the simulation result. Parts not found in the model are skipped. - `cuttingPlanes` ReportingStatisticsCuttingPlane[] — Cutting planes for which to compute statistics. A cutting plane is an infinite plane defined by a point and a normal vector that slices through the model. Statistics are computed over the intersection geometry. Each plane produces one entry in the statisticsResult, keyed by the plane identifier. - `identifier` string, required — Unique label for this cutting plane. Used as the key for this plane's entry in the statisticsResult map returned when the report is finished. - `position` ReportingVector3D, required - … - `normal` ReportingVector3D, required - … - `scalarField` ReportingScalarField, required - `fieldName` string, required - `component` string - `dataType` 'POINT' | 'CELL', required - `frameIndex` integer — Zero-based time step index at which to evaluate the field. When not provided, statistics are computed at the last available time step. - object - `reportType` string, required - `partIdentifiers` string[] — Names of individual model parts for which to compute statistics independently. Each name must exactly match a part name present in the simulation result. Each part produces a separate entry in the statisticsResult, keyed by part name. - `partGroupIdentifiers` ReportingStatisticsPartGroup[], required — Named groups of parts whose bulk values are aggregated into a single combined result entry. Useful when several parts form a logical unit (e.g. all wall patches) and a single aggregated metric is needed. Each group produces one entry in the statisticsResult, keyed by the group identifier. - `identifier` string, required — Unique label for this group. Used as the key for this group's entry in the statisticsResult map returned when the report is finished. - `partNames` string[], required — Names of the model parts to include in this group. Each name must exactly match a part name present in the simulation result. Parts not found in the model are skipped. - `cuttingPlanes` ReportingStatisticsCuttingPlane[] — Cutting planes for which to compute statistics. A cutting plane is an infinite plane defined by a point and a normal vector that slices through the model. Statistics are computed over the intersection geometry. Each plane produces one entry in the statisticsResult, keyed by the plane identifier. - `identifier` string, required — Unique label for this cutting plane. Used as the key for this plane's entry in the statisticsResult map returned when the report is finished. - `position` ReportingVector3D, required - … - `normal` ReportingVector3D, required - … - `scalarField` ReportingScalarField, required - `fieldName` string, required - `component` string - `dataType` 'POINT' | 'CELL', required - `frameIndex` integer — Zero-based time step index at which to evaluate the field. When not provided, statistics are computed at the last available time step. - object - `reportType` string, required - `partIdentifiers` string[] — Names of individual model parts for which to compute statistics independently. Each name must exactly match a part name present in the simulation result. Each part produces a separate entry in the statisticsResult, keyed by part name. - `partGroupIdentifiers` ReportingStatisticsPartGroup[] — Named groups of parts whose bulk values are aggregated into a single combined result entry. Useful when several parts form a logical unit (e.g. all wall patches) and a single aggregated metric is needed. Each group produces one entry in the statisticsResult, keyed by the group identifier. - `identifier` string, required — Unique label for this group. Used as the key for this group's entry in the statisticsResult map returned when the report is finished. - `partNames` string[], required — Names of the model parts to include in this group. Each name must exactly match a part name present in the simulation result. Parts not found in the model are skipped. - `cuttingPlanes` ReportingStatisticsCuttingPlane[], required — Cutting planes for which to compute statistics. A cutting plane is an infinite plane defined by a point and a normal vector that slices through the model. Statistics are computed over the intersection geometry. Each plane produces one entry in the statisticsResult, keyed by the plane identifier. - `identifier` string, required — Unique label for this cutting plane. Used as the key for this plane's entry in the statisticsResult map returned when the report is finished. - `position` ReportingVector3D, required - … - `normal` ReportingVector3D, required - … - `scalarField` ReportingScalarField, required - `fieldName` string, required - `component` string - `dataType` 'POINT' | 'CELL', required - `frameIndex` integer — Zero-based time step index at which to evaluate the field. When not provided, statistics are computed at the last available time step. - ReportingStatisticsGlobalMinMaxReportPropertiesPublic — The global min/max report configuration as returned in a report response: the scalar field whose extremes were sought and the solution steps that were scanned. - `reportType` string, required - `scalarField` ReportingScalarField, required - `fieldName` string, required - `component` string - `dataType` 'POINT' | 'CELL', required - `steps` ReportingStepSelector, required — Selects which solution steps to scan. A step is one entry in the result sequence: a time-step for a transient analysis, or a frequency for a harmonic analysis. Set selection to FIRST or LAST for a single boundary step, ALL for every step, or INDICES for a specific set given in indices (0-based). indices applies only when selection is INDICES. - `selection` 'FIRST' | 'LAST' | 'ALL' | 'INDICES', required - `indices` integer[] — The 0-based step indices to scan; used only when selection is INDICES. - `reportFromStateProperties` union - object - `reportType` string, required - `stateMetadata` union, required - object - `stateType` string, required - `stateAnalysisType` string, required — The analysis type (Mandatory for a DEFAULT state). - object - `stateType` string, required - `stateUuid` string, uuid, required — The UUID of the specific state (Mandatory for AUTOMATIC/MANUAL). - object - `stateType` string, required - `stateUuid` string, uuid, required — The UUID of the specific state (Mandatory for AUTOMATIC/MANUAL). - `outputSettings` union, required - ReportingTimeStepAnimationOutputSettings - `name` string, required - `format` 'GIF' | 'MP4', required - `resolution` ReportingResolutionInfo, required - … - `frameRate` integer, required - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - … - `type` string, required - `fromFrameIndex` integer, required - `toFrameIndex` integer — Index of the last frame to include (inclusive). Defaults to the last available frame when not provided. - `skipFrames` integer, required - ReportingParticleTraceAnimationOutputSettings - `name` string, required - `format` 'GIF' | 'MP4', required - `resolution` ReportingResolutionInfo, required - … - `frameRate` integer, required - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - … - `type` string, required - `frameIndex` integer — Default is the last frame (time step) in the result. - `steps` integer, required — The number of steps to generate for the particle trace animation. - ReportingShapeAnimationOutputSettings - `name` string, required - `format` 'GIF' | 'MP4', required - `resolution` ReportingResolutionInfo, required - … - `frameRate` integer, required - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - … - `type` string - `frameIndex` integer — Frame (or frequency) for which to create a mode shape animation.Default is the last frame in the result. - `steps` integer, required — The number of steps to generate for the shape animation - `range` 'FULL' | 'HALF' | 'QUARTER', required — How to deform the model for the animation. FULL implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape; do the same for the negative maximum deformation, then back (x_0 -> +x_max -> x_0 -> -x_max -> x_0). HALF implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape (x_0 -> +x_max -> x_0). QUARTER implies animating from the original, undeformed shape to the maxiumum displaced position (x_0 -> +x_max) - `cameraOverride` union - ReportingUserInputCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `up` ReportingVector3D, required - … - `eye` ReportingVector3D, required - … - `center` ReportingVector3D, required - … - `frontPlaneFrustumHeight` number — required only for orthogonal projection type. - `fieldOfViewYDegrees` number — The total field of view in Y direction in degrees. Required onlyf for perspective projection type. - ReportingTopViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE' | 'X_POSITIVE' | 'Y_NEGATIVE' | 'Y_POSITIVE' | 'Z_NEGATIVE' | 'Z_POSITIVE', required - ReportingFortyFiveViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_POSITIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_POSITIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_POSITIVE_Z_POSITIVE', required - `stateOverrides` ReportingStateOverrides — Render-time overrides applied on top of the fetched post-processor state, mirroring the report's own model/filter structure so each override is unambiguous. Additive - further sections (filters, ...) can be added over time without changing the report-from-state contract. - `modelSettings` ReportingModelSettingsOverride — Partial model settings applied as an override on top of the state's own model settings. All properties are optional; only those provided are overridden. - `scalarField` ReportingScalarField - … - `colorLegendScaling` 'FULL_RANGE' | 'VISIBLE_ITEMS' | 'VISIBLE_ITEMS_WITH_INNER_VOLUME' — Overrides how the color legend range is scaled for the active scalar (see ScalarSettings.colorLegendScaling): FULL_RANGE (whole dataset), VISIBLE_ITEMS (currently visible items only), or VISIBLE_ITEMS_WITH_INNER_VOLUME (visible items plus the inner volume behind visible faces). - `outOfRangeColors` ReportingOutOfRangeColorOverride — Out-of-range colors apply to an individual scalar, overriding what the state saved for it (including states/views with out-of-range colors switched off). This override requires the target field name. The colors are a per-scalar setting, a state can carry settings for several scalars. The target scalar can be one that has been applied to the model itself, globally, or one that was applied on a cutting plane, isosurface, isovolume or particle-trace. The override is considered valid only if the target scalar is in fact applied to either the model or a filter in the state/view, otherwise it will be rejected. This applies to automatic, manual and default states/vies. - … - `filters` ReportingFiltersOverride — Partial filter settings applied as an override on top of the state's own filters. All properties are optional; only those provided are overridden. - `displacement` ReportingDisplacement - … - object - `reportType` string, required - `stateMetadata` union, required - object - `stateType` string, required - `stateAnalysisType` string, required — The analysis type (Mandatory for a DEFAULT state). - object - `stateType` string, required - `stateUuid` string, uuid, required — The UUID of the specific state (Mandatory for AUTOMATIC/MANUAL). - object - `stateType` string, required - `stateUuid` string, uuid, required — The UUID of the specific state (Mandatory for AUTOMATIC/MANUAL). - `outputSettings` ReportingScreenshotOutputSettings, required - `name` string, required - `format` 'PNG', required - `resolution` ReportingResolutionInfo, required - `x` integer, required - `y` integer, required - `frameIndex` integer — Default to the last timestep or frame in the result. - `showLegend` boolean, required - `showCube` boolean, required - `backgroundColor` ReportingColor - `r` number, double, required - `g` number, double, required - `b` number, double, required - `cameraOverride` union - ReportingUserInputCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `up` ReportingVector3D, required - … - `eye` ReportingVector3D, required - … - `center` ReportingVector3D, required - … - `frontPlaneFrustumHeight` number — required only for orthogonal projection type. - `fieldOfViewYDegrees` number — The total field of view in Y direction in degrees. Required onlyf for perspective projection type. - ReportingTopViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE' | 'X_POSITIVE' | 'Y_NEGATIVE' | 'Y_POSITIVE' | 'Z_NEGATIVE' | 'Z_POSITIVE', required - ReportingFortyFiveViewPredefinedCameraSettings - `settingType` string, required - `projectionType` 'ORTHOGONAL' | 'PERSPECTIVE', required - `directionSpecifier` 'X_NEGATIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_NEGATIVE_Y_POSITIVE_Z_POSITIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_NEGATIVE_Z_POSITIVE' | 'X_POSITIVE_Y_POSITIVE_Z_NEGATIVE' | 'X_POSITIVE_Y_POSITIVE_Z_POSITIVE', required - `stateOverrides` ReportingStateOverrides — Render-time overrides applied on top of the fetched post-processor state, mirroring the report's own model/filter structure so each override is unambiguous. Additive - further sections (filters, ...) can be added over time without changing the report-from-state contract. - `modelSettings` ReportingModelSettingsOverride — Partial model settings applied as an override on top of the state's own model settings. All properties are optional; only those provided are overridden. - `scalarField` ReportingScalarField - … - `colorLegendScaling` 'FULL_RANGE' | 'VISIBLE_ITEMS' | 'VISIBLE_ITEMS_WITH_INNER_VOLUME' — Overrides how the color legend range is scaled for the active scalar (see ScalarSettings.colorLegendScaling): FULL_RANGE (whole dataset), VISIBLE_ITEMS (currently visible items only), or VISIBLE_ITEMS_WITH_INNER_VOLUME (visible items plus the inner volume behind visible faces). - `outOfRangeColors` ReportingOutOfRangeColorOverride — Out-of-range colors apply to an individual scalar, overriding what the state saved for it (including states/views with out-of-range colors switched off). This override requires the target field name. The colors are a per-scalar setting, a state can carry settings for several scalars. The target scalar can be one that has been applied to the model itself, globally, or one that was applied on a cutting plane, isosurface, isovolume or particle-trace. The override is considered valid only if the target scalar is in fact applied to either the model or a filter in the state/view, otherwise it will be rejected. This applies to automatic, manual and default states/vies. - … - `filters` ReportingFiltersOverride — Partial filter settings applied as an override on top of the state's own filters. All properties are optional; only those provided are overridden. - `displacement` ReportingDisplacement - … - `persist` boolean — When false, the rendered screenshot is not registered back into the project (ephemeral). Defaults to true. - `download` ReportingDownloadInfo - `format` string — The result format. - `uncompressedSizeInBytes` integer — The uncompressed size of the report result content. - `url` string, uri — URL for downloading the report result content. - `compression` 'NONE' | 'ZIP64' — The compression used for the report result download archive. - `statisticsResult` object — 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. - `minMaxResult` ReportingGlobalMinMaxResult — The global minimum and maximum of a scalar field across the entire model over the selected steps. - `field` string — The label of the scalar field whose global minimum and maximum are reported here. - `dataType` 'POINT' | 'CELL' - `minimum` ReportingGlobalMinMaxExtreme — A single located extreme (the minimum or the maximum) with its value, coordinates, part, and step. Whether the value is node- or cell-based is given by the result's dataType. - `value` ReportingMeasuredScalar — A scalar quantity paired with its unit string. - `value` number, double — The numeric value, or null when it could not be computed. - `unit` string - `coordinates` ReportingMeasuredVector — A 3-component spatial vector (e.g. a position or a centroid) paired with its length unit. - `value` number[] - `unit` string - `partName` string — The mesh part name the extreme was found on; null if the part could not be resolved. - `partLabel` string — The user-facing label of that part (resolved from the mesh topology); null when no label is available or the part could not be resolved. - `step` object — The step at which this extreme occurred (a time-step for transient analyses, a frequency for harmonic, etc). - `index` integer — Zero-based step index. - `name` string — The step's label (often the time value or frequency). - `maximum` ReportingGlobalMinMaxExtreme — A single located extreme (the minimum or the maximum) with its value, coordinates, part, and step. Whether the value is node- or cell-based is given by the result's dataType. - `value` ReportingMeasuredScalar — A scalar quantity paired with its unit string. - `value` number, double — The numeric value, or null when it could not be computed. - `unit` string - `coordinates` ReportingMeasuredVector — A 3-component spatial vector (e.g. a position or a centroid) paired with its length unit. - `value` number[] - `unit` string - `partName` string — The mesh part name the extreme was found on; null if the part could not be resolved. - `partLabel` string — The user-facing label of that part (resolved from the mesh topology); null when no label is available or the part could not be resolved. - `step` object — The step at which this extreme occurred (a time-step for transient analyses, a frequency for harmonic, etc). - `index` integer — Zero-based step index. - `name` string — The step's label (often the time value or frequency). - `failureReason` object - `severity` 'INFO' | 'SUCCESS' | 'WARNING' | 'ERROR' - `code` string — Code for e.g. programmatic handling of error conditions. - `message` string — Human-readable description of the entry. - `details` object — Additional data to interpret and handle the entry. --- [API](https://skmtc.net/simscale/apis/simscale-api.md) · [All operations](https://skmtc.net/simscale/apis/simscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/simscale/simscale-api/revisions/53223abaceb7/schema)