Upload attachment file - Issues

REST API Overview

Reference

Issues

Download API definition:

PUT https://api.bentley.com/issues/{id}/attachments/{attachmentId}

Uploads a file's contents, associating it with the attachment metadata instance with the given ID. The request body is simply the file's bytes. If a file was already uploaded for the attachment with the given ID, that file will be overwritten.

Permissions

To use this endpoint, the user is required to have the Forms Comment (Forms_CommentAccess) permission for the iTwin, or for the issue's associated form 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 issue this attachment belongs to.

attachmentId

Yes

The ID of the attachment metadata instance this file will be associated with.

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 201 Created

Indicates that the attachment file was successfully 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 specified attachment metadata instance does not exist or is inaccessible to the user.

json

{
    "error": {
        "code": "AttachmentNotFound",
        "message": "Requested attachment is not available.",
        "target": "attachmentId"
    }
}

Response 413 Request Entity Too Large

Indicates that the file the user attempted to upload is above the maximum size.

json

{
    "error": {
        "code": "RequestTooLarge",
        "message": "Provided file is greater than the max length of 30MB."
    }
}

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

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.

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.