Get unstructured table content for a document part

Beta

GET

https://{tenant_name}.benchling.com/api/v3/document-part-unstructured-table/:doc_part_id

GET

/api/v3/document-part-unstructured-table/:doc_part_id

curl https://{tenant_name}.benchling.com/api/v3/document-part-unstructured-table/doc_part_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "caption": {
    "__typename": "__typename",
    "formats": [
      {}
    ],
    "links": [
      {}
    ],
    "mentions": [
      {}
    ],
    "text": "text"
  },
  "columnDefinitions": [
    {
      "__typename": "__typename",
      "isLocked": true,
      "name": "name",
      "width": 1.1
    }
  ],
  "createdAt": "createdAt",
  "documentParent": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "indentation": 1,
  "isEvaluated": true,
  "modifiedAt": "modifiedAt",
  "modifier": {
    "__typename": "__typename",
    "id": "id"
  },
  "name": "name",
  "nextToken": "nextToken",
  "pageSize": 1,
  "rowCount": 1,
  "rows": [
    {
      "__typename": "__typename",
      "cells": [
        {}
      ],
      "rowIndex": 1
    }
  ],
  "versionMetadata": {
    "__typename": "__typename",
    "createdAt": "createdAt",
    "versionId": "versionId"
  }
}

Return the unstructured table content for a DocumentPart that is an unstructured table. Return 404 if the document part does not exist. Return 400 if the document part is not an unstructured table.

Rows are paginated: pass pageSize and the nextToken from the previous response to page through rows. Each row carries its absolute rowIndex.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

doc_part_idstringRequired

Query parameters

pageSizeintegerOptional1-1000Defaults to 1000

Maximum number of table rows to return in a single page.

nextTokenstringOptional

Page token from a previous response, used to fetch the next page of rows.

Response

Unstructured table content

__typenamestringOptional

captionobject or nullOptional

Specifies the rich text caption displayed with the table. Null if the table has no caption.

columnDefinitionslist of objectsOptional

Lists column definitions for the table.

createdAtstringOptional

Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created.

documentParentobjectOptional

idstringOptional

Identifies the document part.

indentationintegerOptional

Specifies the indentation level for this content within the document.

isEvaluatedbooleanOptional

Specifies whether formula evaluation has been applied to the table.

modifiedAtstringOptional

Specifies when this document part was last modified.

modifierobject or nullOptional

Identifies who last modified this document part.

namestringOptional

Specifies the display name of the table.

nextTokenstringOptional

Opaque cursor for the next page of rows. Empty string when there are no more rows. Note: a merge anchor cell may reside on an earlier page than its child cells.

pageSizeintegerOptional

The page size applied to this response.

rowCountintegerOptional

Specifies the number of rows in the table.

rowslist of objectsOptional

Lists rows in the table, each containing an ordered array of cells.

versionMetadataobjectOptional

Specifies version metadata for the parent document.

Errors

400

Document Part Unstructured Table Get Request Bad Request Error

403

Document Part Unstructured Table Get Request Forbidden Error

404

Document Part Unstructured Table Get Request Not Found Error

429

Document Part Unstructured Table Get Request Too Many Requests Error

500

Document Part Unstructured Table Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors