Skip to navigation
v2-alphaEntries

Create a notebook entry

Dev
Create a notebook entry with optional attachments. Attachments will be placed into the entry body in the order they are specified.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
folderIdstringRequired
ID of the folder that will contain the entry
namestringRequired
Name of the entry
attachmentTextanyOptional

Text to include in the entry before the attachments. If not provided, the text will be “File attachments are listed below:”

attachmentslist of stringsOptional
An array of IDs representing Blob objects in Benchling to be attached to the entry.
authorIdsstring or list of stringsOptional
customFieldsmap from strings to objectsOptional
Custom fields to add to the entry
entryTemplateIdstringOptional
ID of the template to clone the entry from
fieldsmap from strings to objectsOptional
Fields to set on the entry. Must correspond with the schema's field definitions.
initialTableslist of objectsOptional

An array of table API IDs and blob id pairs to seed tables from the template while creating the entry. The entryTemplateId parameter must be set to use this parameter. The table API IDs should be the API Identifiers of the tables in the given template.

  • If a template table has one row, the values in that row act as default values for cloned entries.
  • If a template table has multiple rows, there is no default value and those rows are added to the cloned entry along with the provided csv data.
  • If a table has default values, they will be populated in any respective undefined columns in the csv data.
  • If a table has no default values, undefined columns from csv data will be empty.
  • If no csv data is provided for a table, the table in the entry will be populated with whatever values are in the respective template table.
reviewRecordobjectOptional
schemaIdstringOptional
ID of the entry's schema

Response

Accepted
taskIdstringOptional

Errors

400
Bad Request Error