Changes 1.0.16.5

What's New

The following APIs can be considered 'new' APIs. However, the API changes listed below are APIs which have existed prior to the release, but have not been documented until now.

GET /api/arthr/apiKeys

POST /api/arthr/apiKeys

POST /api/process-server/processes/{processDefinitionName}/businessKeys/{businessKey}/topicName/{topicName}/continue

POST /api/process-server/startProcess

GET /api/process-manager/processTokens/{processTokenId}

DELETE /api/process-manager/processTokens/{processTokenId}

GET /api/metrics-server/auditMessages/queries/{executionId}/status

POST /api/metrics-server/auditMessages/queries/start

GET /api/metrics-server/auditMessages/queries/{executionId}/result

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

GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members

POST /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members

GET /api/watchlist-manager/facewatchlists/{watchlistId}

POST /api/watchlist-manager/facewatchlists/{watchlistId}

DELETE /api/watchlist-manager/facewatchlists/{watchlistId}

GET /api/watchlist-manager/facewatchlists

POST /api/watchlist-manager/facewatchlists

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

DELETE /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}

GET /api/arthr/apiKeys/{apiKeyId}

POST /api/arthr/apiKeys/{apiKeyId}

GET /api/process-manager/processTokens

GET /api/process-manager/processInstances

What's Changed

The following section provides a break down of the changes for each operation which has been since the previous release.

PUT /api/process-manager/processTokens/{processTokenId}

The API PUT /api/process-manager/processTokens/{processTokenId} is now deprecated. The API to update process tokens should be used instead.

GET /api/process-manager/processInstances/search

Parameters:

Added: processDefinitionId in query

Added: processDefinitionName in query

Added: processInstanceStatus in query

Added: versionName in query

Added: page in query

Added: size in query

Added: direction in query

Added: sortColumn in query

Added: sort in query

Added: forTest in query

The parameter 'forTest' should be considered deprecated. This is an optional parameter that will be removed in a future release.

Deleted: processInstanceId in path

This is a correction of the previous revision of the API documentation. The parameter processInstanceId was incorrectly added the previous revision of the API documentation, rending the API invalid. The parameter has been removed accordingly.

Changed: startDateTime in query

The parameter startDateTime has not changed, however, extra information about the formatting of the parameter has been added to the API documentation to denote that the string is in 'date-time' format.

Changed: endDateTime in query

The parameter endDateTime has not changed, however, extra information about the formatting of the parameter has been added to the API documentation to denote that the string is in 'date-time' format.

Return Type:

New response : 400 Bad Request

New response : 404 Not Found

New response : 401 Unauthorized

Changed response : 200 OK

• New content type : */*
• Deleted content type : application/json

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

DELETE /api/arthr/apiKeys/{apiKeyId}

Parameters:

Added: apiKeyId in path

This is a correction of the previous revision of the API documentation. The parameter apiKeyId was omitted from the previous revision of the API documentation, rending the API invalid. The parameter has been removed accordingly.

Return Type:

New response : 204 No Content

Deleted response : 200 OK

This is a correction of the previous revision of the API documentation. Given that the API does not return a response response code was always HTTP 204 No Content. The response type 200 OK has been removed accordingly.

Changed response : 400 Bad Request

• New content type : */*
• Deleted content type : application/json

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

Changed response : 401 Unauthorized

• New content type : */*
• Deleted content type : application/json

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

POST /api/process-manager/processTokens

Request:

• Added property description (string)

Return Type:

New response : 404 Not Found

Changed response : 400 Bad Request

• Changed content type : */*

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

Changed response : 201 Created

• Added property description (string)

POST /api/process-manager/processInstances

Return Type:

New response : 404 Not Found

Changed response : 400 Bad Request

• Changed content type : */*

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

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

Return Type:

Changed response : 200 OK

• Added property results (object)
• Deleted property review (object)

This is a correction of the previous revision of the API documentation. The property review was incorrectly added the previous revision of the API documentation. The property was never part of the response and has been removed accordingly.

Changed response : 400 Bad Request

• Changed content type : */*

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

Deleted 'AuthorizationSkyError' Added 'ProcessManagerSkyError' :

• Property code (integer)
• Property message (string)
• Property extraDetail (string)

Both AuthorizationSkyError & ProcessManagerSkyError represent equivalent JSON structures - both including code, message and extraDetail. This should not be considered a breaking change in the API, however is simply a change in the error code types.

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

Parameters:

Added: force in query

Return Type:

Changed response : 400 Bad Request

• Changed content type : */*

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

Deleted 'AuthorizationSkyError' Added 'ProcessManagerSkyError' :

Both AuthorizationSkyError & ProcessManagerSkyError represent equivalent JSON structures - both including code, message and extraDetail. This should not be considered a breaking change in the API, however is simply a change in the error code types.

GET /api/process-manager/processInstances/{processInstanceId}/withParameters

Return Type:

Changed response : 200 OK

• Changed content type : application/json

• Added property completedDtm (string)

• Added property extId (string)

• Added property nationality (string)

• Added property results (object)

• Added property themeUrl (string)

• Changed property status (string)

  • Added enum values:
    • PENDING
    • ACTIVE
    • COMPLETED_TERMINATED
    • COMPLETED_ENDED_ERROR
    • COMPLETED_ENDED_SUCCESS
    • REVIEW
    • PAUSED
    • COMPLETED_PROCESS_ERROR

• Changed property processDefinitionType (string)

  • Added enum values:
    • AUTHENTICATION
    • VERIFICATION
    • OTHER

Changed response : 400 Bad Request

• Changed content type : */*

The change in content type from application/json to */* is due to to move to generate API documentation. This change in content type can be ignored and should not be considered a breaking change.

Deleted 'AuthorizationSkyError' Added 'ProcessManagerSkyError' :

Both AuthorizationSkyError & ProcessManagerSkyError represent equivalent JSON structures - both including code, message and extraDetail. This should not be considered a breaking change in the API, however is simply a change in the error code types.

POST /api/arthr/apiKeys/issue

Parameters:

Added: X-ApiKey in header

Added: X-Api-Key in header