P4 Plan API Release Notes

Version numbers

P4 Plan versions are named e.g. 2025.1/001, where 2025 is the release year, 1 is the release number and 001 is the build number.

Any version includes all changes of previous releases.

Versions prior to 2024.1 use the older format, for example 11.1055.

Release notes for the P4 Plan products

• P4 Plan Client & Server
• P4 Plan Web
• P4 Plan API
• P4 Plan for Jira Cloud
• P4 Plan for Jira Server
• P4 Plan for Perforce ALM
• P4 Plan for LDAP

Note

The product is now named P4 Plan. Read more about the change here: Introducing the p4 platform

2025.2/001

Release date: 2025-06-24

New features

• averageLineIsVisible available on bar charts, line charts and area charts
• committedToIndentationLevel available on scheduled tasks, backlog tasks and bugs
• canBeBrokenDown available on scheduled tasks and backlog tasks
• markdown is a new HelixCoreCommentType

Fixes

• 9418 B: High DoS vulnerability CVE-2025-48997 in multer (via platform-express)

Compatibility

• Requires P4 Plan Server 2025.2/001 or higher

2025.1/002

Release date: 2025-05-13

New features

• Start and finish date can be set when creating or updating scheduled tasks
• estimatedDaysHours project setting

Compatibility

• Requires Helix Plan Server 2025.1/005 or higher

2025.1/001

Release date: 2025-03-25

New features

• New queries:
  • projectCalendarDayInfo
  • sprintItems
  • sprintWorkRemainingHistory
  • sprintEstimatedDaysHistory
  • sprintPointsHistory
• New mutations:
  • createSprintTask
  • commitToSprint
• New subscriptions:
  • itemCommittedToSprint
  • projectTreeUpdated
• points and estimatedDays available on bugs
• allocations available on sprints
• accessRights for users available on projects

Fixes

• 68283 A: API hangs when doing deep tree changes in sprints
• 68364 C: Mutations where workflow status is updated, do not wait for the sdk function to return which can lead to outdated values in the response

Compatibility

• Requires Helix Plan Server 2025.1/001 or higher

2024.3/002

Release date: 2025-01-28

New features

• Show more descriptive error messages for validation errors
• outOfOfficeStatus and outOfOfficeCalendarSettings available on scheduled tasks

Fixes

• 9246 C: The "reports" query checks column permissions of projects where the user is not a member

Compatibility

• Requires Helix Plan Server 2024.3/002 or higher

2024.3/001

Release date: 2024-12-17

New features

• Print node version at startup
• targetLine available on area charts, bar charts, and line charts

Compatibility

• Requires Helix Plan Server 2024.3/001 or higher

2024.2/004

Release date: 2024-11-12

New features

• New mutation setDefaultQaWorkflow
• defaultWorkflow available on QA projects

Fixes

• 9197 B: QA permission rules giving edit access on fields to users, are ignored in the API and web client
• 9213 B: addInternalLink mutation yields an "ADD_LINKED_FAILED" error
• 67068 C: A deleted column in one project that exists in another project shows as existing in both projects

Compatibility

• Requires Helix Plan Server 2024.2/010 or higher

2024.2/003

Release date: 2024-10-15

New features

• Fail to connect to the Helix Plan server if the SDK user does not have the "Sync all projects" flag set

Fixes

• 9188 B: Users with Administration access are treated as main managers in column permissions

Compatibility

• Requires Helix Plan Server 2024.2/010 or higher

2024.2/002

Release date: 2024-10-01

New features

• Create scheduled tasks
• Create sprints
• Create releases
• Update dates on sprints and releases
• Queries and subscriptions for the report list
• Queries for report results
• Move cards on sprint boards
• Default sprint length in project settings
• Template strings in projects
• Subproject flag on scheduled tasks

Fixes

• 65589 B: User related fields throw errors when user has been deleted

Compatibility

• Requires Helix Plan Server 2024.2/010 or higher

2024.2/001

Release date: 2024-08-20

New features

• percentCompleted available on scheduled tasks
• The "items" query can now search in multiple projects, if a valid find query is provided
• Allow backlog id or QA id as input to the "project" query

Compatibility

• Requires Helix Plan Server 2024.2/005 or higher

2024.1/002

Release date: 2024-06-11

New features

• Add time spent updates to timesheet, if the option is enabled on the custom Time spent column.

Compatibility

• Requires Helix Plan Server 2024.1/013 or higher

2024.1/001

Release date: 2024-05-21

Upgrade notes

• The config parameters 'HansoftHost' and 'HansoftPort' have been renamed 'HelixPlanHost' and 'HelixPlanPort'. If you are running an earlier version of the API, rename these parameters in your '.env' file during upgrade. You can also refer to 'config-example.env'.

New features

• Changed product name to Helix Plan API
• Update items in the planning view (Releases, Scheduled Tasks, Sprints)
• Add, remove, and edit links
• Full support for commenting system
• Real-time updates (subscriptions) for:
  • Dashboards and chart data
  • Assignments
  • Deleted items
  • Field updates
  • Project memberships
  • Workflow updates
• Ability to query the following:
  • To-do list
  • Active columns
  • Board columns and lanes
  • Charts
  • Comments
  • User's projects See documentation for a complete list of supported commands: http://help.perforce.com/hansoft/current/hansoftapi/Content/hansoftapi/index.html

Fixes

• B 8794: The Helix Plan API does not release any memory when it is disconnected from the server and reconnects

Compatibility

• Requires Helix Plan Server 2024.1/013 or higher

11.1007

Release date: 2023-10-03

New features

• Create custom columns of all types
• Create, read, update and delete backlog tasks
• Create, read, update and delete bugs
• Read and update custom fields for backlog tasks and bugs See documentation for a complete list of supported commands: http://help.perforce.com/hansoft/current/hansoftapi/Content/hansoftapi/index.html

Fixes

• C 8835: When deleting a project subscription, the Project field is returned instead of the project ID
• D 8967: Replace deprecated 'sourcemap-codec' with @jridgewell/sourcemap-codec

Compatibility

• Requires Hansoft Server 11.1043 or higher

11.1005

Release date: 2023-04-25

Fixes

• A 8918: Not possible to log in if some other SDK channel has the option "credential resolution" disabled.

Compatibility

• Requires Hansoft Server 11.1013 or higher
• Requires Hansoft SDK 11.102 or higher

11.1004

Release date: 2023-02-38

Fixes

• A 8878: Vulnerability CVE-2019-18413 in class-validator

Compatibility

• Requires Hansoft Server 11.1004 or higher
• Requires Hansoft SDK 11.101 or higher

11.1002

Release date: 2023-01-31

Fixes

• A 8853: Vulnerability CVE-2022-23529 in the jsonwebtoken library
• D 8849: Warnings in server.log when there are multiple open subscriptions

Compatibility

• Requires Hansoft Server 11.1004 or higher
• Requires Hansoft SDK 11.101 or higher

11.1001

Release date: 2022-12-14

New features

Initial API release with support for GraphQL queries, mutations and subscriptions. Support for authentication as well as operations on users, user groups, projects, and database settings.

Supported Operating Systems

The Hansoft API runs on any 64-bit version of Linux, OS X (x64 or arm64) or Windows.

Compatibility

• Requires Hansoft Server 11.1004 or higher
• Requires Hansoft SDK 11.101 or higher