Skip to content

attachments.md

Latest commit

 

History

History
47 lines (26 loc) · 1.64 KB

attachments.md

File metadata and controls

47 lines (26 loc) · 1.64 KB

Attachment Operations

Manage ticket and action file attachments (/api/Attachment).

Get Many

Parameters:

  • Return All / Limit
  • Ticket ID — Filter by ticket (0 = all)
  • Action ID — Filter by action; API requires ticket ID when using action filter
  • File Type — Optional file type filter

Get by ID

Returns attachment content (often binary) or metadata when Include Details is enabled.

Create

Upload a file using Filename and Data (Base64). Set Ticket ID to link to a ticket. Use Additional Fields for note, showforusers, action_id, etc.

Delete

Delete an attachment by Attachment ID.

Get S3 Presigned URL

Request an S3 presigned upload URL (POST /Attachment/GetS3PresignedURL). Additional Fields JSON is sent as a single-element array (PresignedURLRequest schema).

Presigned Upload Complete

Mark a presigned upload complete (POST /Attachment/PresignedURLUploadComplete). Additional Fields JSON is sent as a single-element array.

Get Image / Delete Image

Get or delete an inline image by Image ID (UUID) via /Attachment/image/{id}.

Get Document / Delete Document / Create Document

Get or delete a document attachment by Document ID (integer), or create via POST /Attachment/document using Additional Fields (object or array).

Create Image

Upload an inline image via POST /Attachment/image. Pass HaloPSA query parameters as Query Parameters JSON (e.g. ticket_id, atblob, atguid).

Get Image by Token

Download an image via GET /Attachment/image using Token and Nonce query parameters (anonymous/portal access pattern).