Installing the SBM Web Services API

To use the SBM Application Engine Web Services API, you must install SBM version 10.1 or later. The SBM Application Engine Web Services API is installed when you perform either a Complete installation or a Custom installation that includes the SBM Application Engine. By default, the SBM Application Engine Web Services API is installed in the following location:

\installDirectory\Application Engine\webservices

On-Demand users can access the SBM Web services here:

https://serenasupport.serenamashups.com/gsoap/sbmappservices72.wsdl

For details on the installation process, see the SBM Installation and Configuration Guide.

The latest Web service calls for SBM Web services version 7.2 can be found in the sbmappservices72 and sbmadminservices72 WSDLs. However, all TeamTrack Web services and earlier SBM Web services are still compatible with this release. These prior Web services include ttwebservices, aewebservices70, and aewebservices71. You can download Web services guides for earlier versions at http://www.serena.com/support.

It is recommended that you upgrade existing applications that use the older Web services (ttwebservices, aewebservices70, and aewebservices71) to use the new Web services available in SBM Web services version 7.2; however, you can continue to use existing applications in tandem with new or upgraded applications that take advantage of the enhancements introduced in SBM Web services version 7.2. To upgrade, simply update your existing endpoints with the new WSDL name and change the arguments in your existing call list as necessary. If you are currently using the calls found in ttwebservices, aewebservices70, and aewebservices71, compare your existing calls with those in SBM Web services version 7.2 and consider upgrading in order to take advantage of the expanded identifiers, options, and tighter processing control.

Note: As of SBM Web services version 7.2, Multi-Selection, Multi-User, and Multi-Relational fields no longer accept a comma-separated list of internal (tableid:internal-item-id) values on update. Instead, you must specify values individually in an array of values to update the field. For example:

<urn:extendedField>
   <urn:id>
      <urn:displayName>MULTI-RELATIONAL</urn:displayName>
      <urn:id></urn:id>
      <urn:uuid></urn:uuid>
      <urn:dbName></urn:dbName>
   </urn:id>
   <urn:setValueBy>DISPLAY-VALUE</urn:setValueBy>
   <urn:setValueMethod>APPEND-VALUES</urn:setValueMethod>
   <urn:value>
      <urn:displayValue>Value1</urn:displayValue>
      <urn:internalName></urn:internalName>
      <urn:internalValue></urn:internalValue>
      <urn:uuid></urn:uuid>
   </urn:value>
   <urn:value>
      <urn:displayValue>Value2</urn:displayValue>
      <urn:internalName></urn:internalName>
      <urn:internalValue></urn:internalValue>
      <urn:uuid></urn:uuid>
   </urn:value>
</urn:extendedField>

SBM provides sample programs written in C# that interact with the SBM Web services API. These samples are discussed in more detail in Sample Programs.