Drawing source objects and gaps

Field

Type

Description

knowledge_base_id

integer

Knowledge base for this request.

source_file_id

string

Queried source file identifier.

external_source_uri

string or null

Source URI; null without a trusted value. Does not guarantee public downloading.

visual_manifest_file_id

string or null

Visual manifest file ID; null when absent.

provenance_status

string

ready or legacy_unmigrated.

gaps

string (array of strings)

Detected source gaps; [] when none.

pages

object (array of objects)

Complete valid page mappings; [] when absent. Does not invent preview pages.

pages[].page_number

integer

Positive page number.

pages[].page_image_file_id

string

Full-page image file ID.

pages[].preview_url

string

Authenticated relative API preview path. Read using the same environment’s gateway and Workspace credentials.

ready requires valid pages and a visual manifest. It can remain ready without external_source_uri, with external_origin_missing in gaps. legacy_unmigrated may indicate an old schema/no migration or partial gaps. Check fields rather than relying on one state. Unloaded evidence, null fields, and empty arrays differ. Source fields may be omitted in retrieval results, whereas standalone provenance objects explicitly return null/arrays.

gaps value

Meaning

drawing_provenance_schema_missing

Missing source tables/columns; returns legacy, not 404

drawing_provenance_unmigrated

No file record or page mapping

drawing_page_missing

No valid positive page-number/page-image ID pair

visual_manifest_missing

Missing visual manifest ID

external_origin_missing

Missing original source URI

Missing source tables prioritize schema gaps and may not enumerate every empty field. An unknown source_file_id in an accessible knowledge base can also return legacy/empty pages, so 200 does not establish file existence. A missing page_number returns 404/ErrDrawingPageUnavailable. page_number checks existence only and does not narrow the pages array.

Last updated on