HEherondata
Policy Versions

Create a draft policy version with new check values

Changed on

Create a new draft from the active version with the check values you send. The live version can't be edited. Identify each check by its heron_id (from GET /policy_version/{version}). If a draft already exists, it is archived and its edits are not carried over. Checks you don't name keep their active values. All updates are validated first; if any fails, nothing is saved and the call returns 422 with every error listed. This does not publish the draft: call POST /policy_version/publish to make it live.

patch/api/policy_version/draft/check

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/policy_version/draft/check
  • Auth
    API key in header x-api-key

Query parameters

user_idinteger

Account to act on. Honoured only for admins.

Request body

change_descriptionstring nullable

Response

OK. changed is false when every value already matches the active version; then no draft is created and any existing draft is left as it is.

changedboolean

Changes

  • 1ec936e17fefRevision changes
    • warning

      added the new industry_category enum value to the //////////// response property for the response status

    • warning

      added the new industry_category enum value to the /////////////// response property for the response status

    • warning

      added the new industry_category enum value to the ////////// response property for the response status

    • warning

      added the new industry_category enum value to the /////////////// response property for the response status

  • bd8008e49534Revision changes
    • info

      endpoint added