GetItem

Description

This service returns a single item, given the table ID and item ID.

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.
itemId (required)	ItemIdentifier	The item that should be returned.
options (optional)	ResponseItemOptions	Enables you to limit the data that is returned in the response.

Response

TTItemHolder is returned for the item that is specified in the call. The itemIdentifier, which shows the unique TS_ID for the record and TS_ID of the table to which it belongs is displayed. For more detail, see TTItemHolder.

Usage

The GetItem call enables you to see a snapshot of an auxiliary or primary item, without invoking any actual changes against the specified item. To return results, you must provide the table ID and either one of the elements in the itemIdentifier or the issueId for the item.

You can use the following elements in the options argument to control the service handling and response:

sections and specifiedSections – Use these elements to specify which parts of an item should be returned in order to limit the data that is returned for a given item. The sections that are not specified are not included in the response. For example, if the items have a large number of item links, notes, URL and file attachments that don't need to be returned in the response, use these parameters to return only the sections of an item you want.
limitedField – Use the limitedField element to specify specific fields to control the item data that is returned. 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 ResponseItemOptions.

Faults

The issueId = '<issue id>' provided is not unique for table '<database table name>'
Invalid item id 0 for table 0.
The item ID is not valid.
The user lacks sufficient permission.
Validation constraint violation: data type mismatch.

XML

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

<urn:GetItem>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
        <urn:extendedData>
            <urn:data>
                <urn:name></urn:name>
                <urn:value></urn:value>
            </urn:data>
        </urn:extendedData>
    </urn:auth>
    <urn:itemId>
        <urn:displayName>BUG000164</urn:displayName>
        <urn:id>106</urn:id>
        <urn:uuid></urn:uuid>
        <urn:tableId>1000</urn:tableId>
        <urn:tableIdItemId>1000:106</urn:tableIdItemId>
        <urn:issueId>000164</urn:issueId>
    </urn:itemId>
    <urn:options>
        <urn:extraOption>
            <urn:name></urn:name>
            <urn:value></urn:value>
        </urn:extraOption>
    <urn:sections>SECTIONS-SPECIFIED</urn:sections>
    <urn:specifiedSections>SECTION:FIXED</urn:specifiedSections>
    <urn:limitedField>
        <urn:displayName></urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:dbName></urn:dbName>
    </urn:limitedField>
    </urn:options>
</urn:GetItem>