Container

Update Container

Update Container.

patch/api/v3/container/{container_id}

Request

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

Path parameters

container_idstring required

ID of the Container.

Request body

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.

namestring
parentStorageIdstring nullable
projectIdstring nullable
restrictedSamplePartyIdsstring[]

API IDs of the restricted sample parties (a party is a Benchling user, Organization, or Team). Limited to 100 items.

restrictionStatus'RESTRICTED' | 'UNRESTRICTED' | 'NOT_APPLICABLE'
sampleOwnerIdsstring[]

API IDs of the sample owners (an owner is a Benchling user, Organization, or Team). Limited to 100 items.

schemaFieldsobject

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
barcodestring nullable
createdAtstring datetime
gridNumbernumber double nullable

Please use coordinates.index

gridPositionstring nullable

Please use coordinates.position

idstring
modifiedAtstring datetime
namestring
testOrdersstring uri nullable

All test orders associated with the container.

Changes

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