Retrieves a Thumbnail file. Returned Thumbnail will be 'image/png' type.

One may specify either the small or large Thumbnail via the size query parameter. If size is not specified, the small Thumbnail will be returned.

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.

Authorization

---

User must have imodels_webview permission assigned at the iModel level. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

For more information please refer to Account Administrator documentation section on Access Control API documentation page.

Rate limits

---

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

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

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

{
    "error": {
        "code": "InvalidiModelsRequest",
        "message": "Cannot get Thumbnail.",
        "details": [{
            "code": "InvalidValue",
            "message": "'invalidSize' is not a valid 'size'. Valid 'size' values are: 'small', 'large'.",
            "target": "size"
        }]
    }
}

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}