Note: Please read “Configure a lab automation run” for more general information about configuring the lab automation run.

What are run schema fields?

The run schema fields refer to the user-entered fields on the run. They are configured similarly to how fields on a Request or columns in a Result table are configured. They exist as a part the Lab Automation run and contain an array of fields separated by {}. The fields answer the question: what information is needed to generate an input file that can instruct the instrument.

The run schema fields must be saved first before configuring the automationInputFile.

Configure the run schema fields

As mentioned before, run fields are constructed similar to how the fields on a Request or Result schema are constructed using the following format:

"fields": [
"displayName": "",
"name": "",
"isMulti": ,
"schemaId": "",
"isRequired": ,
"type": ""

If you are interested in the types of fields that can be configured for run schemas, please see here for more information.

Take a look at the JSON that we used to configure the Plates and the Volume Change (uL) schema fields. Notice how:

  • The object encoding the Plates field includes a value for the API ID of the 96-well plate schema we used
  • The "Plates" field is configured as a "storage_link"
  • Both fields are required
"fields": [
"displayName": "Plates",
"name": "plate",
"isMulti": true,
"schemaId": "pltsch_abc123ef",
"isRequired": true,
"type": "storage_link"
"isMulti": false,
"type": "integer",
"displayName": "Volume Change (uL)",
"name": "vol",
"isRequired": true

Did this answer your question?