Report APIs
You can manage reports with the following APIs.
Update Report Contents
Use this API to update the document contents of an existing report record on a requisition. This API will not mark the report as Corrected. To create a corrected report, sign the original report, which generates a new report record with a new reportId, and then update its document contents with this API.
HTTP Request
PUT /api/v3/reports/{reportId}
Query Parameters
| Key | Required | Description |
|---|---|---|
reportId |
yes | Supply the report's internal identifier. Subscribe to a report_ready_for_generation webhook to get this information. Ovation must first create the report entity in order for you to then update its document contents using this API. |
Request Body
"report": {
"requisitionIdentifier": "string",
"reportContent": "string"
}
| Field name | Description |
requisitionIdentifier |
The Requisition Identifier of the requisition the report is to be associated with |
reportContent |
Serialized base64-encoded content of the report |
Report Response
| Response code | Response body |
|---|---|
| 201 Indicating the report was successfully added | |
| 401 Indicating an authentication error | |
| 422 Indicating an error with the request | Will return the validation errors found. "Report ID required", "Requisition not found", "Report not found", "Invalid Requisition for Report" |