Benchling · Schema

ConvertToCSV

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

Properties

Name Type Description
automationOutputFileId string The ID of an AutomationOutputFile configured to with CSV transform argument. Transform parameters will be read from file settings.
blobOrFileId string The ID of a blob link or the API ID of a file to process.
connectionId string The ID of a connection to read the instrument vendor from.
mapperConfig string A JSON configuration specifying how to convert a JSON file to CSV. Reach out to Benchling Support for more information about how to create a mapperConfig.
transformType string The transform type to use to convert an ASM file to CSV.
vendor string The instrument vendor to use for conversion. See /connect/list-allotropy-vendors.
View JSON Schema on GitHub

JSON Schema

ConvertToCSV.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/ConvertToCSV.json",
  "title": "ConvertToCSV",
  "additionalProperties": false,
  "properties": {
    "automationOutputFileId": {
      "description": "The ID of an AutomationOutputFile configured to with CSV transform argument. Transform parameters will be read from file settings.",
      "type": "string"
    },
    "blobOrFileId": {
      "description": "The ID of a blob link or the API ID of a file to process.",
      "type": "string"
    },
    "connectionId": {
      "description": "The ID of a connection to read the instrument vendor from.",
      "type": "string"
    },
    "mapperConfig": {
      "description": "A JSON configuration specifying how to convert a JSON file to CSV. Reach out to Benchling Support for more information about how to create a mapperConfig.",
      "type": "string"
    },
    "transformType": {
      "description": "The transform type to use to convert an ASM file to CSV.",
      "type": "string"
    },
    "vendor": {
      "description": "The instrument vendor to use for conversion. See /connect/list-allotropy-vendors.",
      "type": "string"
    }
  },
  "required": [
    "blobOrFileId"
  ],
  "type": "object"
}