Exports

List a draw package export's rows

Lists the export's rows in submission order, cursor-paginated, each with its outcome. status narrows the list — ?status=succeeded to download, ?status=failed to retry.

A succeeded row carries its file: a direct download link to the PDF, valid until its expires_at, about an hour after this read. Download without the bearer token; the link is its own credential. Read the page again for fresh links rather than storing them. A row whose draw your service account can no longer access has no file.

A failed row carries a problem: NOT_FOUND for a draw that does not exist or is inaccessible, as GET /draws/{drawId} would answer, or one of the codes below. Submit failed draws again in a new export.

  • DRAW_PACKAGE_ITEMS_INACCESSIBLE — the draw's saved package includes documents or templates your service account cannot access.
  • DRAW_PACKAGE_FAILED — generating the package failed.
  • EXPORT_ABORTED — generation stopped after repeated errors.
get/exports/draw-packages/{exportId}/rows

Request

  • Base URL: https://api.rabbet.com/v1
  • URL: https://api.rabbet.com/v1/exports/draw-packages/{exportId}/rows
  • Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: read)

Path parameters

exportIdstring uuid required

Export UUID, from the 202 that accepted it.

Query parameters

status'pending' | 'succeeded' | 'failed'

pending until the draw's package is finished; then succeeded (its file is ready) or failed (see problem).

Only rows with this outcome.

limitinteger

Page size, between 1 and 100.

cursorstring

Opaque cursor from the previous page's pagination.next_cursor.

Response

A page of rows (empty when none match).

Example response

{
  "data": [
    {
      "index": 3,
      "problem": {
        "code": "VALIDATION_FAILED",
        "title": "Validation failed",
        "detail": "Set values only for custom fields this project's type defines; discover them via GET /project-types.",
        "errors": [
          {
            "field": "name",
            "code": "REQUIRED",
            "detail": "is required"
          }
        ]
      },
      "file": {
        "name": "Riverside Lofts Draw 9 draw package.pdf"
      }
    }
  ],
  "pagination": {
    "next_cursor": "g3QAAAACdwJpZG0AAAAkZDI5MGYxZWU"
  }
}

Changes

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