Zum Hauptinhalt springen

RenderError

The error a failed render stored: its code and English message, and the members of its problem that say more. It has no type, title or status. An e-invoice report or a PDF/UA verdict is never in here: the render carries them as einvoice and accessibility.

codestringrequired

The code of the problem the failure answers with. worker_exhausted is a render that failed every attempt of the queue; its message is the last attempt's.

Possible values: [template_syntax_error, template_runtime_error, navigation_failed, render_timeout, page_limit_exceeded, output_too_large, invalid_request, source_not_found, source_invalid, source_encrypted, tool_failed, file_type_unsupported, office_document_invalid, office_document_too_large, office_conversion_failed, office_unavailable, unsupported_in_office, test_output_unavailable, einvoice_data_invalid, einvoice_display_mismatch, pdfa_conversion_failed, conformance_unavailable, pdfua_validation_failed, worker_exhausted]

messagestringrequired

What went wrong, in English.

lineinteger

Template errors of an HTML template: the line, from 1.

columninteger

And the column, from 1.

engineEngine

Template errors: the template language.

Possible values: [jinja2, liquid, handlebars]

partstring

Word and PowerPoint templates: the part of the file.

Example: word/document.xml
paragraphinteger

Word and PowerPoint templates: the paragraph within the part, from 1.

diagnostics object[]

Word and PowerPoint templates: every finding about the tags of the file.

  • Array [
  • severitystring

    error: a render (or, for data, validate_data) would fail; warning and info are advice.

    Possible values: [error, warning, info]

    messagestring

    The finding in English.

    codestring

    A stable name for the kind of finding.

    location object

    Where in the template source, line and column from 1.

    lineinteger
    columninteger
    pathstring

    Data errors only: where in the data, e.g. data.invoice.lines[0].qty.

    partstring

    Word and PowerPoint templates only: the file part the tag is in, e.g. word/document.xml or ppt/slides/slide2.xml.

    paragraphinteger

    Word and PowerPoint templates only: the 1-based paragraph in part, as the template page lists it.

  • ]
  • page_countinteger

    page_limit_exceeded: the pages the document has.

    reasonstring

    What the converter or validator said (office_conversion_failed, source_invalid, pdfa_conversion_failed, tool_failed).

    entrystring

    The part of an office file the error is about.

    limitinteger

    office_document_too_large: the limit in bytes.

    errors object[]

    einvoice_data_invalid: every field of the _invoice block that is missing or breaks a rule.

  • Array [
  • pathstringnullable
    messagestring
    rulestring
    Example: BR-CO-15
  • ]
  • attemptsinteger

    worker_exhausted: how often the queue tried.

    retry_afterinteger

    office_unavailable, conformance_unavailable: the seconds the busy service asked for.

    property name*any

    The error a failed render stored: its code and English message, and the members of its problem that say more. It has no type, title or status. An e-invoice report or a PDF/UA verdict is never in here: the render carries them as einvoice and accessibility.

    RenderError
    {
    "code": "template_syntax_error",
    "message": "string",
    "line": 0,
    "column": 0,
    "engine": "jinja2",
    "part": "word/document.xml",
    "paragraph": 0,
    "diagnostics": [
    {
    "severity": "error",
    "message": "string",
    "code": "string",
    "location": {
    "line": 0,
    "column": 0
    },
    "path": "string",
    "part": "string",
    "paragraph": 0
    }
    ],
    "page_count": 0,
    "reason": "string",
    "entry": "string",
    "limit": 0,
    "errors": [
    {
    "path": "string",
    "message": "string",
    "rule": "BR-CO-15"
    }
    ],
    "attempts": 0,
    "retry_after": 0
    }