Add attachment to form - Forms

Forms

Download API definition:

POST https://api.bentley.com/forms/{id}/attachments

Adds a new attachment to the specified form data instance. This only creates the attachment metadata; the file will need to be uploaded through a subsequent PUT call to the URL returned in the Location header of this endpoint's response.

Permissions

To use this endpoint, the user is required to have the Forms Comment (Forms_CommentAccess) permission for the iTwin, or for the form's definition if form definition security is specified. (Having Create/Modify, Assign, Approve, or Full permission automatically grants the Comment permission as well.)

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 data instance to add an attachment to.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Attachment Metadata (create)

fileName

String

Yes

The file's filename. This will determine the MIME type of the file when requested.

caption

String, null

A string describing the significance of this attachment.

binding

String, null

If this attachment is being created from an Image Drop control, this associates the attachment with that control.

Example

json

{
    "fileName": "StreetView.png",
    "caption": "Picture showing the bridge from the perspective of an approaching car",
    "binding": "Location"
}

Response

Response 201 Created

Indicates that the attachment metadata was created successfully. The file should then be uploaded via PUT to the URL in the Location header.

Response headers

Location

The URL where the attachment file should be uploaded.

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 user attempted to add an attachment to a form data instance that does not exist or is inaccessible to the user.

json

{
    "error": {
        "code": "FormDataNotFound",
        "message": "Requested form data is not available.",
        "target": "id"
    }
}

Response 422 Unprocessable Entity

This response indicates that there is a problem with the format of the request body. Most likely causes: The body is not valid JSON, or the 'fileName' property is missing or not a string.

json

{
    "error": {
        "code": "InvalidAttachmentRequest",
        "message": "Cannot create attachment.",
        "details": [{
            "code": "MissingRequiredProperty",
            "message": "Required property is missing. The request must include a valid 'fileName' property.",
            "target": "fileName"
        }]
    }
}

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

Attachment Metadata (create)

fileName

String

The file's filename. This will determine the MIME type of the file when requested.

caption

String, null

A string describing the significance of this attachment.

binding

String, null

If this attachment is being created from an Image Drop control, this associates the attachment with that control.

json

{
    "type": "object",
    "title": "Attachment Metadata (create)",
    "properties": {
        "fileName": {
            "type": "string",
            "description": "The file's filename. This will determine the MIME type of the file when requested."
        },
        "caption": {
            "type": "string",
            "nullable": true,
            "description": "A string describing the significance of this attachment."
        },
        "binding": {
            "type": "string",
            "nullable": true,
            "description": "If this attachment is being created from an Image Drop control, this associates the attachment with that control."
        }
    },
    "required": [
        "fileName"
    ],
    "additionalProperties": false
}

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "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
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

Detailed 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

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "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

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?