Updates a saved view.
Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: <, >, &, ", ', .
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Please use https://www.itwinjs.org/reference/imodeljs-common/views/viewstateprops/ for reference
Request body
SavedViewUpdate
Group ID
Saved View Name
Flag for whether or not Saved View is shared
Tags of Saved View
Example
{ "savedViewData": { "itwin3dView": { "origin": [ 0.0, 0.0, 0.0 ], "extents": [ 100.0, 100.0, 100.0 ], "angles": { "yaw": 90.0, "pitch": 90.0, "roll": 90.0 }, "camera": { "lens": 90.0, "focusDist": 1.0, "eye": [ 0.0, 0.0, 0.0 ] }, "categories": { "enabled": [ "0x12", "0x13" ], "disabled": [ "0x14", "0x15" ] }, "models": { "enabled": [ "0x12", "0x13" ], "disabled": [ "0x14", "0x15" ] } } }, "groupId": "AKX-Arab1o1NqdQwr7zIr3KNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ", "displayName": "Saved View Test Name", "shared": false, "tagIds": [ "ABRBqKCBtXZCl_ax5ZFB9uaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ" ] }
Response 200 OK
Updated saved view.
{ "savedView": { "id": "ACZbDmWhULVChRcDRkoPdLaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ", "displayName": "Test Name", "shared": false, "creationTime": "2022-10-04T16:14:08.335Z", "lastModified": "2022-10-07T13:15:25.224Z", "tags": [{ "displayName": "Tag Test Name", "id": "ABRBqKCBtXZCl_ax5ZFB9uaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ" }], "_links": { "iTwin": { "href": "https://api.bentley.com/path1/path2/id" }, "imodel": { "href": "https://api.bentley.com/path1/path2/id" }, "creator": { "href": "https://api.bentley.com/path1/path2/id" }, "group": { "href": "https://api.bentley.com/path1/path2/id" }, "image": { "href": "https://api.bentley.com/path1/path2/id" }, "thumbnail": { "href": "https://api.bentley.com/path1/path2/id" } }, "savedViewData": { "itwin3dView": { "origin": [ 0, 0, 0 ], "extents": [ 100, 100, 100 ], "angles": { "yaw": 90, "pitch": 90, "roll": 90 }, "camera": { "lens": 90, "focusDist": 1, "eye": [ 0, 0, 0 ] }, "categories": { "enabled": [ "0x12", "0x13" ], "disabled": [ "0x14", "0x15" ] }, "models": { "enabled": [ "0x12", "0x13" ], "disabled": [ "0x14", "0x15" ] } } } } }
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 403 Forbidden
The user has insufficient permissions for the requested operation.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 404 Not Found
Requested savedview is not available.
{ "error": { "code": "SavedViewNotFound", "message": "Requested savedview is not available." } }
Response 422 Unprocessable Entity
Cannot update saved view.
{ "error": { "code": "InvalidSavedviewsRequest", "message": "Cannot update saved view.", "details": [{ "code": "InvalidRequestBody", "message": "displayName must be a string.", "target": "displayName" }] } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Link
Http reference
ViewYawPitchRoll
Yaw (rotation of x towards y) of the orientation, in degrees
Pitch (rotation that raises x towards z) of the orientation, in degrees
Roll (rotation of y towards z) of the orientation, in degrees
ViewCamera
Angle of the camera lens, in degrees
Focal distance of the lens, in meters
Location of the eye of the camera. (Array of numbers representing x, y and z)
ViewVisibilityList
List of Ids that should be enabled/visible.
List of Ids that should be disabled/hidden.
ViewItwin3d
The lower left back corner of the view frustum. (Array of numbers representing x, y and z)
The extent of the view frustum. (Array of numbers representing x, y and z)
ViewItwinSheet
Base model Id
Origin. (Array of numbers representing x and y)
Delta. (Array of numbers representing x and y)
Angle, in degrees.
Width of the sheet, in meters
Height of the sheet, in meters
Scale of the sheet
Sheet template Id
List of Ids
ViewItwinDrawing
Base model Id
Origin. (Array of numbers representing x and y)
Delta. (Array of numbers representing x and y)
Angle, in degrees.
The Id of the spatial view from which the SectionDrawing was generated.
If true, the spatial view should be displayed in the context of the drawing view.
Transform from drawing coordinates to spatial coordinates. If undefined, use identity transform. 3 X 4 transformation matrix containing 3 arrays of matrix rows consisting of 4 numbers each: [qx qy qz ax] where the fourth columnn in each row holds the translation.
The extents of the DrawingModel, used for determining the upper limits of the view's extents.
View
SavedViewTag
Linked Tag identifier
SavedViewLinks
ViewWithLegacy
Legacy data, un-updatable, will soon be deprecated move to new service
SavedViewResponse
SavedViewUpdate
Group ID
Saved View Name
Flag for whether or not Saved View is shared
Tags of Saved View
ViewFlagProps renderMode
Render mode.
ViewFlagProps
If true, don't show construction class.
If true, don't show dimension class.
If true, don't show patterns.
If true, don't line weights.
If true, don't line styles.
If true, don't use transparency.
If true, don't show filled regions.
If true, don't show textures.
If true, don't show materials.
If true, show visible edges.
If true, show hidden edges.
If true, show shadows.
If true, use the view's clipping volume. Has no effect on other types of clips like ModelClipGroups.
If true, use hidden line material colors.
If true, show view with monochrome settings.
Display background map.
If true, show ambient occlusion.
RgbColorProps
Red value between [0, 255]
Green value between [0, 255]
Blue value between [0, 255]
DisplayStyleSubCategoryProps
Whether the subcategory is invisible or not.
The line width in pixels. Must be a value between [1,32].
Style Id to use.
Priority.
Material Id to use.
Transparency. Must be a value in the range [0,1]. 0.0 means fully opaque, and 1.0 means fully transparent.
Fill transparency. Must be a value in the range [0,1]. 0.0 means fully opaque, and 1.0 means fully transparent.
The Id of the SubCategory whose appearance is to be overridden.
TerrainProps heightOriginMode
Determines how/if the heightOrigin is applied to the terrain height.
TerrainProps
Identifies the provider currently only CesiumWorldTerrain is supported.
A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration.
Applying lighting can help to visualize subtle terrain variation.
Origin value - height of the IModel origin at the project center as defined by heightOriginMode.
Determines how/if the heightOrigin is applied to the terrain height.
PlanarClipMaskProps mode
Controls how the mask geometry is collected.
PlanarClipMaskProps priority
The priority of the planar clip mask.
PlanarClipMaskProps
Compressed Id set containing the model Ids.
Compressed Id set containing the sub category or element Ids.
The transparency of the planar clip mask. Between 0 (complete masking) and 1 (no masking).
A value of true indicates that the mask should be inverted and only content within the mask should be displayed.
BackgroundMapProps globeMode
Globe Mode.
BackgroundMapProps
The elevation of the map in meters relative the WGS84 ellipsoid.
A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.
If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry.
If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane.
If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it allows the user to select elements that are behind the map.
RealityDataSourceKey
The provider that supplies the access to reality data source for displaying the reality model.
The format used by the provider to store the reality data.
The reality data id that identify a reality data for the provider.
The context id that was used when reality data was attached - if none provided, current session iTwinId will be used.
SpatialClassifierFlagsProps inside
Describes how a SpatialClassifier affects the display of classified geometry - that is, geometry intersecting the classifier.
SpatialClassifierFlagsProps outside
Describes how a SpatialClassifier affects the display of unclassified geometry - that is, geometry not intersecting the classifier.
SpatialClassifierFlagsProps
Describes how a SpatialClassifier affects the display of classified geometry - that is, geometry intersecting the classifier.
Describes how a SpatialClassifier affects the display of unclassified geometry - that is, geometry not intersecting the classifier.
True for volume classification; false for planar classification.
SpatialClassifierProps
The Id of the GeometricModel whose geometry is used to produce the classifier.
A distance in meters by which to expand the classifier geometry. For example, if line strings are used to represent streets, you might expand them to the average width of a street.
A user-friendly name, useful for identifying individual classifiers within a SpatialClassifiers.
Records whether this is the active classifier.
FeatureAppearanceProps linePixels
The pixel pattern used to draw lines.
FeatureAppearanceProps
The line weight in pixels as an integer in [1, 31]
The transparency in the range [0.0, 1.0] where 0 indicates fully opaque and 1 indicates fully transparent.
The pixel pattern used to draw lines.
If true, ignore the RenderMaterial associated with surfaces.
If true, the associated Feature will not be drawn when using Viewport.readPixels.
If true, the associated Feature will be emphasized. Emphasized features are rendered using the Hilite.Settings defined by Viewport.emphasisSettings
ContextRealityModelProps
The URL that supplies the 3d tiles for displaying the reality model.
Id of reality data.
An optional, user-friendly name for the reality model suitable for display in a user interface.
An optional, user-friendly description of the reality model suitable for display in a user interface.
MapImageryProps
The settings for the base layer.
Background layer settings.
Overlay layer settings.
DisplayStyleModelAppearanceProps linePixels
The pixel pattern used to draw lines.
DisplayStyleModelAppearanceProps
The line weight in pixels as an integer in [1, 31]
The transparency in the range [0.0, 1.0] where 0 indicates fully opaque and 1 indicates fully transparent.
The pixel pattern used to draw lines.
If true, ignore the RenderMaterial associated with surfaces.
If true, the associated Feature will not be drawn when using Viewport.readPixels.
If true, the associated Feature will be emphasized. Emphasized features are rendered using the Hilite.Settings defined by Viewport.emphasisSettings
The Id of the model whose appearance is to be overridden.
ViewFlagOverrides renderMode
The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.
ViewFlagOverrides
The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.
Whether to display geometry of class GeometryClass.Dimension.
Whether to display geometry of class GeometryClass.Pattern.
Whether to allow lines and edges to draw with width greater than one pixel.
Whether LinePixels are allowed to apply patterns to lines and edges. If false, they all draw as solid lines.
Whether element transparency is applied. If false, transparent geometry is drawn opaque.
In RenderMode.Wireframe only, whether to display the interiors of planar regions with FillFlags.ByView.
In RenderMode.SmoothShade, whether to apply RenderTextures to surfaces.
In RenderMode.SmoothShade, whether to apply RenderMaterial]s to surfaces.
Whether to display a graphical representation of the view's AuxCoordSystem.
Whether to display a grid.
In RenderMode.SmoothShade, whether to display the edges of surfaces.
In any mode except RenderMode.Wireframe, whether to display the edges of surfaces occluded by other geometry. This has no effect unless visibleEdges is also true.
In RenderMode.SmoothShade, whether to display solar shadows. This has no effect unless lighting is also true.
Whether to apply the view's clip volume to the geometry in the scene.
Whether to display geometry of class GeometryClass.Construction.
Whether to produce a monochrome image.
Whether to display background map imagery.
In RenderMode.SmoothShade, whether to apply AmbientOcclusion.
If true, overlay surfaces with wiremesh to reveal their triangulation.
In RenderMode.SmoothShade, whether to apply lighting to surfaces.
HiddenLineStyleProps pattern
If defined, the pixel pattern used to draw the edges. If undefined, edges are drawn using the element's line pattern.
HiddenLineStyleProps
If true, color is overridden.
If defined, the pixel pattern used to draw the edges. If undefined, edges are drawn using the element's line pattern.
If defined, the width of the edges in pixels. If undefined (or 0), edges are drawn using the element's line width. Should be an integer between [1,32]
HiddenLineSettingsProps
A value in the range [0.0, 1.0] specifying a threshold below which transparent surfaces should not be drawn. A value of 0.0 indicates any surface that is not 100% opaque should not be drawn. A value of 0.25 indicates any surface that is less than 25% opaque should not be drawn. A value of 1.0 indicates that all surfaces should be drawn regardless of transparency.
CutStyleProps
ClipIntersectionStyleProps
Number of pixels to be considered intersecting the clip plane, default 1.
ClipStyleProps
If true, geometry will be produced at the clip planes in a 3d view. - Solids (closed volumes) will produce facets on the clip planes. - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
Controls aspects of how the cut geometry is displayed, if produceCutGeometry is true.
If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped.
If 'true', intersection of geometry and clip planes will be colorized.
Controls the style of the intersection of geometry and clip planes.
DisplayStylePlanarClipMaskProps mode
Controls how the mask geometry is collected.
DisplayStylePlanarClipMaskProps priority
The priority of the planar clip mask.
DisplayStylePlanarClipMaskProps
Controls how the mask geometry is collected.
Compressed Id set containing the model Ids.
Compressed Id set containing the sub category or element Ids.
The priority of the planar clip mask.
The transparency of the planar clip mask. Between 0 (complete masking) and 1 (no masking).
A value of true indicates that the mask should be inverted and only content within the mask should be displayed.
The Id of the model to mask.
GroundPlaneProps
Whether the ground plane should be displayed.
The Z height at which to draw the ground plane.
SkyCubeProps
JSON representation of the front image used by a SkyCube. Can be an image URL or the Id of a texture element.
JSON representation of the back image used by a SkyCube. Can be an image URL or the Id of a texture element.
JSON representation of the top image used by a SkyCube. Can be an image URL or the Id of a texture element.
JSON representation of the bottom image used by a SkyCube. Can be an image URL or the Id of a texture element.
JSON representation of the right image used by a SkyCube. Can be an image URL or the Id of a texture element.
JSON representation of the left image used by a SkyCube. Can be an image URL or the Id of a texture element.
SkyBoxImageProps type
Type of skybox image.
SkyBoxImageProps
The image to map to the interior of the sphere.
SkyBoxProps
Whether or not the skybox should be displayed
For a SkyGradient, if true, a 2-color gradient skybox is used instead of a 4-color.
For a 4-color SkyGradient, controls speed of change from sky color to zenith color; otherwise unused.
For a 4-color SkyGradient, controls speed of change from ground color to nadir color; otherwise unused.
EnvironmentProps
AmbientOcclusionProps
If defined, represents an angle in degrees. If the dot product between the normal of the sample and the vector to the camera is less than this value, sampling stops in the current direction. This is used to remove shadows from near planar edges.
If defined, if the distance in linear depth from the current sample to first sample is greater than this value, sampling stops in the current direction. The full range of linear depth is 0 to 1.
If defined, the maximum distance from the camera's near plane in meters at which ambient occlusion will be applied.
If defined, raise the final ambient occlusion to the power of this value. Larger values make the ambient shadows darker.
If defined, indicates the distance to step toward the next texel sample in the current direction.
If defined, blurDelta is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma)).
If defined, blurSigma is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma)).
If defined, blurTexelStepSize indicates the distance to the next texel for blurring.
SolarShadowSettingsProps
PortraitProps
Intensity of the portrait light.
SolarLightProps
Intensity of the light.
Direction of the light in world coordinates.
If true, the light will be applied even when shadows are turned off for the view. If false, a roughly overhead light of the same intensity oriented in view space will be used instead.
If defined, the time in UNIX milliseconds from which direction was calculated.
HemisphereLightsProps
AmbientLightProps
Intensity of the lights.
FresnelSettingsProps
Intensity of the fresnel.
Whether to inver the fresnel.
LightSettingsProps
Specular intensity applied to all lights.
Applies a cel-shaded effect. If greater than zero, specifies the number of cels.
DisplayStyle3dSettingsProps monochromeMode
The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).
DisplayStyle3dSettingsProps
The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).
The id of a Render Timeline element containing a schedule script that can be used to animate the view.
The point in time reflected by the view, in UNIX seconds.
Overrides applied to the appearances of subcategories in the view.
A list of ContextRealityModels attached to a DisplayStyleSettings.
Ids of elements not to be displayed in the view. It is preferred to use the compressed format, as the number of Ids may be quite large.
Overrides applied to the appearance of models in the view.
Settings controlling how plan projection models are to be rendered. The key for each entry is the Id of the model to which the settings apply.
DisplayStyleSettingsProps monochromeMode
The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).
DisplayStyleSettingsProps
The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).
The id of a Render Timeline element containing a schedule script that can be used to animate the view.
The point in time reflected by the view, in UNIX seconds.
Overrides applied to the appearances of subcategories in the view.
A list of ContextRealityModels attached to a DisplayStyleSettings.
Ids of elements not to be displayed in the view. It is preferred to use the compressed format, as the number of Ids may be quite large.
Overrides applied to the appearance of models in the view.
ShapeProps
The points describing the polygon.
Transform applied to the polygon.
Lower bound on Z.
Upper bound on Z.
true if this shape is a mask.
true if this shape is invisible.
ClipPrimitiveShapeProps
PlanesProps
true if the primitive is a hole.
ClipPrimitivePlaneProps
ExtensionLinks
ExtensionPayload
SavedViewWithData
Unique identifier
User visible name
Flag for whether or not element is shared
ISO-8601 compliant time (UTC) the saved view was created.
ISO-8601 compliant time (UTC) the saved view was last modified.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.