Changes 2026.04.27

What's New

GET /api/watchlist-manager/trends

List trend records

POST /api/watchlist-manager/trends

Add trend record

DELETE /api/watchlist-manager/trends/processInstances/{processInstanceId}

Delete trend records by process instance ID

GET /api/watchlist-manager/trends/processInstances

List process instances for a trend value

GET /api/watchlist-manager/trends/{id}

Get trend record by ID

GET /api/watchlist-manager/trends/stats

Query trend statistics

What's Changed

DELETE /api/process-manager/processInstances/{processInstanceId}

Parameters:

Added: deleteTrends in query

When true, deletes associated trends related to this process instance after this process instance is removed.

This change is backwards compatible - the deleteTrends parameter is not required. If not specified, the parameter defaults to 'false', ensuring the behaviour remains the same as before.

POST /api/process-manager/processInstances/create

Return Type:

Changed response : 201 Created

Created

  • Changed content type : application/json
  • Added property processServerUrl (object)

This change is backwards compatible, provided that clients invoking this API are configured to ignore unknown properties as detailed in API Versioning

Other Changes

Content Type

The response types of the following operations have been corrected in the OpenAPI spec. Previously the return type was marked as */* , the corrected content type application/json is now provided.

The content-type-related changes are documentation-only changes. The API remains backwards compatible. This change is a correction of the documentation.

The following APIs have the return types correct for HTTP 20x, 40x and 50x return codes:

  • GET /api/watchlist-manager/watchlists/usage/largest
  • GET /api/watchlist-manager/watchlists/{watchlistId}/usage
  • GET /api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}
  • DELETE /api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}
  • GET /api/watchlist-manager/watchlists/usage
  • POST /api/watchlist-manager/watchlists/{watchlistId}/queries
  • GET /api/watchlist-manager/watchlists/{watchlistId}
  • DELETE /api/watchlist-manager/watchlists/{watchlistId}
  • POST /api/watchlist-manager/watchlists/{watchlistId}
  • DELETE /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}
  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}
  • GET /api/watchlist-manager/watchlists
  • POST /api/watchlist-manager/watchlists
  • DELETE /api/watchlist-manager/facewatchlists/{watchlistId}
  • GET /api/watchlist-manager/facewatchlists/{watchlistId}
  • POST /api/watchlist-manager/facewatchlists/{watchlistId}
  • POST /api/watchlist-manager/watchlists/{watchlistId}/entries
  • GET /api/watchlist-manager/watchlists/{watchlistId}/entries
  • POST /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members
  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members
  • POST /api/watchlist-manager/facewatchlists
  • GET /api/watchlist-manager/facewatchlists

Period Format

The API docs for the following APIs have been corrected with the correct formatting for ISO‑8601 duration/period. Previously, the documentation contained an incorrect nested structure. The correct string format is now present.

The changes related to the formatting of entryExpirationPeriod in the APIs listed below are documentation-only changes. The API remains backwards compatible. This change is a correction of the documentation.

The following APIs have their documentation for entryExpirationPeriod corrected:

  • POST /api/watchlist-manager/watchlists
  • POST /api/watchlist-manager/watchlists/{watchlistId}

Binary Format

The API docs for the following APIs have been corrected with the correct formatting for base64 binary content. Previously, the documentation contained an incorrect type of array. The correct type: string, format: byte is now present.

The changes related to the formatting of faceImage and template or resource in the APs listed below are documentation-only changes. The API remains backwards compatible. This change is a correction of the documentation.

The following APIs have their documentation for faceImage, template or resource corrected:

  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}/image
  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}
  • POST /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members

Sort Type

The API docs for the following APIs have changed - this is due to a combination of OpenAPI tooling and framework changes. The documentation of the returned sort type has changed in the OpenAPI doc; the API remains backwards compatible.

The changes related to the formatting of sort type in the response returned by the APIs listed below. The API remains backwards compatible. As always, we recommend that clients are configured to ignore unknown properties as detailed in API Versioning

The following APIs have their documentation for faceImage, template or resource corrected:

  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members
  • GET /api/watchlist-manager/facewatchlists
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard