EditBatchTemplate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-edit-batch-template-schema.json",
  "title": "EditBatchTemplate",
  "description": "EditBatchTemplate",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-altru-administration-api-openapi.yml#/components/schemas/EditBatchTemplate",
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 60,
      "minLength": 0,
      "type": "string",
      "description": "The batch template name."
    },
    "description": {
      "maxLength": 1000,
      "minLength": 0,
      "type": "string",
      "description": "The description."
    },
    "batch_work_flow": {
      "type": "string",
      "description": "The workflow name. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/99ccdb4b-8698-4eff-bb96-5a240e702c09."
    },
    "numbering_scheme": {
      "type": "string",
      "description": "The numbering scheme. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/8ee0de7e-75e0-499f-9702-13d87234ebee."
    },
    "auto_save_on_row_change": {
      "type": "boolean",
      "description": "Indicates whether enable auto-save."
    },
    "create_exception_batch": {
      "type": "boolean",
      "description": "Indicates whether create exception batch."
    },
    "purge_batch": {
      "type": "boolean",
      "description": "Indicates whether delete batch after committing."
    },
    "check_for_duplicate_records": {
      "type": "boolean",
      "description": "Indicates whether check for duplicate constituents."
    },
    "batch_supports_checking_for_duplicate_records": {
      "type": "boolean",
      "description": "Indicates whether batch supports checking for duplicate records. Read-only in the SOAP API."
    },
    "validate_batch": {
      "type": "boolean",
      "description": "Indicates whether validate batch before committing."
    },
    "create_control_report": {
      "type": "boolean",
      "description": "Indicates whether create control report."
    },
    "batch_type_catalog": {
      "type": "string",
      "description": "The select a batch type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/fff24238-bb8a-4046-9204-ea4b11581b76?parameters=batchtypecatalogid,{batchtypecatalogid}."
    },
    "import_only": {
      "type": "boolean",
      "description": "Indicates whether this template is only used for importing data."
    },
    "template_use": {
      "type": "string",
      "description": "The template use. Available values are <i>batch entry and import</i>, <i>batch entry only</i>, <i>import only</i>, <i>system-defined</i>"
    },
    "batch_fields": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EditBatchTemplateBatchFields"
      },
      "description": "Batch fields."
    },
    "template_permissions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EditBatchTemplateTemplatePermissions"
      },
      "description": "Template permissions."
    },
    "customize_permissions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EditBatchTemplateCustomizePermissions"
      },
      "description": "Customize permissions."
    },
    "site_id": {
      "type": "string",
      "description": "The site."
    },
    "add_row_data_form_instance_id": {
      "type": "string",
      "description": "The add row data form instance ID. Read-only in the SOAP API."
    },
    "edit_row_data_form_instance_id": {
      "type": "string",
      "description": "The edit row data form instance ID. Read-only in the SOAP API."
    },
    "commit_row_add_data_form_instance_id": {
      "type": "string",
      "description": "The commit row add data form instance ID. Read-only in the SOAP API."
    },
    "commit_row_edit_data_form_instance_id": {
      "type": "string",
      "description": "The commit row edit data form instance ID. Read-only in the SOAP API."
    },
    "default_template": {
      "type": "boolean",
      "description": "Indicates whether default template. Read-only in the SOAP API."
    },
    "auto_match_threshold": {
      "type": "integer",
      "description": "The matched records threshold.",
      "format": "int32"
    },
    "overall_match_threshold": {
      "type": "integer",
      "description": "The possible matches threshold.",
      "format": "int32"
    },
    "parameters_xml": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EditBatchTemplateParametersXml"
      },
      "description": "Parameters xml."
    },
    "use_global_match_settings": {
      "type": "boolean",
      "description": "Indicates whether use global settings."
    }
  },
  "additionalProperties": false,
  "x-display-name": "Batch Template Edit Form",
  "x-display-id": "Batch Template Edit Form",
  "$defs": {
    "EditBatchTemplateBatchFields": {
      "type": "object",
      "description": "EditBatchTemplateBatchFields",
      "x-display-name": "batch_fields",
      "x-display-id": "batch_fields"
    },
    "EditBatchTemplateCustomizePermissions": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID."
        },
        "system_role_id": {
          "type": "string",
          "description": "The system role ID."
        },
        "name": {
          "type": "string",
          "description": "The system role."
        },
        "grant_or_deny": {
          "type": "string",
          "description": "The priveledge. Available values are <i></i>, <i>granted</i>, <i>denied</i>"
        }
      },
      "description": "EditBatchTemplateCustomizePermissions",
      "x-display-name": "customize_permissions",
      "x-display-id": "customize_permissions"
    },
    "EditBatchTemplateParametersXml": {
      "type": "object",
      "description": "EditBatchTemplateParametersXml",
      "x-display-name": "parameters_xml",
      "x-display-id": "parameters_xml"
    },
    "EditBatchTemplateTemplatePermissions": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID."
        },
        "system_role_id": {
          "type": "string",
          "description": "The system role ID."
        },
        "name": {
          "type": "string",
          "description": "The system role."
        },
        "grant_or_deny": {
          "type": "string",
          "description": "The priveledge. Available values are <i></i>, <i>granted</i>, <i>denied</i>"
        }
      },
      "description": "EditBatchTemplateTemplatePermissions",
      "x-display-name": "template_permissions",
      "x-display-id": "template_permissions"
    }
  }
}