Data Rules

Revert a rule's corrections

Removes every correction the rule wrote, across all of its versions, and puts each value back to the one it replaced. The corrections are removed rather than reverted, so each value reads as original again, as it does after reverting a rule run. The call returns at once with the number of corrections the rule still holds, and the work runs in the background. When that number is 0, nothing runs.

A correction inside a reported batch, or one somebody has corrected since, is left in place.

To track the revert, list the rule’s runs with List a rule’s runs. The revert appears there as a run with trigger set to on_demand and state set to reversing, which moves to reversed once it finishes. Its reversal_summary counts the corrections removed as corrections_deleted and the ones left in place as refused. Nothing else on the run marks it as a revert, so it reads the same as an Evaluate a period run that was later reverted.

POST

projects

{project_id}

rules

{rule_id}

revert_corrections

Revert a rule's corrections

curl --request POST \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections"

headers = {"Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "corrections_outstanding": 42
}

{
  "errors": [
    {
      "message": "An evaluation is in progress for this rule. Revert is available once it finishes."
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

rule_id

string

required

Response

202

corrections_outstanding

integer

Corrections the rule still held when the request was accepted. This includes corrections inside a reported batch, which the revert then leaves in place, so it is an upper bound on how many will be removed.

Revert a rule's corrections

curl --request POST \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections"

headers = {"Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/revert_corrections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "corrections_outstanding": 42
}

{
  "errors": [
    {
      "message": "An evaluation is in progress for this rule. Revert is available once it finishes."
    }
  ]
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Revert a rule's corrections

Authorizations

Path Parameters

Response