BEbenchling
Dataset

Update Dataset

Update Dataset.

patch/api/v3/dataset/{dataset_id}

Request

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

Path parameters

dataset_idstring required

ID of the Dataset.

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.

customFieldsUpdateDatasetInputCustomFields
folderIdstring
namestring

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
dataFrameIdstring nullable
displayIdstring nullable

A human-readable identifier for this dataset (e.g. "DATASET-1"). Automatically generated and unique within the tenant.

idstring
modifiedAtstring datetime
namestring nullable

Changes

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