• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Table of contents
    Overview
    Samples
    Changelog
    Forms
    Download API definition:
    Get static image
    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 available 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 forms:read.

    For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

    Request

    Request parameters

    Name
    In
    Required?
    Description
    id
    template
    Yes

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

    fileId
    template
    Yes

    The ID of the image.

    Request headers

    Name
    Required?
    Description
    Authorization
    Yes

    OAuth access token with scope forms:read

    Accept
    No

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

    Response

    Response 200 OK

    OK

    json
    {
    "_links": {
        "imageUrl": {
            "href": "https://formseussa01.blob.core.windows.net/ababcdcd-ce7c-46ed-aeff-2f2df12345a4/1?sv=2015-04-05&sr=b&sig=tRzkbP7gGx5%asfiaoew8GnU2LYIhUeHNxzhK5%2BBsWc%3D&se=2021-05-26T23%3A07%3A45Z&sp=rw"
        }
    }
}

    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

    Name
    Description
    retry-after

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

    Definitions

    Static Image Response

    TableSchema
    Name
    Type
    Description
    _links
    static-image-link

    Static Image Link

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

    TableSchema
    Name
    Type
    Description
    imageUrl
    link

    link

    TableSchema
    Name
    Type
    Description
    href
    String

    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
    Name
    Type
    Description
    error.code
    String

    Short string indicating the general category of error that occurred, such as '{Resource}NotFound'.

    error.message
    String

    Longer string explaining to developers why the error occurred.

    error.target
    String,null

    If relevant, this is the name of the property, URL template parameter, or query parameter that caused the error.

    Error

    Contains error information and an optional array of more specific errors.

    TableSchema
    Name
    Type
    Description
    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.

    details
    ErrorDetails[]

    Optional array of more specific errors.

    Error Details

    Contains error information.

    TableSchema
    Name
    Type
    Description
    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
    Name
    Type
    Description
    error
    Error

    Error information.