ApiTool

API50 [ApiTool] exposes the CollabNet TeamForge SOAP service interfaces for use by Velocity templates.

While the interfaces corresponding to the SOAP API are provided, the implementation is efficient; the SOAP network protocol is not actually used.

Note: API44 and API43 are present for backward compatibility. API50 may be deprecated in the future.

Interfaces

Interface	Description
sessionKey	Gets the soap session id that should be passed in as the first parameter to soap service methods.
discussionApp	Gives access to the methods in the Discussion application.
documentApp	Gives access to the methods in the Documents application.
frsApp	Gives access to the methods in the File Releases application.
integrationDataApp	Gives access to the methods for Data Integration.
newsApp	Gives access to the methods in the Project News application.
rbacApp	Gives access to the methods for role‐based access control.
scmApp	Gives access to the methods for version control (SCM) integration.
TeamForge	Gives access to the methods in the main CollabNet TeamForge application.
taskApp	Gives access to the methods in the Tasks application.
trackerApp	Gives access to the methods in the Tracker application.
wikiApp	Gives access to the methods in the Wiki application.
categorizationApp	Gives access to the methods in project categorization.
emptyFilter	Gets an empty filter that can be passed into methods that require soap filters.

Example

This is an example of how you might use some popular API calls in a Velocity template:

## Display current project title and description #set( $sessionKey =
        $API50.sessionKey ) #set( $projectId = $PAGE_INFO.projectId ) #set( $projectData =
          $API50.TeamForge.getProjectData($sessionKey,$projectId) )
        <h1>${projectData.title}</h1>
        <p>${projectData.description}</p>