Delete attachment

Request access

Important note
This API is not available as part of our free evaluation or Pay As You Grow (PAYG) offering. Click the Request Access button above to contact our Sales team.

Purpose

This call is used to remove a file you attached to a feedback, for example when the wrong file was uploaded or when the file has to be removed for privacy reasons. The file is deleted and the attachment is no longer listed with the feedback.

This cannot be undone. The feedback itself is not affected.

How to request data

HTTP method: POST

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL request format

post
URL request format
https://{baseURL}/maps/orbis/feedback/{feedbackId}/attachments/{attachmentId}/delete?key={API-key}&apiVersion={version}

This call has no request body.

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.

Parameter

Required

Type

Description

feedbackId

Yes

string

The ID of the feedback the file belongs to. Part of the URL.

attachmentId

Yes

string

The ID of the attachment, as listed with the feedback. Part of the URL.

Response data

Response codes

HTTP Code

Message

Description

Sample response

204

No Content

Attachment deleted successfully. The response has no body

403

Forbidden

Access denied

{
"detailedError": {
"code": "Forbidden",
"message": "You are not allowed to access this endpoint"
}
}

404

Not Found

Attachment or feedback not found

{
"errorText": "Attachment '6b48dd3c-6d0c-4b0a-9a6e-1f1c0e2a51f4' not found for feedback '7049aa04-91bd-4ad3-8085-bd8bec318905'",
"detailedError": {
"code": "NOT_FOUND",
"message": "Attachment '6b48dd3c-6d0c-4b0a-9a6e-1f1c0e2a51f4' not found for feedback '7049aa04-91bd-4ad3-8085-bd8bec318905'"
},
"httpStatusCode": 404
}

500

Internal Server Error

Internal server error

{
"errorText": "An unexpected error has occurred. Please try again later.",
"detailedError": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error has occurred. Please try again later."
},
"httpStatusCode": 500
}