BEbenchling
entries

Get notebook entries using entry IDs or display IDs

Get notebook entries using entry IDs or display IDs

get/entries:bulk-get

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • Auth
    HTTP bearer

Query parameters

entryIdsstring

Comma-separated list of Entry IDs.

displayIdsstring

Comma-separated list of Entry Display IDs.

returningstring

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, click here.

Note: "entries.days.notes" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., "entries.days.notes.text" will return the same model as "entries.days.notes".

Response

Returns a list of entries. Entries are notes that users can take. They're organized by "days" (which are user-configurable) and modeled within each day as a list of "notes." Each note has a type - the simplest is a "text" type, but lists, tables, and external files are also supported.

Note: the current Entry resource has a few limitations:

  • Formatting information is not yet supported. Header formatting, bolding, and other stylistic information is not presented.
  • Data in tables is presented as text always - numeric values will need to be parsed into floats or integers, as appropriate.

Note: Data in Results tables are not accessible through this API call. Results table data can be called through the Results API calls.

Changes

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