ContainerTransferBase

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/ContainerTransferBase.json",
  "title": "ContainerTransferBase",
  "properties": {
    "restrictedSamplePartyIds": {
      "description": "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.\n",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "restrictionStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SampleRestrictionStatus"
        }
      ],
      "description": "Restriction status of the destination container, either RESTRICTED or UNRESTRICTED. If not specified, the restriction status of the destination container will be the more restrictive of the source container, if present, and destination container restriction statuses. This only applies to stand-alone containers (Plate wells are always set to NOT_APPLICABLE).\n"
    },
    "sampleOwnerIds": {
      "description": "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.\n",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "sourceBatchId": {
      "description": "ID of the batch that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.\n",
      "type": "string"
    },
    "sourceContainerId": {
      "description": "ID of the container that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.\n",
      "type": "string"
    },
    "sourceEntityId": {
      "description": "ID of the entity that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.\n",
      "type": "string"
    },
    "transferQuantity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContainerQuantity"
        }
      ],
      "description": "This represents the quantity of the source to be transferred into the destination container. Supports mass, volume, and other quantities. Required in place of transferVolume.\n"
    },
    "transferVolume": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeprecatedContainerVolumeForInput"
        }
      ],
      "description": "Deprecated - use transferQuantity instead.\n"
    }
  },
  "type": "object"
}