Changes 2026.04.20

What's New

POST /api/process-manager/processInstances/byIds

What's Changed

GET /api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/userdata

• New query param: includeKeyedAdditionalDocs

Other Changes

We have updated the API documentation, and the published specification is now produced as OpenAPI 3.1. As a result, some APIs may appear to have changed in the spec/diff output even though runtime behavior remains backwards compatible. Most of these are representation-level changes in the specification format.

The APIs that may appear impacted by this change are:

• GET /api/process-manager/cloudSecrets
• POST /api/watchlist-manager/watchlists/{watchlistId}/queries
• GET /api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}
• POST /api/watchlist-manager/watchlists/{watchlistId}/entries
• GET /api/watchlist-manager/watchlists/{watchlistId}/entries
• GET /api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/userdata/checks
• PUT /api/process-manager/processTokens/{processTokenId}
• GET /api/process-manager/processTokens/{processTokenId}
• POST /api/process-manager/processTokens
• GET /api/process-manager/processTokens
• GET /api/process-manager/processInstances/{processInstanceId}/withParameters
• GET /api/process-manager/processInstances/{processInstanceId}
• GET /api/process-manager/processInstances/search
• POST /api/process-manager/processInstances/create
• POST /api/process-manager/processInstances
• GET /api/process-manager/processInstances
• POST /api/process-manager/processDefinitions/{processDefinitionId}/tags
• GET /api/process-manager/processDefinitions/tags

Recent documentation updates may show a higher-than-usual number of API differences if performing a 'diff' of the OpenAPI schema. These visible changes are mainly due to the move to OpenAPI 3.1 and updated schema generation behavior, which can represent equivalent API contracts in different ways.

What changed:

• The generated specification is now OpenAPI 3.1.
• Diff reports may flag more surface-level changes (formatting/structure) than before.
• Schema/metadata representation in the spec can differ from previous output. What did not change:
• API runtime behavior is intended to remain backwards compatible.
• Existing clients should continue to work without functional updates.
• Reported spec deltas do not automatically indicate a breaking change. How to interpret the diffs:
• Treat many differences as documentation/schema representation drift unless explicitly identified as behavioral.
• Prioritize validation of actual request/response contract behavior, required fields, and endpoint semantics.
• Use release notes for explicit functional or breaking changes; if not called out, assume compatibility is preserved.