BEbenchling
containers

Transfer into container

Transfers a volume of an entity or container into a destination container. Transfering a volume is cumulative with the existing destination container's contents. To transfer an entire container's contents, the sourceContainerId should be specified. To otherwise transfer multiple entities within a container, you can make multiple calls to this endpoint, specifying a single entity with each call.

post/containers/{destination_container_id}:transfer

Request

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

Path parameters

destination_container_idstring required

Request body

restrictedSamplePartyIdsstring[]

IDs of users or teams to be set as restricted sample parties for the destination container. If not specified, restricted sample parties from the source container, if present, will be added to those of the destination container. This only applies to stand-alone containers.

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

IDs of users or teams to be set as sample owners for the destination container. If not specified, restricted sample parties from the source container, if present, will be added to those of the destination container. This only applies to stand-alone containers.

sourceBatchIdstring

ID of the batch that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.

sourceContainerIdstring

ID of the container that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.

sourceEntityIdstring

ID of the entity that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.

Response

OK

EmptyObject required

Changes

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