You are not logged in. Click here to log in.

codebeamer Application Lifecycle Management (ALM)

Search In Project

Search inClear

Tags:  not added yet

Swagger documented Rest based API

Swagger V3 built for designing APIs with the OpenAPI Specification (OAS), and has continued to meet the needs of developers building APIs with OAS. Swagger validates our design in real-time, checks for OAS compliancy, and provides visual feedback on the go.

REST API (v1) documentation and examples

  • For new development it is strongly recommend using the new Swagger V3 API.
  • REST API (v1) remains maintained however no further development is planed.

Wiki plugin development

You can also develop your own Wiki plugins to extend codeBeamer with your own reports, charts, etc...

The Wiki plugin api documentation is available below this directory with few examples Wiki API

The Wiki plugins's sources which are included in codeBeamer also is available inside the your codeBeamer installation at this location:./CB-7.6.0/tomcat/webapps/cb/codebeamer-wiki-plugins-src-7.6.0.zip. This zip file contains the java sources for the wiki plugins.

Most plugins use Velocity for HTML templating. The velocity templates for plugins be found in your local codeBeamer installation: in the /CB-7.6.0/tomcat/webapps/cb/config/templates/wiki-plugin directory.

Jenkins plugin and Jenkins integration

codeBeamer's Jenkins plugin is a plugin into Jenkins allows communication and integration with codeBeamer servers. For more information please refer to Jenkins Plugins.

Word templating (customizing, examples)

In codeBeamer custom Word templates can be added. The Word templating is documented here: Word Templates in CB 7.2 - 9.2.

You will find two detailed examples for custom Word templates here: An example of customizing Word templates in round-trip export and Customizing export template for Test Management: exporting Test Runs