Benchling · Schema

AutomationOutputProcessorCreate

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks

Properties

Name Type Description
assayRunId string
automationFileConfigName string
completeWithErrors boolean Specifies whether file processing should complete with errors. False means any error in output file processing will result in no actions being committed. True means that if row-level errors occur, the
fileId string The ID of a blob link or the API ID of a file to process.
folderId string The API ID of the folder to set for the automation output file. Folder items created by the correpsonding output processor will be created in this folder.
locationId string The API ID of the location to set for the automation output file. Storable items created by the correpsonding output processor will be created at this location.
timezone string The timezone to set for the automation output file. Used as the timezone for the timestamp fields if not set in the timestamp.
View JSON Schema on GitHub

JSON Schema

AutomationOutputProcessorCreate.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/AutomationOutputProcessorCreate.json",
  "title": "AutomationOutputProcessorCreate",
  "additionalProperties": false,
  "properties": {
    "assayRunId": {
      "type": "string"
    },
    "automationFileConfigName": {
      "type": "string"
    },
    "completeWithErrors": {
      "description": "Specifies whether file processing should complete with errors. False means any error in output file processing will result in no actions being committed. True means that if row-level errors occur, then failing rows and their errors will be saved to errorFile, and actions from successful rows will be committed.",
      "type": "boolean"
    },
    "fileId": {
      "description": "The ID of a blob link or the API ID of a file to process.",
      "example": "cd624536-c6ba-41b9-b802-9461689e2ea3 or file_65Cevxgm",
      "type": "string"
    },
    "folderId": {
      "description": "The API ID of the folder to set for the automation output file. Folder items created by the correpsonding output processor will be created in this folder.",
      "type": "string"
    },
    "locationId": {
      "description": "The API ID of the location to set for the automation output file. Storable items created by the correpsonding output processor will be created at this location.",
      "type": "string"
    },
    "timezone": {
      "description": "The timezone to set for the automation output file. Used as the timezone for the timestamp fields if not set in the timestamp.",
      "type": "string"
    }
  },
  "required": [
    "fileId",
    "automationFileConfigName",
    "assayRunId"
  ],
  "type": "object"
}