Release Notes

v2021.3.0

Images

Release the cat memes! Images are further supported in the Rich Text portions of the Risk Cloud platform. API users can now retrieve and upload images via the following new endpoints.

  • - POST /api/v1/images/upload
  • - GET /api/v1/images/{imageId}

Record Audits

Have you ever been curious how active a particular Risk Cloud Workflow is? The GET /api/v1/audit/records endpoint now accepts a Workflow ID, allowing users to filter retrieved Record Audits by Workflow.

An example usage is below (timestamps are expected in milliseconds):

/api/v1/audit/records?minCreated={minCreatedTimestamp}&workflow={workflowId}

All Updates

New

  • - POST /api/v1/images/upload

  • - GET /api/v1/images/{imageId}

Changed

  • - GET /api/v1/applications

    • - Add generic in query

  • - GET /api/v1/audit/records

    • - Add workflow in query

  • - GET /api/v1/conditions

    • - Add trigger in query

    • - Delete step in query

  • - GET /api/v1/processes

    • - Delete entitled in query

  • - GET /api/v1/records

    • - Add hasChild in query

    • - Add minUpdated in query

    • - Delete field in query

    • - Delete numericValue in query

    • - Delete textValue in query

  • - PUT /api/v1/records/due-date

    • - Add validated in query

  • - GET /api/v1/records/search

    • - Add page in query

    • - Add size in query

    • - Delete cache in query

    • - Delete workflow in query

  • - GET /api/v1/records/search/count

    • - Delete hidden in query

    • - Delete tableReport in query

  • - GET /api/v1/records/search/summarize

    • - Add steps in query

    • - Add workflow in query

    • - Delete workflows in query

  • - GET /api/v1/valueMaps

    • - Delete field in query

  • - GET /api/v1/workflows/relatives

    • - Add distinct in query

    • - Delete direct in query

    • - Delete includeJiraWorkflows in query

v2021.2.0

Featured

Favorites

Favorites are here! Users are now able to show some love to their favorite Records, Dashboards, and Reports.

The following new endpoints empower API users to manage and search their Favorites, including by type (e.g. Record, Dashboard, TableReport, VisualReport).

  • - POST /api/v1/favorites
  • - DELETE /api/v1/favorites/{id}
  • - GET /api/v1/favorites/{type}
  • - GET /api/v1/favorites/{type}/{id}

Record Due Date

The sun gently sets as the PUT /api/v1/records/due-date endpoint is deprecated as of v2021.2.0. API users can now migrate to PATCH /api/v1/records/{recordId}/due-date as the replacement to this endpoint.

All Updates

New

  • - GET /api/v1/attachments/{attachmentId}/url
  • - POST /api/v1/favorites
  • - DELETE /api/v1/favorites/{id}
  • - GET /api/v1/favorites/{type}
  • - GET /api/v1/favorites/{type}/{id}
  • - POST /api/v1/slack/state
  • - GET /api/v1/themes/images/header
  • - GET /api/v1/themes/images/login
  • - GET /api/v1/users/{userId}/images

Deleted

  • - PATCH /api/v1/account/password
  • - POST /api/v1/jobs/scheduled

Deprecated

  • - PUT /api/v1/records/due-date

Changed

  • - GET /api/v1/applications
    • - Delete generic in query
  • - GET /api/v1/comments
    • - Add page in query
    • - Add record in query
    • - Delete minUpdated in query
  • - GET /api/v1/records
    • - Add field in query
    • - Add numericValue in query
    • - Add textValue in query
    • - Delete hasChild in query
    • - Delete minUpdated in query
  • - PUT /api/v1/records/due-date
    • - Delete validated in query
  • - GET /api/v1/records/search/count
    • - Add hidden in query
    • - Add tableReport in query
  • - GET /api/v1/records/search/summarize
    • - Add workflows in query
    • - Delete steps in query
    • - Delete workflow in query
  • - GET /api/v1/slack/auth-redirect
    • - Add state in query
  • - GET /api/v1/step-permission-sets
    • - Add user in query
  • - GET /api/v1/workflows/relatives
    • - Add direct in query
    • - Add includeJiraWorkflows in query
    • - Delete distinct in query

API Documentation

Check out our API Documentation for more usage information on all of the Risk Cloud's API endpoints.

v2021.1.0

Featured

Record Search

Searching for Records of a particular Workflow? Summaries of record data can now be aggregated by Workflows and even Steps via the GET /api/v1/records/search/summarize endpoint.

Job History

No resume or CV necessary! Job history can now be obtained by the new GET /api/v1/jobs/history endpoint, which allows API users to obtain historical information of a given job including statuses, trigger dates, and more.

All Updates

New

  • - GET /api/v1/jobs/history
  • - POST /api/v1/jobs/scheduled

Deleted

  • - PATCH /api/v1/step-permission-sets/update-user

Changed

  • - GET /api/v1/comments
    • - Add minUpdated in query
    • - Delete page in query
    • - Delete record in query
  • - GET /api/v1/jobs
    • - Add applicationId in query
  • - GET /api/v1/processes
    • - Add entitled in query
    • - Delete permitted in query
  • - GET /api/v1/records
    • - Add hasChild in query
    • - Add minUpdated in query
    • - Delete field in query
    • - Delete numericValue in query
    • - Delete textValue in query
  • - GET /api/v1/records/search
    • - Add cache in query
    • - Add workflow in query
    • - Delete page in query
    • - Delete size in query
  • - GET /api/v1/records/search/count
    • - Delete hidden in query
    • - Delete tableReport in query
  • - GET /api/v1/records/search/summarize
    • - Add steps in query
    • - Add workflow in query
    • - Delete workflows in query
  • - DELETE /api/v1/records/{recordId}
    • - Add map in query
  • - GET /api/v1/slack/channels
    • - Add nextCursor in query
    • - Add size in query
  • - GET /api/v1/slack/members
    • - Add nextCursor in query
    • - Add size in query
  • - GET /api/v1/valueMaps
    • - Add field in query
    • - Add record in query
    • - Delete minUpdated in query

API Documentation

Check out our API Documentation for more usage information on all of the Risk Cloud's API endpoints.