BEbenchling
File

Get File by ID

Get a single File by ID.

get/api/v3/file/{file_id}

Request

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

Path parameters

file_idstring required

ID of the File.

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
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
currentVersionIdstring nullable
displayIdstring nullable
externalFileIdstring nullable

Use scratchFile to access externalFileId.

filenamestring nullable

Use scratchFile to access filename.

idstring
mimeTypestring nullable

Use scratchFile to access mimeType.

modifiedAtstring datetime
namestring nullable
versionsstring uri

Published versions of the File, newest first.

Changes

No recorded changes to this operation across all 2 revisions of this API.