Get DocumentPartResultsTable by ID

Beta

GET

https://{tenant_name}.benchling.com/api/v3/document-part-results-table/:document_part_results_table_id

GET

/api/v3/document-part-results-table/:document_part_results_table_id

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

{
  "__typename": "__typename",
  "columnDefinitions": [
    {
      "__typename": "__typename",
      "allowsArrayValues": true,
      "cellValueType": "cellValueType",
      "columnId": "columnId",
      "isArchived": true,
      "isLocked": true,
      "isReadonly": true,
      "isRequired": true,
      "name": "name",
      "width": 1.1
    }
  ],
  "createdAt": "createdAt",
  "id": "id",
  "indentation": 1,
  "isEvaluated": true,
  "isSubmittable": true,
  "modifiedAt": "modifiedAt",
  "modifier": {
    "__typename": "__typename",
    "id": "id"
  },
  "name": "name",
  "resultSchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "rowCount": 1,
  "rows": "rows",
  "submissionStatus": "UNSUBMITTED",
  "versionMetadata": {
    "__typename": "__typename",
    "createdAt": "createdAt",
    "versionId": "versionId"
  }
}

Get a single DocumentPartResultsTable by ID.

Authentication

AuthorizationBearer

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

Path parameters

document_part_results_table_idstringRequired

ID of the DocumentPartResultsTable.

Query parameters

returningstringOptional

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

omitstringOptional

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

Response

__typenamestringOptional

columnDefinitionslist of objectsOptional

createdAtstringOptional

idstringOptional

indentationintegerOptional

isEvaluatedbooleanOptional

isSubmittablebooleanOptional

modifiedAtstringOptional

modifierobject or nullOptional

namestringOptional

resultSchemaobject or nullOptional

rowCountintegerOptional

rowsstringOptionalformat: "uri"

submissionStatusenumOptional

Allowed values:

versionMetadataobjectOptional

Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record.

Errors

400

Document Part Results Table Get Request Bad Request Error

403

Document Part Results Table Get Request Forbidden Error

404

Document Part Results Table Get Request Not Found Error

429

Document Part Results Table Get Request Too Many Requests Error

500

Document Part Results Table Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors