Issues

Attachments

Download API definition:

GET https://sampleHostName/issues/{id}/attachments

Retrieves the metadata for all files attached to the given issue. In order to get the contents of a file itself, use the Get attachment file by ID endpoint, passing the id from the metadata object returned by this request as the attachmentId parameter of that request.

Permissions

To use this endpoint, the user is required to have the ProjectWise Forms View (Forms_ViewAccess) permission for the project, or for the issue's associated definition if form definition security is specified. (Having any other ProjectWise Forms permission automatically grants the View permission as well.)

Authentication

Requires Authorization header with valid Bearer token for scope issues:read.

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 to get attachments for

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope issues:read

Accept
No

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

Response 200 OK

OK

json

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 issue does not exist or is inaccessible to the user.

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.