BEbenchling
File

Update File

Update File.

patch/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.

Request body

allowCustomFieldDeletionboolean

When true, custom fields present on the object but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

customFieldsUpdateFileInputCustomFields
expectedVersionIdstring

The File's current version as last read by the caller. The update is rejected if another version has been published since.

filenamestring

The name of the underlying file. Names the content of scratchFileId if given, otherwise renames the current version in place. Must not be blank, and its extension must not be blocked by the tenant's file upload settings.

folderIdstring
namestring
scratchFileIdstring

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.