Get Started
Documentation
Samples

Issues

Overview
Tutorials
Samples
Reference
Changelog

Attachments

Download API definition:
Add attachment to issue
POST https://api.bentley.com/issues/{id}/attachments

Adds a new attachment to the specified issue. 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 ProjectWise Forms Comment (Forms_CommentAccess) permission for the project, 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 issues:modify.

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

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope issues:modify

Accept
No

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

Request body

Attachment Metadata (create)

Name
Type
Required?
Description
fileName
String
Yes

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

caption
String,null
No

A string describing the significance of this attachment.

binding
String,null
No

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

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

Name
Description
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
Response 404 Not Found
This response indicates that the user attempted to add an attachment to an issue that does not exist or is inaccessible to the user.
json
Response 422 Unprocessable Entity
This response indicates that there is a problem with the request. Most likely, the 'includeHeader' parameter is included but not set to true or false.
json
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
json
Response headers
Name
Description
retry-after
The number of requests exceeds the rate-limit for the client subscription.
Definitions
Attachment Metadata (create)
TableSchema
Name
Type
Description
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.
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.
detailed-error-response
Indicates that a request failed and provides a list of details, explaining which properties or parameters in the request were incorrect. 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 'Invalid{resource}Request'.
error.message
String
Longer string explaining to developers why the error occurred.
error.details
Object[]
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.