PUT https://dev-api.bentley.com/itwins/{iTwinId}/image
Uploads an image for the specified iTwin. Maximum supported size is 5 megabytes.
A small, thumbnail image will be automatically generated based on the uploaded image. For convenience, the link to this thumbnail is also returned in the 'image' property on the iTwin.
Upload the image by adding a binary stream to the request body. You must specify the Content-Type header as either image/png or image/jpeg.
C# Example:
var stream = File.OpenRead("c:/test.jpg");
var streamContent = new StreamContent(stream);
streamContent.Headers.ContentType = new MediaTypeHeaderValue ("image/jpeg");
var response = await httpClient.PutAsync($"{iTwinId}/image", streamContent);
The user must have the itwins_modify permission on the iTwin in order to add an image to the iTwin.
An Organization Administrator can modify any iTwins owned by their Organization. This allows Organization Administrators to upload an iTwin image.
Organization Administrators are power users for all iTwins owned by their organization. They will be able to create, modify or delete any iTwin.
Example: john.doe@example.com is an Organization Administrator that works for Example Industries. John will be able to create iTwins and those iTwins will belong to Example Industries. John and any other Organization Administrator for Example Industries will be able to update or delete the iTwin. Any user (an employee of Example Industries, or an external participant) can be [invited] (https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-user-members/) to collaborate on the iTwin.
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.
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
HeaderNotFound
{"error":{"code":"HeaderNotFound","message":"Header Authorization was not found in the request. Access denied."}}
Invalid request to add iTwin image. Review the 'Field Values' section near the top of this page.
json
{"error":{"code":"InvalidiTwinsRequest","message":"Cannot create iTwin Image.","details":[{"code":"ReadOnlyProperty","message":"Id is read only and cannot be modified.","target":"id"},{"code":"InvalidRequestBody","message":"The iTwin Image is too big. It cannot be greater than 5 MB.","target":"image"},{"code":"InvalidValue","message":"The width or height dimensions of the image cannot be greater than 5 times the size of each other.","target":"image"}]}}
The generated name of the small image. It is unique and will only change if the image changes. The small image is an automatically generated thumbnail of the uploaded image.
smallImageUrl
String
The URL of the small image. This URL is also returned as a property on each iTwin. This makes it easy to use as a thumbnail.
largeImageName
String
The generated name of the uploaded image. It is unique and will only change if the image changes.
largeImageUrl
String
The URL of the large image. Usually, only the small image is used but this URL will provide the orginal large image if needed.
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.