Serena Agile Web Services API → Item Management → ItemManagement Webservice Methods → GetItems
Description
This method gets a list of items matching a specified pattern.
Arguments
| Parameter | Datatype | Description |
|---|---|---|
| token | string | A security token authorizing access to the web service. |
| rootId | int | The ID of the top level project hierarchy from which to get items. The top level project has an ID value of 1. |
| typeName | string | The type items to get. |
| attributeKeys | string[] | A list of XML system names for the desired attributes to be returned. |
| filter | array of filter rules | The filters to be applied when selecting items. |
XML request
The following request specifies items of type Agile_Release under the root, and requests the start date attribute of the releases to be returned.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:agil="http://serena.com/Agile">
<soapenv:Header/>
<soapenv:Body>
<agil:GetItems>
<agil:token>authtoken</agil:token>
<agil:rootId>1</agil:rootId>
<agil:typeName>Agile_Release</agil:typeName>
<agil:attributeKeys>
<agil:string>Agile_IntervalStartDate</agil:string>
</agil:attributeKeys>
<agil:filter>
<agil:FilterRule>
<agil:key></agil:key>
<agil:op></agil:op>
<agil:value></agil:value>
</agil:FilterRule>
</agil:filter>
</agil:GetItems>
</soapenv:Body>
</soapenv:Envelope>
XML response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetItemsResponse xmlns="http://serena.com/Agile">
<GetItemsResult>
<Item>
<id>387</id>
<parentId>371</parentId>
<name>The Release Name</name>
<itemType>Agile_Release</itemType>
<attributes>
<ItemAttribute>
<key>Agile_IntervalStartDate</key>
<value>2010-02-25T08:00:00</value>
</ItemAttribute>
</attributes>
</Item>
</GetItemsResult>
</GetItemsResponse>
</soap:Body>
</soap:Envelope>