deleteAttachment

Overview

This method deletes an existing attachment.

The attachment's [gb_attachments]status_flag is set to 'deleted'. The record stays linked to its parent record, for example an event.

This method requires the Attachments:Delete permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Attachments:Delete'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'DELETE' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/gb/attachments/{attachment_id} https://api.{{environment}}.catch-e.com/gb/attachments/{attachment_id} https://api.test.catch-e.com/gb/attachments/{attachment_id}

Input Fields (Header)

Key	Format	Notes	Mandatory
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No

Path Parameters

Key	Format	Notes	Mandatory
attachment_id	string	The Attachment Id. A positive whole number, up to 10 digits, with no leading zeros.	Yes

Response Details

Success

204 - No Content

The attachment was deleted successfully. No response body is returned.

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	The attachment does not exist.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }