Download Attachment

1 minute read

Download files attached to a specific support case or a support case note.

Request

Endpoint: https://sphereapi.admin.axway.com/sphere/api/v1/attachment

HTTP verb: GET

Parameters

Name	Type	Data Type	Required	Allow Multiple	Description
caseId	query	string	yes	no	ID of the support case. The ID is also referred to as case number.
attachmentId	query	string	yes	no	ID of the attachment to be downloaded.

Note

Attachment identifiers can be obtained with a call to the Get Case method. In the latter method’s response, files that are attached directly to cases are described under attachments. Files that are attached to notes are described under noteAttachments, nested within their respective note, nested within notes.

Response

HTTP status code: 200

Content:

Type	Data Type	Description
body	file	Contents of the retrieved file.

Headers:

Name	Data Type	Description
Content-Length	integer	Size of the file, in decimal octets.
Content-Disposition	string	Disposition type: fixed to `attachment`. Disposition parameter: fixed to `filename`. See also RFC 6266.

Example: Content-Disposition: attachment; filename=EXAMPLE.TXT.

Unsuccessful responses

Content:

Type	Data Type	Description
body	ErrorResponse	Details of the error that occurred.

Last modified March 18, 2022: Deleted or moved the description summary text from the front matter (#33) (142bf2a)