Upload iModel Thumbnail - iModels

REST API Overview

Reference

iModels

Download API definition:

PUT https://api.bentley.com/imodels/{id}/thumbnail

Uploads a Thumbnail file. Request content should be binary content of an image. Supported Thumbnail types are 'image/png' or 'image/jpeg', but once uploaded 'image/jpeg' will be converted to 'image/png'. Maximum supported Thumbnail size is 5 megabytes.

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_manage permission assigned at the iModel level and at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_manage 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

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

Request

Request parameters

template

Yes

iModel id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Content-Type

Yes

Indicates request body content type.

Request body

image

Example

Response

Response 201 Created

Created

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.

json

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

Response 403 Forbidden

User is not authorized to upload a Thumbnail.

json

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

Response 404 Not Found

Specified iModel was not found.

json

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

Response 409 Conflict

iModel is not initialized and modify operations are not allowed.

json

{
    "error": {
        "code": "iModelNotInitialized",
        "message": "iModel is not initialized."
    }
}

Response 413 Request Entity Too Large

Indicates that the request size is above the maximum size.

json

{
    "error": {
        "code": "RequestTooLarge",
        "message": "Request body is too large. Maximum allowed request body size is 5242880 bytes."
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidiModelsRequest",
        "message": "Cannot upload Thumbnail.",
        "details": [{
                "code": "InvalidRequestBody",
                "message": "Invalid Thumbnail format. Please use one of the supported media formats: 'image/jpeg', 'image/png'.",
                "innerError": {
                    "code": "InvalidThumbnailFormat"
                }
            },
            {
                "code": "MissingRequiredHeader",
                "message": "Required header is missing.",
                "target": "content-type"
            },
            {
                "code": "InvalidHeaderValue",
                "message": "'image/gif' is not supported 'content-type'. Supported media types are 'image/jpeg', 'image/png'.",
                "target": "content-type"
            }
        ]
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

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

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

image

The binary image file

TableSchema

No data.

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

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.

TableSchema

error

Error

Error information.