Issues

Attachments

Download API definition:

PUT https://sampleHostName/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 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 parameters

Name
In
Required?
Description
id
template
Yes

The ID of the issue this attachment belongs to.

attachmentId
template
Yes

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

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.

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

Response 404 Not Found

This response indicates that the specified attachment metadata instance does not exist or is inaccessible to the user.

json

Response 413 Request Entity Too Large

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

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.