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.
Request body
SavedViewUpdate
Flag for whether or not Saved View is shared
Tags of Saved View
Group ID
Saved View Name
Example
{ "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"] } } }, "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.3350000+00:00", "lastModified": "2022-10-07T13:15:25.2240000+00:00", "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 client sent more requests than allowed by this API for the current tier of the client.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Link
Http reference
{ "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string", "example": "https://api.bentley.com/path1/path2/id", "description": "Http reference" } }, "additionalProperties": false }
View
{ "type": "object", "properties": { "itwin3dView": { "$ref": "#/components/schemas/ViewItwin3d" }, "itwinSheetView": { "$ref": "#/components/schemas/ViewItwinSheet" }, "itwinDrawingView": { "$ref": "#/components/schemas/ViewItwinDrawing" } }, "additionalProperties": false }
Error
Contains error information.
One of a server-defined set of error codes.
The target of the error.
A human-readable representation of the error.
{ "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "target": { "type": "string", "nullable": true, "description": "The target of the error." }, "message": { "type": "string", "description": "A human-readable representation of the error." } }, "description": "Contains error information.", "additionalProperties": true }
ShapeProps
true if this shape is a mask.
Lower bound on Z.
Upper bound on Z.
The points describing the polygon.
true if this shape is invisible.
Transform applied to the polygon.
{ "type": "object", "required": [ "points", "transform" ], "properties": { "mask": { "type": "boolean", "description": "`true` if this shape is a mask." }, "zLow": { "type": "number", "description": "Lower bound on Z." }, "zHigh": { "type": "number", "description": "Upper bound on Z." }, "points": { "type": "array", "items": { "type": "array", "items": { "type": "number" } }, "example": [ [ 1, 0, 0 ], [ 1, 1, 0 ] ], "description": "The points describing the polygon." }, "invisible": { "type": "boolean", "description": "`true` if this shape is invisible." }, "transform": { "type": "array", "items": { "type": "array", "items": { "type": "number" } }, "example": [ [ 1, 0, 0, 0 ], [ 0, 1, 0, 0 ], [ 0, 0, 1, 0 ] ], "description": "Transform applied to the polygon." } }, "additionalProperties": false }
ViewCamera
Location of the eye of the camera. (Array of numbers representing x, y and z)
Angle of the camera lens, in degrees
Focal distance of the lens, in meters
{ "type": "object", "required": [ "lens", "focusDist", "eye" ], "properties": { "eye": { "type": "array", "items": { "type": "number" }, "example": [ 0, 0, 0 ], "description": "Location of the eye of the camera. (Array of numbers representing x, y and z)" }, "lens": { "type": "number", "example": 90, "description": "Angle of the camera lens, in degrees" }, "focusDist": { "type": "number", "example": 1, "description": "Focal distance of the lens, in meters" } }, "additionalProperties": false }
PlanesProps
true if the primitive is a hole.
{ "type": "object", "required": [ "clips" ], "properties": { "clips": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClipPlaneProps" }, "description": "The set of clip planes." } }, "invisible": { "type": "boolean", "example": true, "description": "`true` if the primitive is a hole." } }, "additionalProperties": false }
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.
{ "type": "object", "properties": { "image": { "$ref": "#/components/schemas/SkyBoxImageProps" }, "display": { "type": "boolean", "description": "Whether or not the skybox should be displayed" }, "skyColor": { "$ref": "#/components/schemas/RgbColorProps" }, "twoColor": { "type": "boolean", "description": "For a SkyGradient, if true, a 2-color gradient skybox is used instead of a 4-color." }, "nadirColor": { "$ref": "#/components/schemas/RgbColorProps" }, "groundColor": { "$ref": "#/components/schemas/RgbColorProps" }, "skyExponent": { "type": "number", "description": "For a 4-color SkyGradient, controls speed of change from sky color to zenith color; otherwise unused." }, "zenithColor": { "$ref": "#/components/schemas/RgbColorProps" }, "groundExponent": { "type": "number", "description": "For a 4-color SkyGradient, controls speed of change from ground color to nadir color; otherwise unused." } }, "additionalProperties": false }
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)
{ "type": "object", "required": [ "origin", "extents" ], "properties": { "angles": { "$ref": "#/components/schemas/ViewYawPitchRoll" }, "camera": { "$ref": "#/components/schemas/ViewCamera" }, "models": { "$ref": "#/components/schemas/ViewVisibilityList" }, "origin": { "type": "array", "items": { "type": "number" }, "example": [ 0, 0, 0 ], "description": "The lower left back corner of the view frustum. (Array of numbers representing x, y and z)" }, "extents": { "type": "array", "items": { "type": "number" }, "example": [ 100, 100, 100 ], "description": "The extent of the view frustum. (Array of numbers representing x, y and z)" }, "categories": { "$ref": "#/components/schemas/ViewVisibilityList" }, "clipVectors": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClipPrimitivePlaneProps" }, { "$ref": "#/components/schemas/ClipPrimitiveShapeProps" } ] }, "description": "Array of clip vectors in the view." }, "displayStyle": { "$ref": "#/components/schemas/DisplayStyle3dSettingsProps" } }, "additionalProperties": false }
SavedViewTag
Linked Tag identifier
{ "type": "object", "required": [ "id", "displayName" ], "properties": { "id": { "type": "string", "example": "ABRBqKCBtXZCl_ax5ZFB9uaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ", "description": "Linked Tag identifier" }, "displayName": { "type": "string" } }, "additionalProperties": false }
SkyCubeProps
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 back 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.
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 right 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.
{ "type": "object", "required": [ "front", "back", "top", "bottom", "right", "left" ], "properties": { "top": { "type": "string", "description": "JSON representation of the top image used by a SkyCube. Can be an image URL or the Id of a texture element." }, "back": { "type": "string", "description": "JSON representation of the back image used by a SkyCube. Can be an image URL or the Id of a texture element." }, "left": { "type": "string", "description": "JSON representation of the left image used by a SkyCube. Can be an image URL or the Id of a texture element." }, "front": { "type": "string", "description": "JSON representation of the front image used by a SkyCube. Can be an image URL or the Id of a texture element." }, "right": { "type": "string", "description": "JSON representation of the right image used by a SkyCube. Can be an image URL or the Id of a texture element." }, "bottom": { "type": "string", "description": "JSON representation of the bottom image used by a SkyCube. Can be an image URL or the Id of a texture element." } }, "additionalProperties": false }
TerrainProps heightOriginMode
Determines how/if the heightOrigin is applied to the terrain height.
{ "enum": [ "Geodetic", "Geoid", "Ground" ], "type": "string", "example": "0", "description": "Determines how/if the heightOrigin is applied to the terrain height.", "title": "TerrainProps heightOriginMode" }
TerrainProps
A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration.
Origin value - height of the IModel origin at the project center as defined by heightOriginMode.
Identifies the provider currently only CesiumWorldTerrain is supported.
Applying lighting can help to visualize subtle terrain variation.
Determines how/if the heightOrigin is applied to the terrain height.
{ "type": "object", "properties": { "exaggeration": { "type": "number", "example": 1.2, "description": "A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration." }, "heightOrigin": { "type": "number", "example": 5, "description": "Origin value - height of the IModel origin at the project center as defined by heightOriginMode." }, "providerName": { "type": "string", "description": "Identifies the provider currently only CesiumWorldTerrain is supported." }, "applyLighting": { "type": "boolean", "example": true, "description": "Applying lighting can help to visualize subtle terrain variation." }, "heightOriginMode": { "enum": [ "Geodetic", "Geoid", "Ground" ], "type": "string", "example": "0", "description": "Determines how/if the heightOrigin is applied to the terrain height.", "title": "TerrainProps heightOriginMode", "$ref": "#/components/schemas/TerrainProps-heightOriginMode" } }, "additionalProperties": false }
CutStyleProps
{ "type": "object", "properties": { "viewflags": { "$ref": "#/components/schemas/ViewFlagOverrides" }, "appearance": { "$ref": "#/components/schemas/FeatureAppearanceProps" }, "hiddenLine": { "$ref": "#/components/schemas/HiddenLineSettingsProps" } }, "additionalProperties": false }
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.
{ "type": "object", "title": "Error Response", "required": [ "error" ], "properties": { "error": { "$ref": "#/components/schemas/Error", "description": "Error information." } }, "description": "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.", "additionalProperties": false }
PortraitProps
Intensity of the portrait light.
{ "type": "object", "properties": { "intensity": { "type": "number", "example": 0.3, "description": "Intensity of the portrait light." } }, "additionalProperties": false }
RgbColorProps
Red value between [0, 255]
Blue value between [0, 255]
Green value between [0, 255]
{ "type": "object", "required": [ "red", "green", "blue" ], "properties": { "red": { "type": "number", "maximum": 255, "minimum": 0, "description": "Red value between [0, 255]" }, "blue": { "type": "number", "maximum": 255, "minimum": 0, "description": "Blue value between [0, 255]" }, "green": { "type": "number", "maximum": 255, "minimum": 0, "description": "Green value between [0, 255]" } }, "additionalProperties": false }
ViewFlagProps renderMode
Render mode.
{ "enum": [ "Wireframe", "HiddenLine", "SolidFill", "SmoothShade" ], "type": "string", "example": "0", "description": "Render mode.", "title": "ViewFlagProps renderMode" }
ViewFlagProps
If true, don't show filled regions.
If true, don't line styles.
If true, show shadows.
If true, don't line weights.
If true, don't show patterns.
If true, don't show textures.
If true, use the view's clipping volume. Has no effect on other types of clips like ModelClipGroups.
If true, show view with monochrome settings.
If true, don't show materials.
If true, show hidden edges.
If true, don't show dimension class.
If true, show visible edges.
Display background map.
If true, don't use transparency.
If true, don't show construction class.
If true, show ambient occlusion.
If true, use hidden line material colors.
{ "type": "object", "properties": { "noFill": { "type": "boolean", "example": true, "description": "If true, don't show filled regions." }, "noStyle": { "type": "boolean", "example": true, "description": "If true, don't line styles." }, "shadows": { "type": "boolean", "example": true, "description": "If true, show shadows." }, "noWeight": { "type": "boolean", "example": true, "description": "If true, don't line weights." }, "noPattern": { "type": "boolean", "example": true, "description": "If true, don't show patterns." }, "noTexture": { "type": "boolean", "example": true, "description": "If true, don't show textures." }, "clipVolume": { "type": "boolean", "example": true, "description": "If true, use the view's clipping volume. Has no effect on other types of clips like ModelClipGroups." }, "monochrome": { "type": "boolean", "example": true, "description": "If true, show view with monochrome settings." }, "noMaterial": { "type": "boolean", "example": true, "description": "If true, don't show materials." }, "renderMode": { "enum": [ "Wireframe", "HiddenLine", "SolidFill", "SmoothShade" ], "type": "string", "example": "0", "description": "Render mode.", "title": "ViewFlagProps renderMode", "$ref": "#/components/schemas/ViewFlagProps-renderMode" }, "hiddenEdges": { "type": "boolean", "example": true, "description": "If true, show hidden edges." }, "noDimensions": { "type": "boolean", "example": true, "description": "If true, don't show dimension class." }, "visibleEdges": { "type": "boolean", "example": true, "description": "If true, show visible edges." }, "backgroundMap": { "type": "boolean", "example": true, "description": "Display background map." }, "noTransparency": { "type": "boolean", "example": true, "description": "If true, don't use transparency." }, "noConstructions": { "type": "boolean", "example": true, "description": "If true, don't show construction class." }, "ambientOcclusion": { "type": "boolean", "example": true, "description": "If true, show ambient occlusion." }, "hiddenLineMaterialColors": { "type": "boolean", "example": true, "description": "If true, use hidden line material colors." } }, "additionalProperties": false }
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.
If 'true', intersection of geometry and clip planes will be colorized.
{ "type": "object", "properties": { "cutStyle": { "$ref": "#/components/schemas/CutStyleProps" }, "insideColor": { "$ref": "#/components/schemas/RgbColorProps" }, "outsideColor": { "$ref": "#/components/schemas/RgbColorProps" }, "intersectionStyle": { "$ref": "#/components/schemas/ClipIntersectionStyleProps" }, "produceCutGeometry": { "type": "boolean", "example": true, "description": "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." }, "colorizeIntersection": { "type": "boolean", "example": true, "description": "If 'true', intersection of geometry and clip planes will be colorized." } }, "additionalProperties": false }
ExtensionLinks
{ "type": "object", "properties": { "href": { "type": "string" }, "extensionName": { "type": "string" } }, "additionalProperties": false }
SavedViewLinks
{ "type": "object", "required": [ "iTwin", "creator", "image", "thumbnail" ], "properties": { "group": { "$ref": "#/components/schemas/Link" }, "iTwin": { "$ref": "#/components/schemas/Link" }, "image": { "$ref": "#/components/schemas/Link" }, "imodel": { "$ref": "#/components/schemas/Link" }, "creator": { "$ref": "#/components/schemas/Link" }, "project": { "$ref": "#/components/schemas/Link" }, "thumbnail": { "$ref": "#/components/schemas/Link" } }, "additionalProperties": false }
ViewItwinSheet
Angle, in degrees.
Delta. (Array of numbers representing x and y)
Scale of the sheet
Width of the sheet, in meters
Height of the sheet, in meters
Origin. (Array of numbers representing x and y)
Base model Id
Sheet template Id
List of Ids
{ "type": "object", "required": [ "baseModelId", "origin", "delta", "angle" ], "properties": { "angle": { "type": "number", "example": 90, "description": "Angle, in degrees." }, "delta": { "type": "array", "items": { "type": "number" }, "example": [ 50, 100 ], "description": "Delta. (Array of numbers representing x and y)" }, "scale": { "type": "number", "example": 1, "nullable": true, "description": "Scale of the sheet" }, "width": { "type": "number", "example": 100, "nullable": true, "description": "Width of the sheet, in meters" }, "height": { "type": "number", "example": 100, "nullable": true, "description": "Height of the sheet, in meters" }, "origin": { "type": "array", "items": { "type": "number" }, "example": [ 0, 0 ], "description": "Origin. (Array of numbers representing x and y)" }, "categories": { "$ref": "#/components/schemas/ViewVisibilityList" }, "baseModelId": { "type": "string", "example": 18, "description": "Base model Id" }, "clipVectors": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClipPrimitivePlaneProps" }, { "$ref": "#/components/schemas/ClipPrimitiveShapeProps" } ] }, "description": "Array of clip vectors in the view." }, "displayStyle": { "$ref": "#/components/schemas/DisplayStyleSettingsProps" }, "sheetTemplate": { "type": "string", "example": 18, "nullable": true, "description": "Sheet template Id" }, "sheetAttachments": { "type": "array", "items": { "type": "string" }, "example": [ 18, 19 ], "nullable": true, "description": "List of Ids" } }, "additionalProperties": false }
ViewWithLegacy
Legacy data, un-updatable, will soon be deprecated move to new service
{ "type": "object", "properties": { "legacyView": { "type": "object", "example": { "viewStateProps": { "categorySelectorProps": { "classFullName": "BisCore:CategorySelector" } } }, "nullable": true, "description": "Legacy data, un-updatable, will soon be deprecated move to new service", "additionalProperties": false }, "itwin3dView": { "$ref": "#/components/schemas/ViewItwin3d" }, "itwinSheetView": { "$ref": "#/components/schemas/ViewItwinSheet" }, "itwinDrawingView": { "$ref": "#/components/schemas/ViewItwinDrawing" } }, "additionalProperties": false }
MapImageryProps
Overlay layer settings.
The settings for the base layer.
Background layer settings.
{ "type": "object", "properties": { "overlayLayers": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "description": "Overlay layer settings." }, "backgroundBase": { "type": "object", "description": "The settings for the base layer.", "additionalProperties": false }, "backgroundLayers": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "description": "Background layer settings." } }, "additionalProperties": false }
SavedViewUpdate
Flag for whether or not Saved View is shared
Tags of Saved View
Group ID
Saved View Name
{ "type": "object", "properties": { "shared": { "type": "boolean", "example": false, "nullable": true, "description": "Flag for whether or not Saved View is shared" }, "tagIds": { "type": "array", "items": { "type": "string" }, "example": [ "ABRBqKCBtXZCl_ax5ZFB9uaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ" ], "nullable": true, "description": "Tags of Saved View" }, "groupId": { "type": "string", "example": "AKX-Arab1o1NqdQwr7zIr3KNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ", "nullable": true, "description": "Group ID" }, "displayName": { "type": "string", "example": "Saved View Test Name", "nullable": true, "description": "Saved View Name" }, "savedViewData": { "$ref": "#/components/schemas/View" } }, "additionalProperties": false }
SolarLightProps
Direction of the light in world coordinates.
Intensity of the light.
If defined, the time in UNIX milliseconds from which direction was calculated.
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.
{ "type": "object", "properties": { "direction": { "type": "array", "items": { "type": "number" }, "example": [ 0, 0, 0 ], "description": "Direction of the light in world coordinates." }, "intensity": { "type": "number", "description": "Intensity of the light." }, "timePoint": { "type": "number", "description": "If defined, the time in UNIX milliseconds from which direction was calculated." }, "alwaysEnabled": { "type": "boolean", "description": "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." } }, "additionalProperties": false }
EnvironmentProps
{ "type": "object", "properties": { "sky": { "$ref": "#/components/schemas/SkyBoxProps" }, "ground": { "$ref": "#/components/schemas/GroundPlaneProps" } }, "additionalProperties": false }
ExtensionPayload
{ "type": "object", "properties": { "data": { "type": "string" }, "_links": { "type": "object", "properties": { "iTwin": { "$ref": "#/components/schemas/Link" }, "imodel": { "$ref": "#/components/schemas/Link" }, "project": { "$ref": "#/components/schemas/Link" }, "savedView": { "$ref": "#/components/schemas/Link" } }, "additionalProperties": false }, "schemaUrl": { "type": "string" }, "markdownUrl": { "type": "string" }, "extensionName": { "type": "string" } }, "additionalProperties": false }
GroundPlaneProps
Whether the ground plane should be displayed.
The Z height at which to draw the ground plane.
{ "type": "object", "properties": { "display": { "type": "boolean", "description": "Whether the ground plane should be displayed." }, "elevation": { "type": "number", "description": "The Z height at which to draw the ground plane." }, "aboveColor": { "$ref": "#/components/schemas/RgbColorProps" }, "belowColor": { "$ref": "#/components/schemas/RgbColorProps" } }, "additionalProperties": false }
SkyBoxImageProps type
Type of skybox image.
{ "enum": [ "None", "Spherical", "Cube" ], "type": "string", "description": "Type of skybox image.", "title": "SkyBoxImageProps type" }
SkyBoxImageProps
The image to map to the interior of the sphere.
{ "type": "object", "required": [ "type" ], "properties": { "type": { "enum": [ "None", "Spherical", "Cube" ], "type": "string", "description": "Type of skybox image.", "title": "SkyBoxImageProps type", "$ref": "#/components/schemas/SkyBoxImageProps-type" }, "texture": { "type": "string", "description": "The image to map to the interior of the sphere." }, "textures": { "$ref": "#/components/schemas/SkyCubeProps" } }, "additionalProperties": false }
ViewItwinDrawing
Angle, in degrees.
Delta. (Array of numbers representing x and y)
Origin. (Array of numbers representing x and y)
Base model Id
The Id of the spatial view from which the SectionDrawing was generated.
The extents of the DrawingModel, used for determining the upper limits of the view's extents.
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.
{ "type": "object", "required": [ "baseModelId", "origin", "delta", "angle", "modelExtents" ], "properties": { "angle": { "type": "number", "example": 90, "description": "Angle, in degrees." }, "delta": { "type": "array", "items": { "type": "number" }, "example": [ 50, 100 ], "description": "Delta. (Array of numbers representing x and y)" }, "origin": { "type": "array", "items": { "type": "number" }, "example": [ 0, 0 ], "description": "Origin. (Array of numbers representing x and y)" }, "categories": { "$ref": "#/components/schemas/ViewVisibilityList" }, "baseModelId": { "type": "string", "example": 18, "description": "Base model Id" }, "clipVectors": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClipPrimitivePlaneProps" }, { "$ref": "#/components/schemas/ClipPrimitiveShapeProps" } ] }, "description": "Array of clip vectors in the view." }, "spatialView": { "type": "string", "example": 18, "nullable": true, "description": "The Id of the spatial view from which the SectionDrawing was generated.", "externalDocs": { "url": "https://www.itwinjs.org/learning/common/id64/" } }, "displayStyle": { "$ref": "#/components/schemas/DisplayStyleSettingsProps" }, "modelExtents": { "type": "array", "items": { "type": "array", "items": { "type": "number" } }, "example": [ [ -10, -10, -10 ], [ 100, 100, 100 ] ], "description": "The extents of the DrawingModel, used for determining the upper limits of the view's extents." }, "displaySpatialView": { "type": "boolean", "example": true, "nullable": true, "description": "If true, the spatial view should be displayed in the context of the drawing view." }, "drawingToSpatialTransform": { "type": "array", "items": { "type": "array", "items": { "type": "number" } }, "example": [ [ 1, 0, 0, 0 ], [ 0, 1, 0, 0 ], [ 0, 0, 1, 0 ] ], "nullable": true, "description": "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." } }, "additionalProperties": false }
ViewYawPitchRoll
Yaw (rotation of x towards y) of the orientation, in degrees
Roll (rotation of y towards z) of the orientation, in degrees
Pitch (rotation that raises x towards z) of the orientation, in degrees
{ "type": "object", "properties": { "yaw": { "type": "number", "example": 90, "nullable": true, "description": "Yaw (rotation of x towards y) of the orientation, in degrees" }, "roll": { "type": "number", "example": 90, "nullable": true, "description": "Roll (rotation of y towards z) of the orientation, in degrees" }, "pitch": { "type": "number", "example": 90, "nullable": true, "description": "Pitch (rotation that raises x towards z) of the orientation, in degrees" } }, "additionalProperties": false }
AmbientLightProps
{ "type": "object", "properties": { "color": { "$ref": "#/components/schemas/RgbColorProps" }, "intensity": { "type": "number", "description": "Intensity of the lights." } }, "additionalProperties": false }
SavedViewResponse
{ "type": "object", "required": [ "savedView" ], "properties": { "savedView": { "$ref": "#/components/schemas/SavedViewWithData" } }, "additionalProperties": false }
SavedViewWithData
Unique identifier
Flag for whether or not element is shared
User visible name
ISO-8601 compliant time (UTC) the saved view was created.
ISO-8601 compliant time (UTC) the saved view was last modified.
{ "type": "object", "required": [ "id", "displayName", "shared", "creationTime", "lastModified", "_links", "savedViewData" ], "properties": { "id": { "type": "string", "example": "ACZbDmWhULVChRcDRkoPdLaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ", "description": "Unique identifier" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/SavedViewTag" }, "example": [ { "id": "ABRBqKCBtXZCl_ax5ZFB9uaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ", "displayName": "Tag Test Name" } ], "nullable": true, "description": "Tags of Saved View" }, "_links": { "$ref": "#/components/schemas/SavedViewLinks" }, "shared": { "type": "boolean", "example": false, "description": "Flag for whether or not element is shared" }, "extensions": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ExtensionLinks" }, { "$ref": "#/components/schemas/ExtensionPayload" } ] }, "example": [ { "href": "http://api.bentley.com/path1/path2", "extensionName": "MyExtension" } ], "nullable": true, "description": "Extensions of Saved View" }, "displayName": { "type": "string", "example": "Test Name", "description": "User visible name" }, "creationTime": { "type": "string", "format": "date-time", "example": "2022-10-04T16:14:08.3350000+00:00", "description": "ISO-8601 compliant time (UTC) the saved view was created." }, "lastModified": { "type": "string", "format": "date-time", "example": "2022-10-04T16:14:08.3350000+00:00", "description": "ISO-8601 compliant time (UTC) the saved view was last modified." }, "savedViewData": { "$ref": "#/components/schemas/ViewWithLegacy" } }, "additionalProperties": false }
ViewFlagOverrides renderMode
The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.
{ "enum": [ "Wireframe", "HiddenLine", "SolidFill", "SmoothShade" ], "type": "string", "example": "true", "description": "The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.", "title": "ViewFlagOverrides renderMode" }
ViewFlagOverrides
In RenderMode.Wireframe only, whether to display the interiors of planar regions with FillFlags.ByView.
Whether to display a grid.
Whether LinePixels are allowed to apply patterns to lines and edges. If false, they all draw as solid lines.
In RenderMode.SmoothShade, whether to display solar shadows. This has no effect unless lighting is also true.
Whether to allow lines and edges to draw with width greater than one pixel.
Whether to display a graphical representation of the view's AuxCoordSystem.
In RenderMode.SmoothShade, whether to apply lighting to surfaces.
Whether to display geometry of class GeometryClass.Pattern.
In RenderMode.SmoothShade, whether to apply RenderTextures to surfaces.
If true, overlay surfaces with wiremesh to reveal their triangulation.
In RenderMode.SmoothShade, whether to apply RenderMaterial]s to surfaces.
Whether to apply the view's clip volume to the geometry in the scene.
Whether to display geometry of class GeometryClass.Dimension.
Whether to produce a monochrome image.
The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.
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.
Whether element transparency is applied. If false, transparent geometry is drawn opaque.
In RenderMode.SmoothShade, whether to display the edges of surfaces.
Whether to display background map imagery.
Whether to display geometry of class GeometryClass.Construction.
In RenderMode.SmoothShade, whether to apply AmbientOcclusion.
{ "type": "object", "properties": { "fill": { "type": "boolean", "example": true, "description": "In RenderMode.Wireframe only, whether to display the interiors of planar regions with FillFlags.ByView." }, "grid": { "type": "boolean", "example": true, "description": "Whether to display a grid." }, "styles": { "type": "boolean", "example": true, "description": "Whether LinePixels are allowed to apply patterns to lines and edges. If false, they all draw as solid lines." }, "shadows": { "type": "boolean", "example": true, "description": "In RenderMode.SmoothShade, whether to display solar shadows. This has no effect unless lighting is also true." }, "weights": { "type": "boolean", "example": true, "description": "Whether to allow lines and edges to draw with width greater than one pixel." }, "acsTriad": { "type": "boolean", "example": true, "description": "Whether to display a graphical representation of the view's AuxCoordSystem." }, "lighting": { "type": "boolean", "example": true, "description": "In RenderMode.SmoothShade, whether to apply lighting to surfaces." }, "patterns": { "type": "boolean", "example": true, "description": "Whether to display geometry of class GeometryClass.Pattern." }, "textures": { "type": "boolean", "example": true, "description": "In RenderMode.SmoothShade, whether to apply RenderTextures to surfaces." }, "wiremesh": { "type": "boolean", "example": true, "description": "If true, overlay surfaces with wiremesh to reveal their triangulation." }, "materials": { "type": "boolean", "example": true, "description": "In RenderMode.SmoothShade, whether to apply RenderMaterial]s to surfaces." }, "clipVolume": { "type": "boolean", "example": true, "description": "Whether to apply the view's clip volume to the geometry in the scene." }, "dimensions": { "type": "boolean", "example": true, "description": "Whether to display geometry of class GeometryClass.Dimension." }, "monochrome": { "type": "boolean", "example": true, "description": "Whether to produce a monochrome image." }, "renderMode": { "enum": [ "Wireframe", "HiddenLine", "SolidFill", "SmoothShade" ], "type": "string", "example": "true", "description": "The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.", "title": "ViewFlagOverrides renderMode", "$ref": "#/components/schemas/ViewFlagOverrides-renderMode" }, "hiddenEdges": { "type": "boolean", "example": true, "description": "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." }, "transparency": { "type": "boolean", "example": true, "description": "Whether element transparency is applied. If false, transparent geometry is drawn opaque." }, "visibleEdges": { "type": "boolean", "example": true, "description": "In RenderMode.SmoothShade, whether to display the edges of surfaces." }, "backgroundMap": { "type": "boolean", "example": true, "description": "Whether to display background map imagery." }, "constructions": { "type": "boolean", "example": true, "description": "Whether to display geometry of class GeometryClass.Construction." }, "ambientOcclusion": { "type": "boolean", "example": true, "description": "In RenderMode.SmoothShade, whether to apply AmbientOcclusion." } }, "additionalProperties": false }
BackgroundMapProps globeMode
Globe Mode.
{ "enum": [ "Ellipsoid", "Plane" ], "type": "string", "description": "Globe Mode.", "title": "BackgroundMapProps globeMode" }
BackgroundMapProps
The elevation of the map in meters relative the WGS84 ellipsoid.
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.
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.
{ "type": "object", "properties": { "globeMode": { "enum": [ "Ellipsoid", "Plane" ], "type": "string", "description": "Globe Mode.", "title": "BackgroundMapProps globeMode", "$ref": "#/components/schemas/BackgroundMapProps-globeMode" }, "groundBias": { "type": "number", "example": 0, "description": "The elevation of the map in meters relative the WGS84 ellipsoid." }, "applyTerrain": { "type": "boolean", "example": false, "description": "If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane." }, "nonLocatable": { "type": "boolean", "example": false, "description": "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." }, "transparency": { "type": "object", "example": "0.2", "description": "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.", "additionalProperties": false }, "planarClipMask": { "$ref": "#/components/schemas/PlanarClipMaskProps" }, "useDepthBuffer": { "type": "boolean", "example": false, "description": "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." }, "terrainSettings": { "$ref": "#/components/schemas/TerrainProps" } }, "additionalProperties": false }
LightSettingsProps
Applies a cel-shaded effect. If greater than zero, specifies the number of cels.
Specular intensity applied to all lights.
{ "type": "object", "properties": { "solar": { "$ref": "#/components/schemas/SolarLightProps" }, "ambient": { "$ref": "#/components/schemas/AmbientLightProps" }, "fresnel": { "$ref": "#/components/schemas/FresnelSettingsProps" }, "numCels": { "type": "number", "example": 2, "description": "Applies a cel-shaded effect. If greater than zero, specifies the number of cels." }, "portrait": { "$ref": "#/components/schemas/PortraitProps" }, "hemisphere": { "$ref": "#/components/schemas/HemisphereLightsProps" }, "specularIntensity": { "type": "number", "description": "Specular intensity applied to all lights." } }, "additionalProperties": false }
ViewVisibilityList
List of Ids that should be enabled/visible.
List of Ids that should be disabled/hidden.
{ "type": "object", "properties": { "enabled": { "type": "array", "items": { "type": "string" }, "example": [ 18, 19 ], "nullable": true, "description": "List of Ids that should be enabled/visible." }, "disabled": { "type": "array", "items": { "type": "string" }, "example": [ 20, 21 ], "nullable": true, "description": "List of Ids that should be disabled/hidden." } }, "additionalProperties": false }
PlanarClipMaskProps mode
Controls how the mask geometry is collected.
{ "enum": [ "None", "Priority", "Models", "IncludeSubCategories", "IncludeElements", "ExcludeElements" ], "type": "string", "example": "1", "description": "Controls how the mask geometry is collected.", "title": "PlanarClipMaskProps mode" }
PlanarClipMaskProps priority
The priority of the planar clip mask.
{ "enum": [ "RealityModel", "DesignModel", "-2048", "-1024" ], "type": "string", "description": "The priority of the planar clip mask.", "title": "PlanarClipMaskProps priority" }
PlanarClipMaskProps
A value of true indicates that the mask should be inverted and only content within the mask should be displayed.
Compressed Id set containing the model Ids.
The transparency of the planar clip mask. Between 0 (complete masking) and 1 (no masking).
Compressed Id set containing the sub category or element Ids.
{ "type": "object", "required": [ "mode" ], "properties": { "mode": { "enum": [ "None", "Priority", "Models", "IncludeSubCategories", "IncludeElements", "ExcludeElements" ], "type": "string", "example": "1", "description": "Controls how the mask geometry is collected.", "title": "PlanarClipMaskProps mode", "$ref": "#/components/schemas/PlanarClipMaskProps-mode" }, "invert": { "type": "boolean", "example": true, "description": "A value of true indicates that the mask should be inverted and only content within the mask should be displayed." }, "modelIds": { "type": "string", "example": "+1+3+5AB8", "description": "Compressed Id set containing the model Ids." }, "priority": { "enum": [ "RealityModel", "DesignModel", "-2048", "-1024" ], "type": "string", "description": "The priority of the planar clip mask.", "title": "PlanarClipMaskProps priority", "$ref": "#/components/schemas/PlanarClipMaskProps-priority" }, "transparency": { "type": "number", "example": 0.5, "maximum": 1, "minimum": 0, "description": "The transparency of the planar clip mask. Between 0 (complete masking) and 1 (no masking)." }, "subCategoryOrElementIds": { "type": "string", "example": "+1+3+5AB8", "description": "Compressed Id set containing the sub category or element Ids." } }, "additionalProperties": false }
FresnelSettingsProps
Whether to inver the fresnel.
Intensity of the fresnel.
{ "type": "object", "properties": { "invert": { "type": "number", "description": "Whether to inver the fresnel." }, "intensity": { "type": "number", "description": "Intensity of the fresnel." } }, "additionalProperties": false }
If defined, the pixel pattern used to draw the edges. If undefined, edges are drawn using the element's line pattern.
{ "enum": [ "Code0", "Invisible", "Code1", "HiddenLine", "Code5", "Code6", "Code2", "Code4", "Code7", "Code3", "0", "-1" ], "type": "string", "example": "0", "description": "If defined, the pixel pattern used to draw the edges. If undefined, edges are drawn using the element's line pattern.", "title": "HiddenLineStyleProps 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]
If defined, the pixel pattern used to draw the edges. If undefined, edges are drawn using the element's line pattern.
If true, color is overridden.
{ "type": "object", "properties": { "color": { "$ref": "#/components/schemas/RgbColorProps" }, "width": { "type": "number", "example": 12, "maximum": 32, "minimum": 1, "description": "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]" }, "pattern": { "enum": [ "Code0", "Invisible", "Code1", "HiddenLine", "Code5", "Code6", "Code2", "Code4", "Code7", "Code3", "0", "-1" ], "type": "string", "example": "0", "description": "If defined, the pixel pattern used to draw the edges. If undefined, edges are drawn using the element's line pattern.", "title": "HiddenLineStyleProps pattern", "$ref": "#/components/schemas/HiddenLineStyleProps-pattern" }, "overrideColor": { "type": "boolean", "example": true, "description": "If true, color is overridden." } }, "additionalProperties": false }
RealityDataSourceKey
The reality data id that identify a reality data for the provider.
The format used by the provider to store the reality data.
The context id that was used when reality data was attached - if none provided, current session iTwinId will be used.
The provider that supplies the access to reality data source for displaying the reality model.
{ "type": "object", "required": [ "provider", "format", "id" ], "properties": { "id": { "type": "string", "description": "The reality data id that identify a reality data for the provider." }, "format": { "type": "string", "description": "The format used by the provider to store the reality data." }, "iTwinId": { "type": "string", "example": "52d4d658-0ff2-4188-aeaf-442045e2a6de", "description": "The context id that was used when reality data was attached - if none provided, current session iTwinId will be used." }, "provider": { "type": "string", "description": "The provider that supplies the access to reality data source for displaying the reality model." } }, "additionalProperties": false }
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, 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, raise the final ambient occlusion to the power of this value. Larger values make the ambient shadows darker.
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, indicates the distance to step toward the next texel sample in the current direction.
If defined, blurTexelStepSize indicates the distance to the next texel for blurring.
{ "type": "object", "properties": { "bias": { "type": "number", "description": "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." }, "blurDelta": { "type": "number", "description": "If defined, blurDelta is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma))." }, "blurSigma": { "type": "number", "description": "If defined, blurSigma is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma))." }, "intensity": { "type": "number", "description": "If defined, raise the final ambient occlusion to the power of this value. Larger values make the ambient shadows darker." }, "zLengthCap": { "type": "number", "maximum": 1, "minimum": 0, "description": "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." }, "maxDistance": { "type": "number", "minimum": 0, "description": "If defined, the maximum distance from the camera's near plane in meters at which ambient occlusion will be applied." }, "texelStepSize": { "type": "number", "description": "If defined, indicates the distance to step toward the next texel sample in the current direction." }, "blurTexelStepSize": { "type": "number", "description": "If defined, blurTexelStepSize indicates the distance to the next texel for blurring." } }, "additionalProperties": false }
HemisphereLightsProps
{ "type": "object", "properties": { "intensity": { "type": "number", "description": "Intensity of the lights." }, "lowerColor": { "$ref": "#/components/schemas/RgbColorProps" }, "upperColor": { "$ref": "#/components/schemas/RgbColorProps" } }, "additionalProperties": false }
FeatureAppearanceProps linePixels
The pixel pattern used to draw lines.
{ "enum": [ "Code0", "Invisible", "Code1", "HiddenLine", "Code5", "Code6", "Code2", "Code4", "Code7", "Code3", "0", "-1" ], "type": "string", "description": "The pixel pattern used to draw lines.", "title": "FeatureAppearanceProps linePixels" }
FeatureAppearanceProps
The line weight in pixels as an integer in [1, 31]
If true, the associated Feature will be emphasized. Emphasized features are rendered using the Hilite.Settings defined by Viewport.emphasisSettings
The pixel pattern used to draw lines.
If true, the associated Feature will not be drawn when using Viewport.readPixels.
The transparency in the range [0.0, 1.0] where 0 indicates fully opaque and 1 indicates fully transparent.
If true, ignore the RenderMaterial associated with surfaces.
{ "type": "object", "properties": { "rgb": { "$ref": "#/components/schemas/RgbColorProps" }, "weight": { "type": "number", "maximum": 31, "minimum": 1, "description": "The line weight in pixels as an integer in [1, 31]" }, "emphasized": { "type": "boolean", "description": "If true, the associated Feature will be emphasized. Emphasized features are rendered using the Hilite.Settings defined by Viewport.emphasisSettings" }, "linePixels": { "enum": [ "Code0", "Invisible", "Code1", "HiddenLine", "Code5", "Code6", "Code2", "Code4", "Code7", "Code3", "0", "-1" ], "type": "string", "description": "The pixel pattern used to draw lines.", "title": "FeatureAppearanceProps linePixels", "$ref": "#/components/schemas/FeatureAppearanceProps-linePixels" }, "nonLocatable": { "type": "boolean", "description": "If true, the associated Feature will not be drawn when using Viewport.readPixels." }, "transparency": { "type": "number", "maximum": 1, "minimum": 0, "description": "The transparency in the range [0.0, 1.0] where 0 indicates fully opaque and 1 indicates fully transparent." }, "ignoresMaterial": { "type": "boolean", "description": "If true, ignore the RenderMaterial associated with surfaces." } }, "additionalProperties": false }
SpatialClassifierProps
A user-friendly name, useful for identifying individual classifiers within a SpatialClassifiers.
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.
The Id of the GeometricModel whose geometry is used to produce the classifier.
Records whether this is the active classifier.
{ "type": "object", "required": [ "modelId", "expand", "flags", "name" ], "properties": { "name": { "type": "string", "description": "A user-friendly name, useful for identifying individual classifiers within a SpatialClassifiers." }, "flags": { "$ref": "#/components/schemas/SpatialClassifierFlagsProps" }, "expand": { "type": "number", "example": 5, "description": "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." }, "modelId": { "type": "string", "example": 1, "description": "The Id of the GeometricModel whose geometry is used to produce the classifier." }, "isActive": { "type": "boolean", "example": false, "description": "Records whether this is the active classifier." } }, "additionalProperties": false }
ClipPrimitivePlaneProps
{ "type": "object", "required": [ "planes" ], "properties": { "planes": { "$ref": "#/components/schemas/PlanesProps" } }, "additionalProperties": false }
ClipPrimitiveShapeProps
{ "type": "object", "required": [ "shape" ], "properties": { "shape": { "$ref": "#/components/schemas/ShapeProps" } }, "additionalProperties": false }
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.
{ "type": "object", "properties": { "hidden": { "$ref": "#/components/schemas/HiddenLineStyleProps" }, "visible": { "$ref": "#/components/schemas/HiddenLineStyleProps" }, "transparencyThreshold": { "type": "number", "example": 0.2, "maximum": 1, "minimum": 0, "description": "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." } }, "additionalProperties": false }
ContextRealityModelProps
An optional, user-friendly name for the reality model suitable for display in a user interface.
The URL that supplies the 3d tiles for displaying the reality model.
An optional, user-friendly description of the reality model suitable for display in a user interface.
Id of reality data.
{ "type": "object", "required": [ "tilesetUrl" ], "properties": { "name": { "type": "string", "description": "An optional, user-friendly name for the reality model suitable for display in a user interface." }, "tilesetUrl": { "type": "string", "description": "The URL that supplies the 3d tiles for displaying the reality model." }, "classifiers": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialClassifierProps" }, "description": "List of SpatialClassifierProps." }, "description": { "type": "string", "description": "An optional, user-friendly description of the reality model suitable for display in a user interface." }, "realityDataId": { "type": "string", "description": "Id of reality data." }, "planarClipMask": { "$ref": "#/components/schemas/PlanarClipMaskProps" }, "appearanceOverrides": { "$ref": "#/components/schemas/FeatureAppearanceProps" }, "realityDataSourceKey": { "$ref": "#/components/schemas/RealityDataSourceKey" } }, "additionalProperties": false }
SolarShadowSettingsProps
{ "type": "object", "properties": { "color": { "$ref": "#/components/schemas/RgbColorProps" } }, "additionalProperties": false }
DisplayStyleSettingsProps monochromeMode
The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).
{ "enum": [ "Flat", "Scaled" ], "type": "string", "example": "0", "description": "The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).", "title": "DisplayStyleSettingsProps monochromeMode" }
DisplayStyleSettingsProps
The point in time reflected by the view, in UNIX seconds.
Overrides applied to the appearance of models in the view.
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.
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.
A list of ContextRealityModels attached to a DisplayStyleSettings.
Overrides applied to the appearances of subcategories in the view.
{ "type": "object", "properties": { "clipStyle": { "$ref": "#/components/schemas/ClipStyleProps" }, "timePoint": { "type": "number", "description": "The point in time reflected by the view, in UNIX seconds." }, "viewflags": { "$ref": "#/components/schemas/ViewFlagProps" }, "mapImagery": { "$ref": "#/components/schemas/MapImageryProps" }, "backgroundMap": { "$ref": "#/components/schemas/BackgroundMapProps" }, "modelOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayStyleModelAppearanceProps" }, "description": "Overrides applied to the appearance of models in the view." }, "monochromeMode": { "enum": [ "Flat", "Scaled" ], "type": "string", "example": "0", "description": "The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).", "title": "DisplayStyleSettingsProps monochromeMode", "$ref": "#/components/schemas/DisplayStyleSettingsProps-monochromeMode" }, "renderTimeline": { "type": "string", "description": "The id of a Render Timeline element containing a schedule script that can be used to animate the view." }, "backgroundColor": { "$ref": "#/components/schemas/RgbColorProps" }, "monochromeColor": { "$ref": "#/components/schemas/RgbColorProps" }, "excludedElements": { "type": "object", "description": "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.", "additionalProperties": false }, "planarClipOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayStylePlanarClipMaskProps" }, "description": "Planar clip masks applied to reality models." }, "contextRealityModels": { "type": "array", "items": { "$ref": "#/components/schemas/ContextRealityModelProps" }, "description": "A list of ContextRealityModels attached to a DisplayStyleSettings." }, "subCategoryOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayStyleSubCategoryProps" }, "description": "Overrides applied to the appearances of subcategories in the view." } }, "additionalProperties": false }
ClipIntersectionStyleProps
Number of pixels to be considered intersecting the clip plane, default 1.
{ "type": "object", "properties": { "color": { "$ref": "#/components/schemas/RgbColorProps" }, "width": { "type": "number", "example": 1, "description": "Number of pixels to be considered intersecting the clip plane, default 1." } }, "additionalProperties": false }
DisplayStyle3dSettingsProps monochromeMode
The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).
{ "enum": [ "Flat", "Scaled" ], "type": "string", "example": "0", "description": "The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).", "title": "DisplayStyle3dSettingsProps monochromeMode" }
DisplayStyle3dSettingsProps
The point in time reflected by the view, in UNIX seconds.
Overrides applied to the appearance of models in the view.
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.
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.
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.
A list of ContextRealityModels attached to a DisplayStyleSettings.
Overrides applied to the appearances of subcategories in the view.
{ "type": "object", "required": [ "planProjections" ], "properties": { "lights": { "$ref": "#/components/schemas/LightSettingsProps" }, "clipStyle": { "$ref": "#/components/schemas/ClipStyleProps" }, "timePoint": { "type": "number", "description": "The point in time reflected by the view, in UNIX seconds." }, "viewflags": { "$ref": "#/components/schemas/ViewFlagProps" }, "mapImagery": { "$ref": "#/components/schemas/MapImageryProps" }, "environment": { "$ref": "#/components/schemas/EnvironmentProps" }, "solarShadows": { "$ref": "#/components/schemas/SolarShadowSettingsProps" }, "backgroundMap": { "$ref": "#/components/schemas/BackgroundMapProps" }, "modelOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayStyleModelAppearanceProps" }, "description": "Overrides applied to the appearance of models in the view." }, "monochromeMode": { "enum": [ "Flat", "Scaled" ], "type": "string", "example": "0", "description": "The style in which the monochrome color is applied. Can be 1 (Scaled) or 0 (Flat).", "title": "DisplayStyle3dSettingsProps monochromeMode", "$ref": "#/components/schemas/DisplayStyle3dSettingsProps-monochromeMode" }, "renderTimeline": { "type": "string", "description": "The id of a Render Timeline element containing a schedule script that can be used to animate the view." }, "backgroundColor": { "$ref": "#/components/schemas/RgbColorProps" }, "monochromeColor": { "$ref": "#/components/schemas/RgbColorProps" }, "planProjections": { "type": "object", "description": "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.", "additionalProperties": false }, "ambientOcclusion": { "$ref": "#/components/schemas/AmbientOcclusionProps" }, "excludedElements": { "type": "object", "description": "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.", "additionalProperties": false }, "planarClipOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayStylePlanarClipMaskProps" }, "description": "Planar clip masks applied to reality models." }, "contextRealityModels": { "type": "array", "items": { "$ref": "#/components/schemas/ContextRealityModelProps" }, "description": "A list of ContextRealityModels attached to a DisplayStyleSettings." }, "subCategoryOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayStyleSubCategoryProps" }, "description": "Overrides applied to the appearances of subcategories in the view." } }, "additionalProperties": false }
SpatialClassifierFlagsProps inside
Describes how a SpatialClassifier affects the display of classified geometry - that is, geometry intersecting the classifier.
{ "enum": [ "Off", "On", "Dimmed", "Hilite", "ElementColor" ], "type": "string", "example": "3", "description": "Describes how a SpatialClassifier affects the display of classified geometry - that is, geometry intersecting the classifier.", "title": "SpatialClassifierFlagsProps inside" }
SpatialClassifierFlagsProps outside
Describes how a SpatialClassifier affects the display of unclassified geometry - that is, geometry not intersecting the classifier.
{ "enum": [ "Off", "On", "Dimmed" ], "type": "string", "example": "2", "description": "Describes how a SpatialClassifier affects the display of unclassified geometry - that is, geometry not intersecting the classifier.", "title": "SpatialClassifierFlagsProps outside" }
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.
{ "type": "object", "required": [ "inside", "outside" ], "properties": { "inside": { "enum": [ "Off", "On", "Dimmed", "Hilite", "ElementColor" ], "type": "string", "example": "3", "description": "Describes how a SpatialClassifier affects the display of classified geometry - that is, geometry intersecting the classifier.", "title": "SpatialClassifierFlagsProps inside", "$ref": "#/components/schemas/SpatialClassifierFlagsProps-inside" }, "outside": { "enum": [ "Off", "On", "Dimmed" ], "type": "string", "example": "2", "description": "Describes how a SpatialClassifier affects the display of unclassified geometry - that is, geometry not intersecting the classifier.", "title": "SpatialClassifierFlagsProps outside", "$ref": "#/components/schemas/SpatialClassifierFlagsProps-outside" }, "isVolumeClassifier": { "type": "boolean", "example": true, "description": "True for volume classification; false for planar classification." } }, "additionalProperties": false }
DisplayStyleSubCategoryProps
Style Id to use.
The line width in pixels. Must be a value between [1,32].
Material Id to use.
Priority.
Whether the subcategory is invisible or not.
The Id of the SubCategory whose appearance is to be overridden.
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.
{ "type": "object", "properties": { "fill": { "$ref": "#/components/schemas/RgbColorProps" }, "color": { "$ref": "#/components/schemas/RgbColorProps" }, "style": { "type": "string", "example": 1, "description": "Style Id to use." }, "weight": { "type": "number", "example": 5, "maximum": 32, "minimum": 1, "description": "The line width in pixels. Must be a value between [1,32]." }, "material": { "type": "string", "example": 1, "description": "Material Id to use." }, "priority": { "type": "number", "example": 0, "description": "Priority." }, "invisible": { "type": "boolean", "example": false, "description": "Whether the subcategory is invisible or not." }, "subCategory": { "type": "string", "description": "The Id of the SubCategory whose appearance is to be overridden." }, "transparency": { "type": "number", "example": 0.2, "maximum": 1, "minimum": 0, "description": "Transparency. Must be a value in the range [0,1]. 0.0 means fully opaque, and 1.0 means fully transparent." }, "transparencyFill": { "type": "number", "example": 0.2, "maximum": 1, "minimum": 0, "description": "Fill transparency. Must be a value in the range [0,1]. 0.0 means fully opaque, and 1.0 means fully transparent." } }, "additionalProperties": false }
DisplayStylePlanarClipMaskProps mode
Controls how the mask geometry is collected.
{ "enum": [ "None", "Priority", "Models", "IncludeSubCategories", "IncludeElements", "ExcludeElements" ], "type": "string", "example": "1", "description": "Controls how the mask geometry is collected.", "title": "DisplayStylePlanarClipMaskProps mode" }
DisplayStylePlanarClipMaskProps priority
The priority of the planar clip mask.
{ "enum": [ "RealityModel", "DesignModel", "-2048", "-1024" ], "type": "string", "description": "The priority of the planar clip mask.", "title": "DisplayStylePlanarClipMaskProps priority" }
DisplayStylePlanarClipMaskProps
Controls how the mask geometry is collected.
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.
Compressed Id set containing the model Ids.
The priority of the planar clip mask.
The transparency of the planar clip mask. Between 0 (complete masking) and 1 (no masking).
Compressed Id set containing the sub category or element Ids.
{ "type": "object", "required": [ "mode" ], "properties": { "mode": { "enum": [ "None", "Priority", "Models", "IncludeSubCategories", "IncludeElements", "ExcludeElements" ], "type": "string", "example": "1", "description": "Controls how the mask geometry is collected.", "title": "DisplayStylePlanarClipMaskProps mode", "$ref": "#/components/schemas/DisplayStylePlanarClipMaskProps-mode" }, "invert": { "type": "boolean", "example": true, "description": "A value of true indicates that the mask should be inverted and only content within the mask should be displayed." }, "modelId": { "type": "string", "example": 1, "description": "The Id of the model to mask." }, "modelIds": { "type": "string", "example": "+1+3+5AB8", "description": "Compressed Id set containing the model Ids." }, "priority": { "enum": [ "RealityModel", "DesignModel", "-2048", "-1024" ], "type": "string", "description": "The priority of the planar clip mask.", "title": "DisplayStylePlanarClipMaskProps priority", "$ref": "#/components/schemas/DisplayStylePlanarClipMaskProps-priority" }, "transparency": { "type": "number", "example": 0.5, "maximum": 1, "minimum": 0, "description": "The transparency of the planar clip mask. Between 0 (complete masking) and 1 (no masking)." }, "subCategoryOrElementIds": { "type": "string", "example": "+1+3+5AB8", "description": "Compressed Id set containing the sub category or element Ids." } }, "additionalProperties": false }
DisplayStyleModelAppearanceProps linePixels
The pixel pattern used to draw lines.
{ "enum": [ "Code0", "Invisible", "Code1", "HiddenLine", "Code5", "Code6", "Code2", "Code4", "Code7", "Code3", "0", "-1" ], "type": "string", "description": "The pixel pattern used to draw lines.", "title": "DisplayStyleModelAppearanceProps linePixels" }
DisplayStyleModelAppearanceProps
The line weight in pixels as an integer in [1, 31]
The Id of the model whose appearance is to be overridden.
If true, the associated Feature will be emphasized. Emphasized features are rendered using the Hilite.Settings defined by Viewport.emphasisSettings
The pixel pattern used to draw lines.
If true, the associated Feature will not be drawn when using Viewport.readPixels.
The transparency in the range [0.0, 1.0] where 0 indicates fully opaque and 1 indicates fully transparent.
If true, ignore the RenderMaterial associated with surfaces.
{ "type": "object", "properties": { "rgb": { "$ref": "#/components/schemas/RgbColorProps" }, "weight": { "type": "number", "maximum": 31, "minimum": 1, "description": "The line weight in pixels as an integer in [1, 31]" }, "modelId": { "type": "string", "example": 1, "description": "The Id of the model whose appearance is to be overridden." }, "emphasized": { "type": "boolean", "description": "If true, the associated Feature will be emphasized. Emphasized features are rendered using the Hilite.Settings defined by Viewport.emphasisSettings" }, "linePixels": { "enum": [ "Code0", "Invisible", "Code1", "HiddenLine", "Code5", "Code6", "Code2", "Code4", "Code7", "Code3", "0", "-1" ], "type": "string", "description": "The pixel pattern used to draw lines.", "title": "DisplayStyleModelAppearanceProps linePixels", "$ref": "#/components/schemas/DisplayStyleModelAppearanceProps-linePixels" }, "nonLocatable": { "type": "boolean", "description": "If true, the associated Feature will not be drawn when using Viewport.readPixels." }, "transparency": { "type": "number", "maximum": 1, "minimum": 0, "description": "The transparency in the range [0.0, 1.0] where 0 indicates fully opaque and 1 indicates fully transparent." }, "ignoresMaterial": { "type": "boolean", "description": "If true, ignore the RenderMaterial associated with surfaces." } }, "additionalProperties": false }
Was this page helpful?