Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
Changes.2026.09.01
What's New
GET /api/process-manager/processInstances/{processInstanceId}/fraudState
Get Process Instance Fraud State.
POST /api/process-manager/processInstances/{processInstanceId}/fraudState
Update Process Instance Fraud State.
GET /api/process-manager/archives/queries/{executionId}/status
Poll the status of a process archive search query.
GET /api/process-manager/archives/{fileKey}/sig
Download the PGP detached signature file.
GET /api/process-manager/archives/{fileKey}/archive
Download the archive ZIP file.
GET /api/process-manager/processDefinitions
List Process Definitions.
GET /api/process-manager/archivePolicies
List Archive Policies.
POST /api/process-manager/archivePolicies
Create an Archive Policy.
GET /api/process-manager/archives/queries/{executionId}/result
Retrieve results of a completed process archive search query.
GET /api/process-manager/archivePolicies/name/{name}/versions/{version}
Get an Archive Policy by name and version.
DELETE /api/process-manager/archives/{fileKey}
Delete an archive and its signature file.
POST /api/process-manager/archives/queries/start
Start a process archive search query.
POST /api/process-manager/processInstances/{processInstanceId}/processInstanceArchive
Generate a process instance data zip archive.
GET /api/process-manager/archivePolicies/name/{name}/versions
List all versions of an Archive Policy by name.
GET /api/process-manager/archivePolicies/usage
Get Archive Policy usage.
GET /api/process-manager/processInstances/{processInstanceId}/archive/status
Get the archive status of a process instance.
GET /api/process-manager/processInstances/archive/inflight
Get the tenant's current archive in-flight load.
GET /api/process-manager/archivePolicies/{id}
Get an Archive Policy.
DELETE /api/process-manager/archivePolicies/{id}
Delete an Archive Policy.
POST /api/process-manager/processInstances/archive
Submit process instances for archiving.
What's Changed
GET /api/process-manager/processDefinitions/tags
Return Type:
New response : 500 Internal Server Error
Internal Server Error
DELETE /api/process-manager/processDefinitions/tags/{name}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/process-manager/processDefinitions/{processDefinitionId}/tags
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/process-manager/processInstances/byIds
Return Type:
New response : 500 Internal Server Error
Internal Server Error
GET /api/process-manager/cloudSecrets/{cloudSecretId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/process-manager/cloudSecrets/{cloudSecretId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
DELETE /api/process-manager/cloudSecrets/{cloudSecretId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/theme-server/customPages/{id}/status/{status}
Return Type:
Changed response : 200 OK
OK
Changed content type :
*/*Added property
_links(object)
GET /api/theme-server/customPages/{id}
Return Type:
Changed response : 200 OK
OK
Changed content type :
*/*Added property
_links(object)
POST /api/theme-server/customPages/{id}
Return Type:
Changed response : 200 OK
OK
Changed content type :
*/*Added property
_links(object)
GET /api/watchlist-manager/watchlists/{watchlistId}
Return Type:
Changed response : 200 OK
Watchlist retrieved successfully
Changed content type :
application/jsonAdded property
_links(object)Navigation links for related resources
POST /api/watchlist-manager/watchlists/{watchlistId}
Return Type:
Changed response : 200 OK
Watchlist updated successfully
Changed content type :
application/jsonAdded property
_links(object)Navigation links for related resources
GET /api/watchlist-manager/watchlists
Return Type:
Changed response : 200 OK
Watchlists retrieved successfully
Changed content type :
application/jsonAdded property
_links(object)Navigation links for related resources
POST /api/watchlist-manager/watchlists
Return Type:
Changed response : 201 Created
Watchlist created successfully
Changed content type :
application/json
POST /api/identity-store/events/queries/start
Request:
Changed content type : application/json
Added property
info(object)Optional criteria to query the contents of the event
infomap. Each map key is the name of the info field to match on, and the value specifies the match type and value. The info field name (map key) is matched case insensitively. The match value is compared as stored: anEXACTmatch requires the whole value to match, aLIKEmatch is added to the query asLIKE %{matchValue}%.
Return Type:
Changed response : 400 Bad Request
An error occurred. Possible error codes:
822: Error trying to start the Athena query
826: Invalid info query criteria - both matchType and matchValue must be supplied
POST /api/process-manager/processInstances
Return Type:
New response : 500 Internal Server Error
Internal Server Error
GET /api/process-manager/processInstances
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/process-manager/processInstances/csv
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/process-manager/cloudSecrets
Return Type:
New response : 500 Internal Server Error
Internal Server Error
GET /api/process-manager/cloudSecrets
Return Type:
New response : 500 Internal Server Error
Internal Server Error
GET /api/process-manager/processInstances/search
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/userdataarchive
Return Type:
Changed response : 200 OK
OK
Changed content type :
*/*
GET /api/watchlist-manager/trends/{id}
Return Type:
Changed response : 200 OK
Trend record retrieved successfully
Changed content type :
application/jsonAdded property
_links(object)Navigation links for related resources
GET /api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}
Return Type:
Changed response : 200 OK
Watchlist entry retrieved successfully
Changed content type :
application/jsonAdded property
_links(object)Navigation links for related resources
GET /api/watchlist-manager/watchlists/{watchlistId}/entries
Return Type:
Changed response : 200 OK
Watchlist entries retrieved successfully
Changed content type :
application/jsonAdded property
_links(object)Navigation links for related resources
POST /api/watchlist-manager/watchlists/{watchlistId}/entries
Return Type:
Changed response : 201 Created
Watchlist entry created successfully
Changed content type :
application/json
DELETE /api/process-manager/processInstances/{processInstanceId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
GET /api/process-manager/processInstances/{processInstanceId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
Changed content type :
application/jsonAdded property
fraudState(object)Fraud review outcome recorded for this process instance. This field is returned only after a fraud state has been reported. Values: FRAUD_CONFIRMED, FRAUD_SUSPECTED, or NO_FRAUD_INDICATED. To change this value, use the fraud-state endpoint for the process instance.
Enum values:
FRAUD_CONFIRMEDFRAUD_SUSPECTEDNO_FRAUD_INDICATED
Added property
fraudStateLastUpdated(object)Date and time, in UTC, when the fraud state was last reported or changed. This field is returned only after a fraud state has been reported.
Added property
fraudStateLastUpdatedBy(object)Identifier of the authenticated caller that last reported or changed the fraud state. This field is returned only after a fraud state has been reported.
Added property
fraudStateNote(object)Optional note supplied with the latest fraud-state report. This field is returned only when a note was provided. To change this value, use the fraud-state endpoint for the process instance.
Added property
archives(object)Archives associated with this process instance (one entry per archive tracking record, across all policies and statuses). Empty when the process instance has no archives.
GET /api/process-manager/processInstances/{processInstanceId}/withParameters
Return Type:
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
Changed content type :
application/jsonAdded property
archives(object)
POST /api/process-manager/processInstances/create
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/watchlist-manager/trends
Return Type:
Changed response : 201 Created
Trend record added successfully
Changed content type :
application/jsonAdded property
_links(object)Navigation links for related resources
DELETE /api/process-manager/processTokens/{processTokenId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
GET /api/process-manager/processTokens/{processTokenId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
PUT /api/process-manager/processTokens/{processTokenId}
Return Type:
New response : 500 Internal Server Error
Internal Server Error
GET /api/process-manager/processTokens
Return Type:
New response : 500 Internal Server Error
Internal Server Error
POST /api/process-manager/processTokens
Return Type:
New response : 500 Internal Server Error
Internal Server Error