Skip to navigation
v2Connect

Convert a blob or file containing ASM, JSON, or instrument data to CSV

Convert a blob or file containing ASM, JSON, or instrument data to CSV.

If the file is ASM JSON, specify either no transform type (in which case all transform types will be returned), a matching transform type for the ASM schema, or a custom JSON mapper config.

If the file non-ASM JSON, must provide a JSON mapper config argument, which specifies how to map the JSON to CSV. Reach out to Benchling Support for more information about how to create a JSON mapper config.

If the file is an instrument file, must also specify an instrument vendor. The file will be converted first to ASM JSON and then to CSV. Only the CSV output will be returned.

May provide an AutomationOutputFile with CSV transform arguments configured to read the transform type or mapper config from.

May provide a connection ID associated with an instrument to read the vendor from.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
blobOrFileIdstringRequired
The ID of a blob link or the API ID of a file to process.
automationOutputFileIdstringOptional
The ID of an AutomationOutputFile configured to with CSV transform argument. Transform parameters will be read from file settings.
connectionIdstringOptional
The ID of a connection to read the instrument vendor from.
mapperConfigstringOptional
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.
transformTypestringOptional
The transform type to use to convert an ASM file to CSV.
vendorstringOptional

The instrument vendor to use for conversion. See /connect/list-allotropy-vendors.

Response

List of pairs of (transformDataType, blobId) where the blob ID is the ID of a blob containing the converted CSV.

blobIdstringOptional
transformDataTypestringOptional

Errors

400
Bad Request Error