DocSpring · Schema

submission_preview

PDFDocument GenerationPDF TemplatesE-SignaturesFormsHTML to PDFDocument Automation

Properties

Name	Type	Description
id	string
state	string
metadata	object
processed_at	string
total_count	integer
pending_count	integer
error_count	integer
completion_percentage	number
submissions	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/docspring/main/json-schema/submission_batch_with_submissions.json",
  "title": "submission_preview",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "state": {
      "type": "string",
      "enum": [
        "pending",
        "processed",
        "error"
      ]
    },
    "metadata": {
      "type": "object"
    },
    "processed_at": {
      "type": "string",
      "nullable": true
    },
    "total_count": {
      "type": "integer"
    },
    "pending_count": {
      "type": "integer"
    },
    "error_count": {
      "type": "integer"
    },
    "completion_percentage": {
      "type": "number"
    },
    "submissions": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/submission_preview"
      }
    }
  },
  "required": [
    "completion_percentage",
    "error_count",
    "id",
    "metadata",
    "pending_count",
    "processed_at",
    "state",
    "total_count"
  ],
  "additionalProperties": false
}