Skip to main content
Use the pages below to look up available objects, methods, and endpoints for each API surface.

Scripting API

Entry point for board-level scripts. Covers the scripting lifecycle, execution context, and how to attach scripts to a Planningboard widget.

Item Script API

Per-card scripting hooks. Control card appearance, tooltip content, and custom actions on individual work item cards.

Config Script API

Programmatic access to widget configuration. Read and override widget parameters at runtime from within a board script.

Data Script API

Access to board data during script execution — Plans, work items, swimlane assignments, and capacity values.

REST API

HTTP endpoints for querying and manipulating Planningboard data from external systems or automation scripts.

Teams Service API

API surface for the Teams Service integration — query team membership, capacity, and resource assignments.
Scripting APIs (Item Script API, Config Script API, Data Script API) run inside the Planningboard server context and are configured through widget parameters. The REST API is called from outside Polarion over HTTP. The Teams Service API is relevant only when the Teams Service integration is enabled — see Teams Service Properties and Scripting Properties.

​
API Relationships

Planningboard Widget branches into the Scripting API (Config, Data, and Item Script APIs, running server-side), the REST API (called over HTTP by external clients and automation), and the Teams Service API (calling the Teams Service backend when the integration is enabled)
KB Articles
  • Planningboard: Customizable Statistics and Capacity Indicators
Source Code
  • PlanningBoardApiServlet.java
  • PlanningBoardViewServlet.java
Last modified on July 9, 2026