--- title: "List AutomationOutputFileConfig items" method: GET path: "/api/v3/run-schema/{run_schema_id}/automation-output-file-configs/items" tags: ["Run Schema"] --- # List AutomationOutputFileConfig items `GET /api/v3/run-schema/{run_schema_id}/automation-output-file-configs/items` ## Request - Base URL: `https://{tenant_name}.benchling.com` - URL: `https://{tenant_name}.benchling.com/api/v3/run-schema/{run_schema_id}/automation-output-file-configs/items` - Auth: HTTP bearer List AutomationOutputFileConfig items. ## Path parameters - `run_schema_id` string, required ## Headers - `EARLY-ACCESS` string ## Response `200` OK - AutomationOutputFileConfigUnpaginatedList - `items` AutomationOutputFileConfig[] - `__typename` string - `allowMissingSource` boolean, nullable: Whether to allow some source values to be missing in the output file to be processed - `automationOutputFileTableType` 'GRID' | 'SAMPLE': Type for the notebook table produced by processing output files with this configuration. GRID for one row per box/plate, SAMPLE for one row per sample. - `columns` string[], nullable: List of columns for output files to be processed by this configuration. Either "columns" or "namedColumnTypes", but not both, must be provided. - `concentrationUnits` string, nullable: Units with which to interpret any concentration values in output files processed by this configuration. - `datasetNameTemplateParts` AutomationInputFileNamePart[], nullable: Configuration for naming output datasets generated by this configuration - `__typename` string - `field` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - `text` string, nullable: Text value for the name of the input file (only present for TEXT type) - `type` 'CREATED_AT_DATE' | 'CREATED_AT_TIME' | 'DISPLAY_NAME' | 'FIELD' | 'RUN_API_ID' | 'RUN_ID' | 'RUN_SCHEMA_NAME' | 'SOURCE_FILE_NAME' | 'TEXT': The type of this name template part - `delimiter` string, nullable: Delimiter to use in transform files generated by this configuration - `entitySchemaInfo` AutomationOutputFileEntitySchemaInfo: Configuration for registering or updating entities when processing an automation output file. Specifies the entity schema, destination folder, naming strategy, field mappings, and the action to perform (create, update, or both). - `__typename` string - `actionType` 'CREATE' | 'UPDATE' | 'CREATE_OR_UPDATE': CREATE, UPDATE, or CREATE_OR_UPDATE - `fields` AutomationOutputFileTransformationFieldInfo[], nullable: Configuration for schema fields of items to be registered when processing output files - `__typename` string - `columnIndex` integer, nullable: Index of column to use for a DIRECT field - `columnName` string, nullable: Name of column to use for a DIRECT field - `filterSchema` EntitySchemaRef - `__typename` string - `id` string, api_id - `schemaField` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - `type` 'CALCULATE_FINAL_CONCENTRATION' | 'DIRECT' | 'PRIMARY_SAMPLE_ENTITY' | 'SOURCE_CONTENTS': Type of field configuration - CALCULATE_FINAL_CONCENTRATION, DIRECT, PRIMARY_SAMPLE_ENTITY, or SOURCE_CONTENTS - `folder` FolderRef - `__typename` string - `id` string, api_id - `namingStrategy` 'NEW_IDS' | 'IDS_FROM_NAMES' | 'DELETE_NAMES' | 'SET_FROM_NAME_PARTS' | 'REPLACE_NAMES_FROM_PARTS' | 'KEEP_NAMES' | 'REPLACE_ID_AND_NAME_FROM_PARTS': Naming strategy for items to be registered when processing output files - `schema` EntitySchemaRef - `__typename` string - `id` string, api_id - `shouldReplaceExisting` boolean, nullable: Whether to replace existing items in the destination containers with the newly registered items - `fileExtension` string, nullable: Extension to use for transform files generated by this configuration - `id` string - `inventorySchemaInfo` AutomationOutputFileInventorySchemaInfo: Configuration for creating or updating inventory items (plates, boxes, or containers) when processing an automation output file. Specifies the destination schema, storage location, project context, and field mappings. - `__typename` string - `fields` AutomationOutputFileTransformationFieldInfo[], nullable: Configuration for schema fields of inventory items to be created or updated when processing output files - `__typename` string - `columnIndex` integer, nullable: Index of column to use for a DIRECT field - `columnName` string, nullable: Name of column to use for a DIRECT field - `filterSchema` EntitySchemaRef - `__typename` string - `id` string, api_id - `schemaField` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - `type` 'CALCULATE_FINAL_CONCENTRATION' | 'DIRECT' | 'PRIMARY_SAMPLE_ENTITY' | 'SOURCE_CONTENTS': Type of field configuration - CALCULATE_FINAL_CONCENTRATION, DIRECT, PRIMARY_SAMPLE_ENTITY, or SOURCE_CONTENTS - `location` LocationRef - `__typename` string - `id` string, api_id - `project` union: Union of Project, Registry - object: Project variant - `__typename` 'Project', required: Discriminator value: Project - `id` string, api_id - object: Registry variant - `__typename` 'Registry', required: Discriminator value: Registry - `id` string, api_id - `schema` union: Union of WellPlateSchema, MatrixPlateSchema, BoxSchema, ContainerSchema - object: BoxSchema variant - `__typename` 'BoxSchema', required: Discriminator value: BoxSchema - `id` string, api_id - object: ContainerSchema variant - `__typename` 'ContainerSchema', required: Discriminator value: ContainerSchema - `id` string, api_id - object: MatrixPlateSchema variant - `__typename` 'MatrixPlateSchema', required: Discriminator value: MatrixPlateSchema - `id` string, api_id - object: WellPlateSchema variant - `__typename` 'WellPlateSchema', required: Discriminator value: WellPlateSchema - `id` string, api_id - `isHidden` boolean, nullable: Whether output processors for this configuration are hidden from notebook runs. - `name` string, nullable: The name of the AutomationOutputFileConfig - `namedColumnTypes` AutomationOutputFileNamedColumnType[], nullable: List of columns for output files to be processed by this configuration. Either "columns" or "namedColumnTypes", but not both, must be provided. - `__typename` string - `columnType` string, nullable: Type of a column in an output file - `name` string, nullable: Name of a column in an output file - `quantityUnits` string, nullable: Units with which to interpret any volume or quantity values in output files processed by this configuration. - `resultSchemaInfo` AutomationOutputFileResultSchemaInfo: Configuration for creating assay results when processing an automation output file. Specifies the result schema and field mappings that control how file data is recorded as structured results. - `__typename` string - `fields` AutomationOutputFileTransformationFieldInfo[], nullable: Configuration for schema fields of results to be created when processing output files - `__typename` string - `columnIndex` integer, nullable: Index of column to use for a DIRECT field - `columnName` string, nullable: Name of column to use for a DIRECT field - `filterSchema` EntitySchemaRef - `__typename` string - `id` string, api_id - `schemaField` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - `type` 'CALCULATE_FINAL_CONCENTRATION' | 'DIRECT' | 'PRIMARY_SAMPLE_ENTITY' | 'SOURCE_CONTENTS': Type of field configuration - CALCULATE_FINAL_CONCENTRATION, DIRECT, PRIMARY_SAMPLE_ENTITY, or SOURCE_CONTENTS - `schema` ResultSchemaRef - `__typename` string - `id` string, api_id - `spreadsheetProcessingLocale` string, nullable: Locale to use to interpret dates, times, and decimal values in output files processed with this configuration - `transforms` AutomationTransformConfig[], nullable: Configuration for transforms to run before processing output files with this configuration. - union - object: A data transform that adds a new column to the file with values resolved via a LookupConfig. Used in input file generation to enrich data with looked-up values. - `__typename` 'AddColumnTransform', required: Discriminator value: AddColumnTransform - `transformationProperties` AddColumnTransformationProperties: Properties for an ADD_COLUMN transform, specifying the name of the new column to add. - `__typename` string - `column` string, nullable: The name of the column to be added - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (ADD_COLUMN) - object: A data transform that performs arithmetic operations between two variables (columns or constants) and writes the result to a new column. - `__typename` 'ArithmeticTransform', required: Discriminator value: ArithmeticTransform - `transformationProperties` ArithmeticTransformationProperties: Properties for an ARITHMETIC transform, defining the operator, operands, and the name of the result column. Supports addition, subtraction, multiplication, and division between column values and/or constants. - `__typename` string - `firstVariable` union: Union of ArithmeticTransformColumnVariable, ArithmeticTransformConstantVariable - … - `newColumnName` string, nullable: Name of the column that will contain the results of the arithmetic operation - `operator` string, nullable: The arithmetic operation to perform: +, -, *, or / - `secondVariable` union: Union of ArithmeticTransformColumnVariable, ArithmeticTransformConstantVariable - … - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (ARITHMETIC) - object: A data transform that delegates processing to an external Benchling App. The app is identified by its API ID in the transformation properties. - `__typename` string, required - `transformationProperties` CustomTransformationProperties: Properties for a CUSTOM transform, identifying the Benchling App that performs the transformation via its API ID. - `__typename` string - `transformId` string, nullable: API ID of a Benchling App that performs the transform - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (CUSTOM) - object: A data transform that copies an existing column to a new column with a different name. - `__typename` string, required - `transformationProperties` DuplicateTransformationProperties: Properties for a DUPLICATE transform, specifying the source column to copy and the name for the new duplicate column. - `__typename` string - `columnToDuplicate` string, nullable: Name of column to be duplicated - `newColumnName` string, nullable: Name of new column created by duplicating - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (DUPLICATE) - object: A data transform that removes trailing footer rows from a file. Useful for instrument output files that append summary or metadata rows after the data. - `__typename` string, required - `transformationProperties` ExtraFootersTransformationProperties: Properties for an EXTRA_FOOTERS transform, specifying how many trailing rows to remove from the bottom of the file. - `__typename` string - `numRowsToRemove` integer, nullable: Number of rows to remove from the bottom of the file - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (EXTRA_FOOTERS) - object: A data transform that handles files with extra header rows above the standard column header. Strips the specified header rows so downstream processing sees clean tabular data. - `__typename` string, required - `transformationProperties` ExtraHeadersTransformationProperties: Properties for an EXTRA_HEADERS transform, specifying the row range that contains non-standard header rows to skip during file processing. - `__typename` string - `headerRowIndex` integer, nullable: Index of the first row of the header - `lastHeaderRowIndex` integer, nullable: Index of the last row of the header. Optional, can be omitted if header is a single row - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (EXTRA_HEADERS) - object: A data transform that removes rows from the file based on column value conditions. Supports null checks, string/number comparisons, and set membership filters. - `__typename` string, required - `transformationProperties` union: Union of NullFilterTransformationProperties, StringValueFilterTransformationProperties, NumberValueFilterTransformationProperties, MultipleValuesFilterTransformationProperties - object: Properties for a FILTER transform that filters rows by checking whether a column's value is in (ISIN) or not in (NOTIN) a set of allowed values. - … - object: Properties for a FILTER transform that filters rows based on null or non-null values in a specified column. - … - object: Properties for a FILTER transform that filters rows by comparing a column's numeric value using relational operators (EQ, NE, LE, LT, GE, GT). - … - object: Properties for a FILTER transform that filters rows by comparing a column's string value using equality or inequality. - … - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (FILTER) - object: A data transform that substitutes values in the file by finding occurrences and replacing them. Replacement values can be specified inline or resolved via a LookupConfig. - `__typename` string, required - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (FIND_REPLACE) - object: A data transform that unpivots wide-format data into long format by converting selected value columns into rows, each identified by a variable name. - `__typename` string, required - `transformationProperties` MeltTransformationProperties: Properties for a MELT transform, specifying identifier columns to keep fixed, value columns to unpivot, and optional names for the new variable and value columns. - `__typename` string - `identifierColumns` string[], nullable - `newValueColumn` string, nullable - `newVariableColumn` string, nullable - `valueColumns` string[], nullable - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (MELT) - object: A data transform that concatenates values from multiple columns into a single output column, separated by a configurable delimiter. - `__typename` string, required - `transformationProperties` MergeTransformationProperties: Properties for a MERGE transform, specifying the columns to combine, the output column name, and the delimiter placed between merged values. - `__typename` string - `columnNames` string[], nullable: Names of columns to be merged - `delimiter` string, nullable: Delimiter to put between merged values - `outputColumnName` string, nullable: Name of column to contain merged values - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (MERGE) - object: A data transform that reshapes long-format data into wide format by pivoting unique values from a keys column into separate columns. - `__typename` string, required - `transformationProperties` PivotTransformationProperties: Properties for a PIVOT transform, specifying the index columns to group by, the keys column whose values become new column headers, and the values column to spread. - `__typename` string - `indexColumns` string[], nullable - `keysColumn` string, nullable - `valuesColumn` string, nullable - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (PIVOT) - object: A data transform that extracts plate-shaped data from a file by locating the well grid at specified coordinates and optionally removing all surrounding cells. - `__typename` string, required - `transformationProperties` PlateShapeTransformationProperties: Properties for a PLATE_SHAPE transform, specifying the plate schema for expected dimensions, the cell coordinates of well A1, and whether to discard data outside the plate region. - `__typename` string - `deleteOtherCells` boolean, nullable: Whether to delete all cells outside of the plate shape data - `firstWellColumnIndex` integer, nullable: Column index in the file of well A1 - `firstWellRowIndex` integer, nullable: Row index in the file of well A1 - `plateSchema` string, nullable: API ID of a WellPlateSchema or MatrixPlateSchema that defines expected plate dimensions - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (PLATE_SHAPE) - object: A data transform that strips quote characters from all values in the file. Takes no additional configuration parameters. - `__typename` string, required - `transformationProperties` RemoveQuotesTransformTransformationProperties: Additional parameters for this transform - an empty object - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform (REMOVE_QUOTES) - object: A data transform that divides values in a single column into multiple output columns by splitting on a delimiter. - `__typename` string, required - `transformationProperties` SplitTransformationProperties: Properties for a SPLIT transform, specifying the column to split, the delimiter to split on, and the names for the resulting output columns. - `__typename` string - `column` string, nullable: Name of column to be split - `delimiter` string, nullable: Delimiter on which to split column values - `outputColumnNames` string[], nullable: Names of columns in which to put the split values - `type` 'ADD_COLUMN' | 'ARITHMETIC' | 'CUSTOM' | 'DUPLICATE' | 'EXTRA_HEADERS' | 'EXTRA_FOOTERS' | 'FILTER' | 'FIND_REPLACE' | 'MERGE' | 'MELT' | 'PLATE_SHAPE' | 'PIVOT' | 'REMOVE_QUOTES' | 'SPLIT': The type of this transform ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `429`: Too Many Requests - `500`: Internal Server Error --- [API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)