SoftLayer Ticket::getAttachedFile

From SoftLayer Development Network Wiki

Jump to: navigation, search

getAttachedFile is a member of the SoftLayer_Ticket service.

Contents

Overview

Retrieve the file attached to a SoftLayer ticket by it's given identifier. To retrieve a list of files attached to a ticket either call the SoftLayer_Ticket::getAttachedFiles method or call SoftLayer_Ticket::getObject with attachedFiles defined in an object mask.

User Access

Users wishing to execute getAttachedFile service must have the Add / Edit Tickets and View Tickets permissions assigned to their account.

Return Type

getAttachedFile returns the binary data data type.

Headers

Required Headers

getAttachedFile requires the following headers:

Parameters

getAttachedFile takes the following parameters:

attachmentId

The id of the attachment to retrieve

  • Type: integer

Error Handling

getAttachedFile throws the following exceptions:

  • SoftLayer_Exception
Throw the exception "File {attachmentId} is not attached to ticket {ticketId}." if the given file is not attached to the given ticket.
  • SoftLayer_Exception
Throw the exception "File does not exist: file not found." if the given file is attached to the ticket, but not present in SoftLayer's attachment backend filesystem.
  • SoftLayer_Exception
Throw the exception "Unable to load a valid ticket file attachment." exists but is not retrievable by the API.

Associated Methods

Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Ticket::getAttachedFile"
Personal tools