Get static image - Forms | iTwin Platform

Forms

Download API definition:

GET https://api.bentley.com/forms/formDefinitions/{id}/staticImages/{fileId}

Gets a link to a static image to be displayed in a form. The 'fileId' parameter should match the 'fileId' property of a static image control in the form's definition. It will be a positive integer. This endpoint returns only a _links object containing the URL of the actual file, which is publicly, though temporarily, available at that address and can be set as the 'src' attribute of an HTML

tag to display the image.

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.

Request

Request parameters

Yes

The ID of the form definition for which to get a static image.

fileId

Yes

The ID of the image.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "_links": {
        "imageUrl": {
            "href": "https://example.blob.core.windows.net/..."
        }
    }
}

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

This response indicates that the static image or its associated form definition was not found.

json

{
    "error": {
        "code": "ImageNotFound",
        "message": "Requested image is not available.",
        "target": "fileId"
    }
}

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

Static Image Response

_links

static-image-link

json

{
    "type": "object",
    "title": "Static Image Response",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/static-image-link"
        }
    },
    "additionalProperties": false
}

Static Image Link

A URL of the static image file, which can be placed in an <img> tag's 'src' attribute.

imageUrl

link

json

{
    "type": "object",
    "title": "Static Image Link",
    "description": "A URL of the static image file, which can be placed in an <img> tag's 'src' attribute.",
    "properties": {
        "imageUrl": {
            "$ref": "#/components/schemas/link"
        }
    },
    "additionalProperties": false
}

link

href

String

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string"
        }
    },
    "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?