Create a draft policy version

curl --request POST \
  --url https://app.herondata.io/api/policy_version \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "change_description": "<string>"
}
'

import requests

url = "https://app.herondata.io/api/policy_version"

payload = { "change_description": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({change_description: '<string>'})
};

fetch('https://app.herondata.io/api/policy_version', 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.herondata.io/api/policy_version",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'change_description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.herondata.io/api/policy_version"

	payload := strings.NewReader("{\n  \"change_description\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.herondata.io/api/policy_version")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"change_description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/policy_version")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"change_description\": \"<string>\"\n}"

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

{
  "policy_version": {
    "author_email": "<string>",
    "backtest_status": {
      "backtest_heron_id": "<string>",
      "deal_count": 123,
      "finished_at": "2023-11-07T05:31:56Z",
      "flipped_deal_count": 123,
      "run_status": "pending",
      "stale": true
    },
    "change_description": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "last_edited_at": "2023-11-07T05:31:56Z",
    "policy_definition": {
      "policy_sections": [
        {
          "name": "<string>",
          "branches": [
            {
              "condition": {
                "attribute_description": "<string>",
                "attribute_display_name": "<string>",
                "attribute_label": "<string>",
                "attribute_unit": "currency",
                "attribute_validators": [
                  {}
                ],
                "attribute_value_set": "us_state",
                "boolean_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "value": true
                },
                "composite_check": {
                  "auto_decline": false,
                  "checks": "<array>",
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "max_failing": 123,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "AND"
                },
                "date_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "equal",
                  "value": "2023-12-25"
                },
                "date_delta_to_now_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "pass_if_value_missing": false,
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "greater_than",
                  "value": {}
                },
                "enhanced_sql_check": {
                  "check_type": "equal",
                  "column_name": "<string>",
                  "comparison_value": "<unknown>",
                  "data_type": "numeric",
                  "query_name": "<string>",
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  }
                },
                "group": "<string>",
                "heron_id": "<string>",
                "identity": "<string>",
                "name": "<string>",
                "numeric_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "equal",
                  "value": "<string>"
                },
                "parameters": {},
                "sql_check": {
                  "column_name": "<string>",
                  "query_name": "<string>",
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  }
                },
                "string_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "match_count": 123,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "equal",
                  "value": "<string>"
                }
              },
              "name": "<string>",
              "checks": [
                {
                  "attribute_description": "<string>",
                  "attribute_display_name": "<string>",
                  "attribute_label": "<string>",
                  "attribute_unit": "currency",
                  "attribute_validators": [
                    {}
                  ],
                  "attribute_value_set": "us_state",
                  "boolean_check": {
                    "auto_decline": false,
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    },
                    "value": true
                  },
                  "composite_check": {
                    "auto_decline": false,
                    "checks": "<array>",
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "max_failing": 123,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    },
                    "type": "AND"
                  },
                  "date_check": {
                    "auto_decline": false,
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    },
                    "type": "equal",
                    "value": "2023-12-25"
                  },
                  "date_delta_to_now_check": {
                    "auto_decline": false,
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "pass_if_value_missing": false,
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    },
                    "type": "greater_than",
                    "value": {}
                  },
                  "enhanced_sql_check": {
                    "check_type": "equal",
                    "column_name": "<string>",
                    "comparison_value": "<unknown>",
                    "data_type": "numeric",
                    "query_name": "<string>",
                    "auto_decline": false,
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    }
                  },
                  "group": "<string>",
                  "heron_id": "<string>",
                  "identity": "<string>",
                  "name": "<string>",
                  "numeric_check": {
                    "auto_decline": false,
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    },
                    "type": "equal",
                    "value": "<string>"
                  },
                  "parameters": {},
                  "sql_check": {
                    "column_name": "<string>",
                    "query_name": "<string>",
                    "auto_decline": false,
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    }
                  },
                  "string_check": {
                    "auto_decline": false,
                    "decline_code": "<string>",
                    "decline_description": "<string>",
                    "email_template_name": "<string>",
                    "ignore_metric_availability": false,
                    "is_mandatory": false,
                    "match_count": 123,
                    "on_failure": "fail",
                    "on_missing": "missing_data",
                    "pass_description": "<string>",
                    "transaction_scope": {
                      "file_classes": [
                        "<string>"
                      ],
                      "min_reconciliation_status": "failed"
                    },
                    "type": "equal",
                    "value": "<string>"
                  }
                }
              ],
              "heron_id": "<string>"
            }
          ],
          "checks": [
            {
              "attribute_description": "<string>",
              "attribute_display_name": "<string>",
              "attribute_label": "<string>",
              "attribute_unit": "currency",
              "attribute_validators": [
                {}
              ],
              "attribute_value_set": "us_state",
              "boolean_check": {
                "auto_decline": false,
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                },
                "value": true
              },
              "composite_check": {
                "auto_decline": false,
                "checks": "<array>",
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "max_failing": 123,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                },
                "type": "AND"
              },
              "date_check": {
                "auto_decline": false,
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                },
                "type": "equal",
                "value": "2023-12-25"
              },
              "date_delta_to_now_check": {
                "auto_decline": false,
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "pass_if_value_missing": false,
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                },
                "type": "greater_than",
                "value": {}
              },
              "enhanced_sql_check": {
                "check_type": "equal",
                "column_name": "<string>",
                "comparison_value": "<unknown>",
                "data_type": "numeric",
                "query_name": "<string>",
                "auto_decline": false,
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                }
              },
              "group": "<string>",
              "heron_id": "<string>",
              "identity": "<string>",
              "name": "<string>",
              "numeric_check": {
                "auto_decline": false,
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                },
                "type": "equal",
                "value": "<string>"
              },
              "parameters": {},
              "sql_check": {
                "column_name": "<string>",
                "query_name": "<string>",
                "auto_decline": false,
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                }
              },
              "string_check": {
                "auto_decline": false,
                "decline_code": "<string>",
                "decline_description": "<string>",
                "email_template_name": "<string>",
                "ignore_metric_availability": false,
                "is_mandatory": false,
                "match_count": 123,
                "on_failure": "fail",
                "on_missing": "missing_data",
                "pass_description": "<string>",
                "transaction_scope": {
                  "file_classes": [
                    "<string>"
                  ],
                  "min_reconciliation_status": "failed"
                },
                "type": "equal",
                "value": "<string>"
              }
            }
          ],
          "default_branch": {
            "checks": [
              {
                "attribute_description": "<string>",
                "attribute_display_name": "<string>",
                "attribute_label": "<string>",
                "attribute_unit": "currency",
                "attribute_validators": [
                  {}
                ],
                "attribute_value_set": "us_state",
                "boolean_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "value": true
                },
                "composite_check": {
                  "auto_decline": false,
                  "checks": "<array>",
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "max_failing": 123,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "AND"
                },
                "date_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "equal",
                  "value": "2023-12-25"
                },
                "date_delta_to_now_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "pass_if_value_missing": false,
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "greater_than",
                  "value": {}
                },
                "enhanced_sql_check": {
                  "check_type": "equal",
                  "column_name": "<string>",
                  "comparison_value": "<unknown>",
                  "data_type": "numeric",
                  "query_name": "<string>",
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  }
                },
                "group": "<string>",
                "heron_id": "<string>",
                "identity": "<string>",
                "name": "<string>",
                "numeric_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "equal",
                  "value": "<string>"
                },
                "parameters": {},
                "sql_check": {
                  "column_name": "<string>",
                  "query_name": "<string>",
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  }
                },
                "string_check": {
                  "auto_decline": false,
                  "decline_code": "<string>",
                  "decline_description": "<string>",
                  "email_template_name": "<string>",
                  "ignore_metric_availability": false,
                  "is_mandatory": false,
                  "match_count": 123,
                  "on_failure": "fail",
                  "on_missing": "missing_data",
                  "pass_description": "<string>",
                  "transaction_scope": {
                    "file_classes": [
                      "<string>"
                    ],
                    "min_reconciliation_status": "failed"
                  },
                  "type": "equal",
                  "value": "<string>"
                }
              }
            ],
            "decline_code": "<string>",
            "decline_description": "<string>",
            "heron_id": "<string>",
            "name": "Default",
            "result": "passed"
          },
          "display_order": 123,
          "heron_id": "<string>",
          "use_case": "background_check"
        }
      ]
    },
    "published_at": "2023-11-07T05:31:56Z",
    "status": "draft",
    "version": 123
  }
}