August 1, 2024 - Public API Release Notes v2

Things to Know

• Information on this page is subject to change. This page was last updated August 5, 2024.
• Features below are not functional in the application until UAT release date.
• You may need to clear your cache in order to enable changes in this release.

Release Summary

Here's a quick overview of the updates in this release:

• Pull URL of a proposal or award via the API
• Create a Proposal and award form via the API, with form data
• Update the status and resolution of a proposal or award via the API
• Pull all form data tied to a specific award modification

Release Dates and Downtime

Release dates are subject to change. Release date changes will be noted in the Change Log below.

Downtime required: None

Change Log

7/24/24: Deployment dates updated to TBD; release will align with upcoming SP deployment

7/26/24: New UAT and Prod dates added

Detailed Release Notes

New: Public API

• The following can now be done in the SP Public API:
  • Update SP award and add resolution
  • Update SP proposal status and resolution
  • Create SP Proposal Record with Research Team Object Data
  • Create SP Award Record with Research Team Object
• Users now have the ability to pull the URL for SP records. URL is a new attribute on the following GET calls:
  • GET /v1/proposals
  • GET/v1/awards
  • GET/v1/sub-awards
  • GET /v1/proposals/{id}
  • GET /v1/awards/{id}
  • GET /v1/awards/{awardId}/sub-awards/{id}
• Users now have the ability to pull all form object values for a specific version (modification) of an award form:
  • GET /v1/awards/{awardId}/modifications/{modificationNumber}

(Ref ID: 24.02.29)