Get DocumentPartUnstructuredTable by ID

Beta

GET

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

GET

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

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

{
  "__typename": "string",
  "caption": {
    "__typename": "string",
    "formats": [
      {
        "__typename": "string",
        "backgroundColor": null,
        "end": 1,
        "foregroundColor": null,
        "properties": [
          "BOLD"
        ],
        "start": 1
      }
    ],
    "links": [
      {
        "__typename": "string",
        "end": 1,
        "start": 1,
        "url": "string"
      }
    ],
    "mentions": [
      {
        "__typename": "string",
        "itemId": "string",
        "position": 1
      }
    ],
    "text": "string"
  },
  "columnDefinitions": [
    {
      "__typename": "string",
      "isLocked": true,
      "name": "string",
      "width": null
    }
  ],
  "createdAt": "string",
  "id": "string",
  "indentation": 1,
  "isEvaluated": true,
  "modifiedAt": "string",
  "modifier": {
    "__typename": "string",
    "id": "string"
  },
  "name": "string",
  "rowCount": 1,
  "rows": "string",
  "versionMetadata": {
    "__typename": "string",
    "createdAt": null,
    "versionId": "string"
  }
}

Get a single DocumentPartUnstructuredTable by ID.

Authentication

AuthorizationBearer

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

Path parameters

document_part_unstructured_table_idstringRequired

ID of the DocumentPartUnstructuredTable.

Query parameters

returninglist of stringsOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitlist of stringsOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

__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.

createdAtstringOptionalformat: "datetime"

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.

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.

modifiedAtstringOptionalformat: "datetime"

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.

rowCountintegerOptional

Specifies the number of rows in the table.

rowsstringOptionalformat: "uri"

Lists rows in the table, in row order.

versionMetadataobjectOptional

Specifies version metadata for the parent document.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors