Blueprints / Drawing text

List the tables printed on a sheet

The tables printed on the sheet (schedules, legends, revision blocks), as an index with no cell contents: one entry per table with its id, title, source, bbox, size, coverage and flags. Open one with GET /tables/{table_id}, passing the id exactly as listed.

A table id names one table in one extraction of the sheet, not the table for all time. Each time the sheet is read for tables again (a re-upload, a re-run or a reprocessing), its rev and every id change, even when the tables come out the same; a run that fails or is cut short leaves the previous extraction in place.

status is never an error: ok; empty (read, and no printed tables: a real answer, unless complete is false); not_extracted (never read for tables: unknown, not empty); or unavailable (could not be read just now; retry). There is no failed or in-progress status: a sheet whose only extraction failed answers empty with complete: false, and while a sheet is being read you get what was stored before. A new upload's tables normally land within a couple of minutes: poll for a few minutes after upload; a sheet still not_extracted after that is not being read for tables.

Common mistakes: keeping table ids for days (list again; they change on every re-extraction); reading not_extracted or unavailable as "no tables" (only empty means that); assuming a table is complete (check coverage and degraded); stopping at the first page (follow next_cursor until it is null).

404 when the sheet is not in one of your projects; 422 for a malformed or outdated cursor.

get/v1/blueprints/{blueprint_id}/tables

Request

  • Base URL: https://api.kamai.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.kamai.io/v1/blueprints/{blueprint_id}/tables
  • Auth: HTTP bearer

Path parameters

blueprint_idstring required

Query parameters

qstring nullable

Only tables whose title contains this text, case-insensitive.

cursorstring nullable

next_cursor of the previous page. Tied to the sheet's extraction: if the sheet was read again in between, it is a 422; start the listing again.

limitinteger nullable

Tables per page, 1..1000; 1,000 when left out.

Response

Successful Response

status'ok' | 'empty' | 'not_extracted' | 'unavailable' required

ok; empty: read, and no printed tables (a real answer, unless complete is false); not_extracted: never read for tables, so unknown, not empty; unavailable: could not be read just now, retry.

totalinteger

Tables matching q, across all pages.

next_cursorstring nullable

Pass it as cursor for the next page; null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.