Get tag - Scenes | iTwin Platform

Scenes

Download API definition:

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

Get tag

GET https://dev-api.bentley.com/scenes/tags/{tagId}?iTwinId={iTwinId}

Retrieves the specified tag.

Request parameters

tagId

Yes

Tag Id

iTwinId

Yes

iTwin Id associated with the tag

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.

Response 200 OK

Specified tag.

json

{
    "tag": {
        "id": "5051ee31-9d3c-4c4c-bf5d-839f1983dcd8",
        "displayName": "Pier Area",
        "iTwinId": "1ba4c28a-e518-42d4-85e4-ff9f9ef44bb6",
        "createdById": "37f457a6-25fd-4d4a-8947-974b690158be",
        "creationTime": "2025-05-04T04:14:08Z",
        "lastModified": "2025-05-07T01:15:25Z"
    }
}

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 404 Not Found

Not Found

json

{
    "error": {
        "code": "TagNotFound",
        "message": "Requested tag is not available.",
        "target": "tag"
    }
}

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

TagDTO

Uuid

Globally unique identifier for the tag

displayName

String

User defined display name for the tag

iTwinId

Uuid

iTwin Id the tag is scoped to

createdById

Uuid

Id of the user who created the tag

creationTime

Date-time

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

lastModified

Date-time

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

json

{
    "required": [
        "id",
        "displayName",
        "iTwinId",
        "createdById",
        "creationTime",
        "lastModified"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Globally unique identifier for the tag",
            "format": "UUID",
            "example": "5051ee31-9d3c-4c4c-bf5d-839f1983dcd8"
        },
        "displayName": {
            "type": "string",
            "description": "User defined display name for the tag",
            "example": "Pier Area"
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin Id the tag is scoped to",
            "format": "UUID",
            "example": "1ba4c28a-e518-42d4-85e4-ff9f9ef44bb6"
        },
        "createdById": {
            "type": "string",
            "description": "Id of the user who created the tag",
            "format": "UUID",
            "example": "37f457a6-25fd-4d4a-8947-974b690158be"
        },
        "creationTime": {
            "type": "string",
            "description": "Time the tag was created as an ISO8601 string, 'YYYY-MM-DDTHH:mm:ss.sssZ'",
            "format": "date-time",
            "example": "2025-05-04T04:14:08Z"
        },
        "lastModified": {
            "type": "string",
            "description": "Time the tag was last modified as an ISO8601 string, 'YYYY-MM-DDTHH:mm:ss.sssZ'",
            "format": "date-time",
            "example": "2025-05-07T01:15:25Z"
        }
    },
    "additionalProperties": false
}

TagResponse

tag

TagDTO

json

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

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "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",
    "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?