Let the platform do the work
SugarClubContact+1 (877) 842-7276

get_note_attachment

Overview

Retrieves an attachment associated with a specific note record.

Available APIs

  • SOAP
  • REST

Definition

get_note_attachment(session, id)

Parameters

Name Type Description
session String Session ID returned by a previous login call.
id String The ID of the note record to associate the attachment to.

Result

Name Type Description
result new_return_note_attachment | Array The call result.
result.note_attachment Array The details of the file attachment.
result.note_attachment.id String The ID of the note record / attachment.
result.note_attachment.filename String The filename of the attachment.
result.note_attachment.file String The binary contents of the file.
result.note_attachment.related_module_id String The related parent ID.
result.note_attachment.related_module_name String The related parent module.

Change Log

Version Change
v2 Return type was changed from return_note_attachment to new_return_note_attachment.

Examples

PHP

$get_note_attachment_parameters = array(
    //Session id
    "session" => $session_id,

    //The ID of the note containing the attachment.
    'id' => "9057784d-de17-4f28-c5f9-50bd0f260a43",
);

Topics