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 parameters
The ID of the issue to add an attachment to.
Request headers
OAuth access token with scope issues:modify
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
The file's filename. This will determine the MIME type of the file when requested.
A string describing the significance of this attachment.
If this attachment is being created from an Image Drop control, this associates the attachment with that control.
Example
{ "fileName": "CrackedConcrete.png", "caption": "Picture of the cracked concrete", "binding": "TypeOfDefect" }
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.
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.
{ "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 an issue that does not exist or is inaccessible to the user.
{ "error": { "code": "IssueNotFound", "message": "Requested issue is not available.", "target": "id" } }
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.
{ "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.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
The number of requests exceeds the rate-limit for the client subscription.
Attachment Metadata (create)
The file's filename. This will determine the MIME type of the file when requested.
A string describing the significance of this attachment.
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.
Short string indicating the general category of error that occurred, such as '{Resource}NotFound'.
Longer string explaining to developers why the error occurred.
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.
Short string indicating the general category of error that occurred, such as 'Invalid{resource}Request'.
Longer string explaining to developers why the error occurred.
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.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Details
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.