Skip to Content

Documentation

v2023.5.1 Release Notes

Updated on:

These are Release Notes for v2023.5.1 of Risk Cloud API v2, released on May 18th, 2023.

Risk Cloud API v2 is a collection of new API-first and RESTful API endpoints to streamline the creation of custom integrations with the Risk Cloud.

These endpoints are currently in open alpha, meaning that backwards compatibility is not guaranteed and breaking changes are to be expected as the endpoints are finalized. The full release of these new v2 endpoints is anticipated for late 2023.

Risk Cloud API v2 Resources

Application

GET/api/v2/applications/{id}
  • Changed response : 200 OK
  • Changed content type : application/json
    • Added property restrictBuildAccess (boolean)
    • Deleted property restrict-build-access (boolean)
PATCH/api/v2/applications/{id}
  • Changed response : 200 OK
  • Changed content type : application/json
    • Added property restrictBuildAccess (boolean)
    • Deleted property restrict-build-access (boolean)
  • Changed content type : application/json
  • Added property restrictBuildAccess (boolean)
  • Deleted property restrict-build-access (boolean)
POST/api/v2/applications
  • Changed response : 200 OK
  • Changed content type : application/json
    • Added property restrictBuildAccess (boolean)
    • Deleted property restrict-build-access (boolean)
GET/api/v2/applications
  • Changed response : 200 OK
  • Changed content type : application/json
    • Changed property content (array)
    • Changed items (object):
      • Added property restrictBuildAccess (boolean)
      • Deleted property restrict-build-access (boolean)
    • Changed property page (object)
      • Added property totalElements (integer)
      • Added property totalPages (integer)
      • Deleted property total-elements (integer)
      • Deleted property total-pages (integer)

Workflow

GET/api/v2/workflows/{id}
  • Changed response : 200 OK
  • Changed content type : application/json
    • Added property recordPrefix (string)
    • Added property applicationId (string)
    • Deleted property record-prefix (string)
    • Deleted property application-id (string)
PATCH/api/v2/workflows/{id}
  • Changed response : 200 OK
  • Changed content type : application/json
    • Added property recordPrefix (string)
    • Added property applicationId (string)
    • Deleted property record-prefix (string)
    • Deleted property application-id (string)
  • Changed content type : application/json
  • Added property recordPrefix (string)
  • Deleted property record-prefix (string)
POST/api/v2/workflows
  • Changed content type : application/json
  • New required properties:
    • applicationId
    • recordPrefix
  • New optional properties:
    • application-id
    • record-prefix
  • Added property recordPrefix (string)
  • Added property applicationId (string)
  • Deleted property record-prefix (string)
  • Deleted property application-id (string)
  • Changed response : 200 OK
  • Changed content type : application/json
    • Added property recordPrefix (string)
    • Added property applicationId (string)
    • Deleted property record-prefix (string)
    • Deleted property application-id (string)
GET/api/v2/workflows
  • Changed response : 200 OK
  • Changed content type : application/json
    • Changed property content (array)
    • Changed items (object):
      • Added property recordPrefix (string)
      • Added property applicationId (string)
      • Deleted property record-prefix (string)
      • Deleted property application-id (string)
    • Changed property page (object)
      • Added property totalElements (integer)
      • Added property totalPages (integer)
      • Deleted property total-elements (integer)
      • Deleted property total-pages (integer)

Workflow Map

GET/api/v2/workflow-maps
  • Changed response : 200 OK
  • Changed content type : application/json
    • Changed property page (object)
      • Added property totalElements (integer)
      • Added property totalPages (integer)
      • Deleted property total-elements (integer)
      • Deleted property total-pages (integer)