Scratch File

Get ScratchFile by ID

Get a single ScratchFile by ID.

get/api/v3/scratch-file/{scratch_file_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

scratch_file_idstring required

ID of the ScratchFile.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__typenamestring
createdAtstring datetime nullable
downloadUrlstring nullable
errorMessagestring nullable
externalFileIdstring nullable
filenamestring
idstring
mimeTypestring nullable
modifiedAtstring datetime nullable
namestring
sizeinteger nullable
uploadStatus'SUCCEEDED' | 'FAILED_VALIDATION' | 'IN_PROGRESS' | 'NOT_UPLOADED'
uploadUrlstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.