CreateAuxItems

Description

This service creates one or more auxiliary items within the same table.

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.
table (required)	TableIdentifier	Specifies the table where the item or items are created.
item (required)	TTItem	The list of items that are created. The TTItem types hold the generic data for each item.
options (optional)	MultipleResponseItemOptions	Specifies whether the service should continue if an error is encountered, or stop. Also enables you to limit the data that is returned in the response.

Response

TTItemHolder is returned, one for each item that is specified in the call. The new auxiliary items are returend with updated item data, which shows the unique TS_IDs of each record and TS_IDs of the table to which they were added. For more detail, see TTItemHolder

Usage

The CreateAuxItems call provides a method to add new records to a given auxiliary table. If you have the proper privileges, you can add new records to both custom and system auxiliary tables.

To create notes, item links, and URL attachments on the new auxiliary items, add records to the lists that are defined in TTItem. To create a file attachment, see CreateFileAttachment.

Tip: You must have the table ID and item ID of the auxiliary item prior to attaching a file to the item because the IDs are required in the ItemIdentifier argument of CreateFileAttachment.

Use the following elements in the options parameter to control how this call is processed and what data is returned:

multiOption – Enables you to specify whether the service should continue if an error is encountered, or stop and throw an error. If any failures occur, each successive error message is appended to the string that is returned. Multiple error messages are separated by a single newline. Failures do not result in a return before all items have been processed.
sections and specifiedSections – Enables you to specify which parts of an item should be returned. This allows you to limit the data that is returned for a given item. The sections that aren't specified are not included in the response. For example, if the items you are creating have a large number of item links, notes, URL and file attachments that don't need to be returned in the response, use the sections parameter to return only the sections of an item you want.
limitedField – Enables you to specify which fields you want returned in the response. For example, you can specify one or more fields to limit a service response to return only the fields that you want returned.

For more information on the options elements, see MultipleResponseItemOptions.

Faults

Invalid database pointer.
The table ID is not valid.
The user lacks sufficient permission.
Creating the record fails.
Reading the item fails.

XML

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

<urn:CreateAuxItems>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
    </urn:auth>
    <urn:table>
        <urn:displayName></urn:displayName>
        <urn:id>1004</urn:id>
        <urn:uuid></urn:uuid>
        <urn:dbName></urn:dbName>
    </urn:table>
    <urn:item>
        <urn:id>
            <urn:displayName></urn:displayName>
            <urn:id></urn:id>
            <urn:uuid></urn:uuid>
            <urn:tableId></urn:tableId>
            <urn:tableIdItemId></urn:tableIdItemId>
            <urn:issueId></urn:issueId>
        </urn:id>
        <urn:itemType></urn:itemType>
        <urn:title>New Aux Item 1</urn:title>
        <urn:description></urn:description>
        <urn:subtasks/>
        <urn:extendedField>
            <urn:id>
                <urn:displayName>Field Name</urn:displayName>
                <urn:id>153</urn:id>
                <urn:uuid></urn:uuid>
                <urn:dbName>FIELD_NAME</urn:dbName>
            </urn:id>
            <urn:setValueBy>DISPLAY-VALUE</urn:setValueBy>
            <urn:setValueMethod>REPLACE-VALUES</urn:setValueMethod>
            <urn:value>
                <urn:displayValue>test text</urn:displayValue>
                <urn:internalValue></urn:internalValue>
                <urn:uuid></urn:uuid>
            </urn:value>
        </urn:extendedField>
    </urn:item>
    <urn:item>
        <urn:id>
            <urn:displayName></urn:displayName>
            <urn:id></urn:id>
            <urn:uuid></urn:uuid>
            <urn:tableId></urn:tableId>
            <urn:tableIdItemId></urn:tableIdItemId>
            <urn:issueId></urn:issueId>
        </urn:id>
        <urn:itemType></urn:itemType>
        <urn:title>New Aux Item 2</urn:title>
        <urn:description></urn:description>
        <urn:extendedField>
            <urn:id>
                <urn:displayName>Field Name</urn:displayName>
                <urn:id>153</urn:id>
                <urn:uuid></urn:uuid>
                <urn:dbName>FIELD_NAME</urn:dbName>
            </urn:id>
            <urn:setValueBy>DISPLAY-VALUE</urn:setValueBy>
            <urn:setValueMethod>REPLACE-VALUES</urn:setValueMethod>
            <urn:value>
                <urn:displayValue>test text</urn:displayValue>
                <urn:internalValue></urn:internalValue>
                <urn:uuid></urn:uuid>
            </urn:value>
        </urn:extendedField>
    </urn:item>
    <urn:options>
        <urn:extraOption>
            <urn:name></urn:name>
            <urn:value></urn:value>
        </urn:extraOption>
        <urn:sections>SECTIONS-SPECIFIED</urn:sections>
        <urn:specifiedSections>SECTION:FIXED,SECTION:EXTENDED</urn:specifiedSections>
        <urn:limitedField></urn:limitedField>
        <urn:multiOption>CONTINUE-ON-FAILURE</urn:multiOption>
    </urn:options>
</urn:CreateAuxItems>