Update scene metadata - Scenes

Scenes

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

patch https://dev-api.bentley.com/scenes/{sceneId}?iTwinId

Updates the specified scene's metadata. To replace all scene data, use the PUT scene endpoint.

For updates, all properties are optional. The request payload should only contain the properties that you would like to update.

Request parameters

sceneId

Yes

Scene Id

iTwinId

Yes

Primary iTwin Id associated with the scene

Request headers

x-correlation-id

Activity id used for tracking request

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

SceneUpdateDTO

tagIds

String[]

Optional list of tag ids to apply to this scene. Replaces the full set of tags. Tags must exist within the same iTwin.

parentId

Uuid

Optional parent Id for the scene

description

String

Optional detailed description of the scene

displayName

String

User defined display name of the scene

Example

json

{
    "displayName": "Construction Site Overview",
    "description": "Bridge construction site showing pier placement and equipment staging areas.",
    "parentId": "d21dd09b-bb38-483a-b34f-5d3d7b3e1bd2",
    "tagIds": ["5051ee31-9d3c-4c4c-bf5d-839f1983dcd8"]
}

Response 200 OK

Updated scene.

json

{
    "scene": {
        "id": "eda9e67f-24a3-4bd5-aeca-981d2abdb610",
        "displayName": "Construction Site Overview",
        "description": "Bridge construction site showing pier placement and equipment staging areas.",
        "iTwinId": "1ba4c28a-e518-42d4-85e4-ff9f9ef44bb6",
        "sceneData": {
            "objects": {
                "href": "https://api.bentley.com/scenes/eda9e67f-24a3-4bd5-aeca-981d2abdb610/objects?iTwinId=1ba4c28a-e518-42d4-85e4-ff9f9ef44bb6"
            }
        },
        "tags": [{
            "id": "5051ee31-9d3c-4c4c-bf5d-839f1983dcd8",
            "displayName": "Pier Area"
        }],
        "createdById": "37f457a6-25fd-4d4a-8947-974b690158be",
        "creationTime": "2025-05-04T04:14:08.0000000+00:00",
        "lastModified": "2025-05-07T01:15:25.0000000+00:00"
    }
}

Response 400 Bad Request

Unprocessable Entity

json

{
    "error": {
        "code": "InvalidScenesRequest",
        "message": "Cannot update scene.",
        "target": "scene",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "ParentId must be a UUID.",
            "target": "parentId"
        }]
    }
}

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.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

Forbidden

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

Not Found

json

{
    "error": {
        "code": "SceneNotFound",
        "message": "Requested scene is not available.",
        "target": "scene"
    }
}

Response 413 Request Entity Too Large

Payload Too Large

json

{
    "error": {
        "code": "RequestTooLarge",
        "message": "Request body is greater than the max size of 4.5MiB."
    }
}

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.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

href

String

json

{
    "type": "object",
    "required": [
        "href"
    ],
    "properties": {
        "href": {
            "type": "string",
            "example": "https://example.com/"
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "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
}

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.

error

Error

Error information.

json

{
    "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
}

SceneResponse

scene

SceneWithLinksDTO

json

{
    "type": "object",
    "required": [
        "scene"
    ],
    "properties": {
        "scene": {
            "$ref": "#/components/schemas/SceneWithLinksDTO"
        }
    },
    "additionalProperties": false
}

TagMinimalDTO

Uuid

Globally unique identifier for the tag

displayName

String

User defined display name for the tag

json

{
    "type": "object",
    "required": [
        "id",
        "displayName"
    ],
    "properties": {
        "id": {
            "type": "string",
            "format": "UUID",
            "example": "5051ee31-9d3c-4c4c-bf5d-839f1983dcd8",
            "description": "Globally unique identifier for the tag"
        },
        "displayName": {
            "type": "string",
            "example": "Pier Area",
            "description": "User defined display name for the tag"
        }
    },
    "additionalProperties": false
}

SceneUpdateDTO

tagIds

String[]

Optional list of tag ids to apply to this scene. Replaces the full set of tags. Tags must exist within the same iTwin.

parentId

Uuid

Optional parent Id for the scene

description

String

Optional detailed description of the scene

displayName

String

User defined display name of the scene

json

{
    "type": "object",
    "properties": {
        "tagIds": {
            "type": "array",
            "items": {
                "type": "string",
                "format": "UUID"
            },
            "example": [
                "5051ee31-9d3c-4c4c-bf5d-839f1983dcd8"
            ],
            "description": "Optional list of tag ids to apply to this scene. Replaces the full set of tags. Tags must exist within the same iTwin."
        },
        "parentId": {
            "type": "string",
            "format": "UUID",
            "example": "d21dd09b-bb38-483a-b34f-5d3d7b3e1bd2",
            "description": "Optional parent Id for the scene"
        },
        "description": {
            "type": "string",
            "example": "Bridge construction site showing pier placement and equipment staging areas.",
            "description": "Optional detailed description of the scene"
        },
        "displayName": {
            "type": "string",
            "example": "Construction Site Overview",
            "description": "User defined display name of the scene"
        }
    },
    "additionalProperties": false
}

SceneDataLinksDTO

objects

All of: Link

URL to retrieve scene objects

json

{
    "type": "object",
    "required": [
        "objects"
    ],
    "properties": {
        "objects": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Link"
                }
            ],
            "description": "URL to retrieve scene objects"
        }
    },
    "additionalProperties": false
}

SceneWithLinksDTO

Uuid

Globally unique identifier for the scene

tags

TagMinimalDTO[]

Tags associated with this scene

iTwinId

Uuid

iTwin Id

parentId

Uuid

Optional parent Id for the scene

sceneData

All of: SceneDataLinksDTO

Scene data with links to resources

createdById

Uuid

Id of the user who created the scene

description

String

Optional detailed description of the scene

displayName

String

User defined display name of the scene

creationTime

Date-time

Time the scene was created as an ISO8601 string, 'YYYY-MM-DDTHH:mm:ss.sssZ'

lastModified

Date-time

Time the scene was last modified as an ISO8601 string, 'YYYY-MM-DDTHH:mm:ss.sssZ'

json

{
    "type": "object",
    "required": [
        "id",
        "displayName",
        "tags",
        "createdById",
        "iTwinId",
        "creationTime",
        "lastModified",
        "sceneData"
    ],
    "properties": {
        "id": {
            "type": "string",
            "format": "UUID",
            "example": "eda9e67f-24a3-4bd5-aeca-981d2abdb610",
            "description": "Globally unique identifier for the scene"
        },
        "tags": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TagMinimalDTO"
            },
            "description": "Tags associated with this scene"
        },
        "iTwinId": {
            "type": "string",
            "format": "UUID",
            "example": "1ba4c28a-e518-42d4-85e4-ff9f9ef44bb6",
            "description": "iTwin Id"
        },
        "parentId": {
            "type": "string",
            "format": "UUID",
            "example": "d21dd09b-bb38-483a-b34f-5d3d7b3e1bd2",
            "description": "Optional parent Id for the scene"
        },
        "sceneData": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SceneDataLinksDTO"
                }
            ],
            "description": "Scene data with links to resources"
        },
        "createdById": {
            "type": "string",
            "format": "UUID",
            "example": "37f457a6-25fd-4d4a-8947-974b690158be",
            "description": "Id of the user who created the scene"
        },
        "description": {
            "type": "string",
            "example": "Bridge construction site showing pier placement and equipment staging areas.",
            "description": "Optional detailed description of the scene"
        },
        "displayName": {
            "type": "string",
            "example": "Construction Site Overview",
            "description": "User defined display name of the scene"
        },
        "creationTime": {
            "type": "string",
            "format": "date-time",
            "example": "2025-05-04T04:14:08.0000000+00:00",
            "description": "Time the scene was created as an ISO8601 string, 'YYYY-MM-DDTHH:mm:ss.sssZ'"
        },
        "lastModified": {
            "type": "string",
            "format": "date-time",
            "example": "2025-05-07T01:15:25.0000000+00:00",
            "description": "Time the scene was last modified as an ISO8601 string, 'YYYY-MM-DDTHH:mm:ss.sssZ'"
        }
    },
    "additionalProperties": false
}

Was this page helpful?