CreateNoteAttachment

Description

This service creates a new note attachment in an existing item.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
item (required)	ItemIdentifier	Specifies the item that receives the new note.
author (optional)	UserIdentifier	Indicates the author of the note.
noteContents (required)	NoteAttachmentContents	Holds the time, title, content, and access-type for the note.

Response

A boolean is returned. True indicates the note was created successfully; false indicates the note was not created:

<ae:CreateNoteAttachmentResponse>
   <ae:return>true</ae:return>
</ae:CreateNoteAttachmentResponse>

To verify the contents of the note, view the <ae:note> element in the TTItem response of the GetItem call.

Usage

The CreateNoteAttachment call provides a method to add a single note to an auxiliary or primary item, given the proper privileges. If the call fails, the note is not be added. To create multiple notes for a single item, you must call CreateNoteAttachment for each note. You must have the table ID and item ID of the auxiliary or primary item prior to calling CreateNoteAttachment because the IDs are required in the ItemIdentifier argument.

Faults

Invalid database pointer.
The item ID is not valid.
The user lacks sufficient permission.
Creating the record fails.
Failed to create the note.

XML

The following XML is a snippet of the payload that is sent with CreateNoteAttachment.

<urn:CreateNoteAttachment>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
    </urn:auth>
    <urn:item>
        <urn:displayName></urn:displayName>
        <urn:id>142</urn:id>
        <urn:uuid></urn:uuid>
        <urn:tableId>1000</urn:tableId>
        <urn:tableIdItemId></urn:tableIdItemId>
        <urn:issueId></urn:issueId>
    </urn:item>
    <urn:author>
        <urn:displayName></urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:loginId></urn:loginId>
    </urn:author>
    <urn:noteContents>
        <urn:time></urn:time>
        <urn:title>Note Title</urn:title>
        <urn:body>This is a note.</urn:body>
        <urn:accessType>ATTACHACCESS-DEFAULT</urn:accessType>
    </urn:noteContents>
</urn:CreateNoteAttachment>