ItemIdentifier

Description

The ItemIdentifier type holds the identification information for an item. The ItemIdentifier type parameters are listed below.

Parameters

Name	Type	Description
identifier	Extension. See Identifier.	Generic identification extension base. Holds the displayName, id, and uuid for an item.
tableID	integer	The TS_ID of the table that contains this item.
tableIdItemId	string	The TS_ID of the table, followed by the TS_ID of the item in that table (for example, 1000:164).
issueId	string	Item name for display purposes.

Usage

The ItemIdentifier is the identifier that can be used in Web service methods to uniquely identify an item. The ItemIdentifier contains the generic information about an item (including the display name, ID, and UUID) in addition to table ID and issue ID information for the item.

Note: You can send any one of the item elements in the identifier—you do not need to provide values for every element. You only need to provide more than one element in the event that the first element does not uniquely identify the object. You must provide either tableIdItemId or tableid in calls that take an ItemIdentifier as input (such as GetItem). This means you can use the uuid, displayName, or issueId, as long as you include tableIdItemId or tableid as well.

XML

The following XML shows ItemIdentifier as seen in a typical call.

<urn:item>
    <urn:displayName>BUG000059</urn:displayName>
    <urn:id>25</urn:id>
    <urn:uuid>7d4703a0-302d-4da3-891e-1d36d43613f2</urn:uuid>
    <urn:tableId>1000</urn:tableId>
    <urn:tableIdItemId>1000:25</urn:tableIdItemId>
    <urn:issueId>000059</urn:issueId>
</urn:item>