Skip to content
Avara
Get started
API Reference
Auto Scribe
Reports

Cancel a report addendum

ReportCancelAddendumResponse autoScribe().reports().cancelAddendum(ReportCancelAddendumParamsparams = ReportCancelAddendumParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
post/v1/autoScribe/reports/{reportId}/cancel-addendum

Cancels an in-progress addendum and reverts the study status to 'completed'. The original report remains unchanged. Only valid for active addendums.

ParametersExpand Collapse
ReportCancelAddendumParams params
Optional<String> reportId

Unique report identifier. Format: rep_{32-hex-chars}

ReturnsExpand Collapse
class ReportCancelAddendumResponse:

Response for cancelling a report addendum

boolean success
Optional<String> message
Cancel a report addendum
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.reports.ReportCancelAddendumParams;
import com.avara.models.autoscribe.reports.ReportCancelAddendumResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        ReportCancelAddendumResponse response = client.autoScribe().reports().cancelAddendum("rep_1234567890abcdef1234567890abcdef");
    }
}
{
  "success": true,
  "message": "message"
}
Returns Examples
{
  "success": true,
  "message": "message"
}