The cancelRedactEvents() GraphQL mutation is used to cancel a previously submitted redaction. Returns true if the redaction was cancelled; returns false otherwise. Cancellation is best effort. If some events have already been redacted, they are not restored.

For more information on creating views to redact data, see the Creating a Repository or View documentation page. You may also want to look at General Settings for related information.


Below is the syntax for the cancelRedactEvents() mutation field:

      input: CancelRedactEventsInput!
   ): boolean!

Given Datatypes

For the input (i.e., CancelRedactEventsInput), there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: CancelRedactEventsInput

repositoryNamestringyes The name of the repository associated with the events.
redactionTaskIdstringyes The unique identifier of the readaction task.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.