API overview

• Labsheets — LIMS tables, rows, and schema
• ELN — protocols, experiments, and documentation
• Manifests — plates, boxes, racks, and locations
• Sequences — sequence records
• Webhooks — inbound events to Scispot

​

Terminology

• Row ID - A unique identifier for a row in a Labsheet. It can have three types: ROW_UUID, ID_BARCODE, or ID.
  • ROW_UUID - This is the autogenerated identifier in the backend when a row is created.
  • ID_BARCODE - This is the value of the ID column if the ID column was set to use autogenerated IDs.
  • ID - This is the value of the ID column if the ID column was set to use a manual ID.
• Columns - A Column determines the type of data that can be stored in a row.
  • ID - An ID column. This column is used to store the identifier for a row. It can be used to link to other data in Scispot.
  • ID_BARCODE - An ID barcode column. This column is used to store the unique identifier for a row. It can be used to link to other data in Scispot.
  • TEXT - A text column. This column type can store any string value
  • NUMBER - A number column. This column can only store numeric values. (must convert scientific notation to decimal)
  • QUANTITY - A quantity column. This column can store a numeric value that represents a quantity.
  • QUANTITY_LEFT - A quantity left column. This column is a derived column that is calculated based on the quantity column and cannot be set manually.
  • QUANTITY_CONSUMED - A quantity consumed column. This column is a derived column that is calculated based on the quantity column and cannot be set manually.
  • UNIT - A unit column. This column can store a string value that represents a unit of measurement in a list of units.
  • PRICE_PER_UNIT - A price per unit column. This column can store a numeric value that represents a price per unit of measurement.
  • CHECKBOX - A checkbox column. This column can only store boolean values.
  • LIST - A list column. This column can store a string value that is one of the values in the list.
  • STATUS - A status column. This column can store a string value that is one of the values in the status list.
  • DATE - A date column. This column can store a date value. (datetime values will be converted to date)
  • DATETIME - A datetime column. This column can store a datetime value.
  • LOCATION - A location column. This column can store a uuid value that represents a location in the Scispot Location API.
  • EXTERNAL_BARCODE - A external barcode column. This column can store a string value that represents a barcode that can be used with barcode scanners.
  • ATTACHED_FILES - A attached files column. This column can store a list of file uuids that represents files in the Scispot File API.
  • IMAGE_COL - A image column. This column can store an image uuid that represents an image in the Scispot File API.
  • CONNECTION - A reference column. This column can store a uuid value that represents a reference to another row in the labsheet.
  • LOOKUP_REFERENCE - A link to another labsheet column. This column can store a url value that represents a link to another row in a specified labsheet. (must have a specified labsheet to link to)
  • LOOKUP - A lookup column. This column uses the LINK column to lookup a column value in the specified labsheet. (cannot be set manually)
  • PARENT - A parent column. This column can store a uuid value that represents a parent row. (can only be set through the create children flow)
  • CHILDREN - A children column. This column can store a list of uuid values that represents child rows. (can only be set through the create children flow)
  • SEQUENCE_DATA - A sequence data column. This column can store a sequence through the Scispot Sequence API.
  • CHEM_DATA - A chem data column. This column can store a chem data. (must be set through the Labsheets GUI)
  • CREATED_BY - A created by column. This column can store the user email who created the row. (cannot be set manually)
  • DATE_CREATED - A creation date column. This column can store the datetime when the row was created. (cannot be set manually)
  • LABSPACE_PAGE_REFERENCE - A protocol template column. This column can store a uuid value as a link that represents a protocol template in the Scispot Labspace API.
• MAGIC COLUMNS - Magic columns are read only columns that are automatically updated by Scispot when the row has interaction with other Scispot features, such as labspaces.
  • Labspaces - Type: TEXT. A labspace column. This column links to all the labspaces that the row is associated with.
  • Last Modified - Type: DATE. A last modified column. This column stores the datetime when the row was last modified.
  • Existing Manifest - Type: TEXT. A link column. This column links to all of the manifests that the row is associated with.
  • Name of Protocol - Type: TEXT. A link column. This column links to all of the protocols that the row is associated with.
  • Name of Experiment - Type: TEXT. A link column. This column links to all of the experiments that the row is associated with.

​

Authentication

​

Explore endpoints