Template

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cm-com/main/json-schema/cm-com-template-schema.json",
  "title": "Template",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cm-com-sign-v1-openapi.yml#/components/schemas/Template",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the template."
    },
    "name": {
      "type": "string",
      "description": "Name of the template."
    },
    "files": {
      "type": "array",
      "description": "Files linked to the template.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/$defs/FileReference"
          },
          "name": {
            "type": "string",
            "description": "Original name of the file without extension."
          }
        }
      }
    },
    "attachments": {
      "type": "array",
      "description": "Attachments linked to the template.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/$defs/FileReference"
          },
          "name": {
            "type": "string",
            "description": "Original name of the attachment without extension."
          }
        }
      }
    },
    "fields": {
      "type": "array",
      "description": "Fields that will be linked to the file and invitee when applying to a dossier.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/$defs/FieldType"
          },
          "required": {
            "type": "boolean",
            "description": "Boolean for if the field is required to be filled by the invitee."
          },
          "value": {
            "type": "string",
            "description": "The value of the field, if the type is 'label'."
          },
          "file": {
            "type": "integer",
            "description": "The index of the file when creating the dossier to link this field to, starting from 0."
          },
          "invitee": {
            "type": "integer",
            "description": "The index of the invitee when creating the dossier to link this field to, starting from 0."
          },
          "locations": {
            "type": "array",
            "items": {
              "$ref": "#/$defs/FieldLocation"
            }
          }
        }
      }
    },
    "lastUsedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date the template was last applied on a dossier, in ISO 8601 format."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date the template was last updated, in ISO 8601 format."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date the template was created, in ISO 8601 format."
    }
  },
  "$defs": {
    "FieldLocation": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string",
          "pattern": "^\\d+(-\\d+)?$",
          "maxLength": 64,
          "description": "The page number within the PDF that this field occupies (e.g. `1`), or range for a initials field (e.g. `1-3`)."
        },
        "x": {
          "type": "number",
          "format": "float",
          "description": "X position of the field in points."
        },
        "y": {
          "type": "number",
          "format": "float",
          "description": "Y position of the field in points."
        },
        "width": {
          "type": "number",
          "format": "float",
          "description": "Width of the field in points."
        },
        "height": {
          "type": "number",
          "format": "float",
          "description": "Height of the field in points."
        }
      }
    },
    "FieldType": {
      "type": "string",
      "description": "The type of field for the invitee.",
      "enum": [
        "signature",
        "signatureDate",
        "initials",
        "text",
        "textarea",
        "label",
        "checkbox",
        "radio",
        "stamp"
      ]
    },
    "FileReference": {
      "type": "string",
      "format": "uuid",
      "description": "A unique reference number for this file."
    }
  }
}