Web Services Developer's Guide → Web Services API Reference → SBM Application Web Services → Application Calls → CreateAuxItem
This service creates a single auxiliary item in the specified table.
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 is created. |
item (required) | TTItem | The items to be created. The TTItem types hold the generic data for the item. |
options (optional) | ResponseItemOptions | Enables you to limit the data that is returned in the response. |
TTItemHolder is returned for the item that is specified in the call. The new auxiliary item is returend with updated item data, which shows the unique TS_ID of the record and the TS_ID of the table to which it was added. For more detail, see TTItemHolder
The CreateAuxItem call provides a method to add a new record 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 item, add records to the lists that are defined in TTItem. To create a file attachment, see CreateFileAttachment.
Use the following elements in the options parameter to control how this call is processed and what data is returned:
For more information on the options elements, see ResponseItemOptions.
The following XML is a snippet of the payload that is sent with CreateAuxItem.
<urn:CreateAuxItem> <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: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:options> </urn:CreateAuxItem>
Copyright © 2007–2019 Micro Focus or one of its affiliates. All rights reserved.