Batch Data
Bases: BaseAlbertModel
A single change applied to one cell of the batch data grid.
Used within a BatchValuePatchPayload to record the lot consumed for
a batch value. See
update_used_batch_amounts.
Example
Show JSON schema:
{
"description": "A single change applied to one cell of the batch data grid.\n\nUsed within a [`BatchValuePatchPayload`][albert.resources.batch_data.BatchValuePatchPayload] to record the lot consumed for\na batch value. See\n[`update_used_batch_amounts`][albert.collections.batch_data.BatchDataCollection.update_used_batch_amounts].\n\n!!! example\n ```python\n from albert.resources.batch_data import BatchValuePatchDatum\n\n datum = BatchValuePatchDatum(\n operation=\"update\",\n new_value=\"LOT123\",\n old_value=\"LOT100\",\n )\n ```",
"properties": {
"attribute": {
"default": "lotId",
"description": "The field being changed. Defaults to ``\"lotId\"``.",
"title": "Attribute",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The lot identifier being assigned, when applicable.",
"title": "Lotid"
},
"newValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The new value to set for the attribute.",
"title": "Newvalue"
},
"oldValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The previous value being replaced, when performing an update.",
"title": "Oldvalue"
},
"operation": {
"description": "The kind of change to apply (e.g. ``\"add\"``, ``\"update\"``, ``\"delete\"``).",
"title": "Operation",
"type": "string"
}
},
"required": [
"operation"
],
"title": "BatchValuePatchDatum",
"type": "object"
}
Fields:
old_value: str | None = None
The previous value being replaced, when performing an update.
Bases: BaseAlbertModel
Locates a single cell (value) within the batch data grid.
A value lives at the intersection of a row and a product column, so it is addressed by its row and (optionally) column identifiers.
Example
Show JSON schema:
{
"description": "Locates a single cell (value) within the batch data grid.\n\nA value lives at the intersection of a row and a product column, so it is\naddressed by its row and (optionally) column identifiers.\n\n!!! example\n ```python\n from albert.resources.batch_data import BatchValueId\n\n location = BatchValueId(row_id=\"ROW1\", col_id=\"COL9999999\")\n ```",
"properties": {
"colId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the product column the value belongs to.",
"title": "Colid"
},
"rowId": {
"description": "The identifier of the row the value belongs to. Required.",
"title": "Rowid",
"type": "string"
}
},
"required": [
"rowId"
],
"title": "BatchValueId",
"type": "object"
}
Fields:
Bases: BaseAlbertModel
A batch of changes targeting one cell of the batch data grid.
Passed to
update_used_batch_amounts
to record which lots were used for recorded batch amounts.
Example
Show JSON schema:
{
"$defs": {
"BatchValueId": {
"description": "Locates a single cell (value) within the batch data grid.\n\nA value lives at the intersection of a row and a product column, so it is\naddressed by its row and (optionally) column identifiers.\n\n!!! example\n ```python\n from albert.resources.batch_data import BatchValueId\n\n location = BatchValueId(row_id=\"ROW1\", col_id=\"COL9999999\")\n ```",
"properties": {
"colId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the product column the value belongs to.",
"title": "Colid"
},
"rowId": {
"description": "The identifier of the row the value belongs to. Required.",
"title": "Rowid",
"type": "string"
}
},
"required": [
"rowId"
],
"title": "BatchValueId",
"type": "object"
},
"BatchValuePatchDatum": {
"description": "A single change applied to one cell of the batch data grid.\n\nUsed within a [`BatchValuePatchPayload`][albert.resources.batch_data.BatchValuePatchPayload] to record the lot consumed for\na batch value. See\n[`update_used_batch_amounts`][albert.collections.batch_data.BatchDataCollection.update_used_batch_amounts].\n\n!!! example\n ```python\n from albert.resources.batch_data import BatchValuePatchDatum\n\n datum = BatchValuePatchDatum(\n operation=\"update\",\n new_value=\"LOT123\",\n old_value=\"LOT100\",\n )\n ```",
"properties": {
"attribute": {
"default": "lotId",
"description": "The field being changed. Defaults to ``\"lotId\"``.",
"title": "Attribute",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The lot identifier being assigned, when applicable.",
"title": "Lotid"
},
"newValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The new value to set for the attribute.",
"title": "Newvalue"
},
"oldValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The previous value being replaced, when performing an update.",
"title": "Oldvalue"
},
"operation": {
"description": "The kind of change to apply (e.g. ``\"add\"``, ``\"update\"``, ``\"delete\"``).",
"title": "Operation",
"type": "string"
}
},
"required": [
"operation"
],
"title": "BatchValuePatchDatum",
"type": "object"
}
},
"description": "A batch of changes targeting one cell of the batch data grid.\n\nPassed to\n[`update_used_batch_amounts`][albert.collections.batch_data.BatchDataCollection.update_used_batch_amounts]\nto record which lots were used for recorded batch amounts.\n\n!!! example\n ```python\n from albert.resources.batch_data import (\n BatchValueId,\n BatchValuePatchDatum,\n BatchValuePatchPayload,\n )\n\n patch = BatchValuePatchPayload(\n id=BatchValueId(row_id=\"ROW1\", col_id=\"COL9999999\"),\n data=[BatchValuePatchDatum(operation=\"update\", new_value=\"LOT123\")],\n )\n ```",
"properties": {
"Id": {
"$ref": "#/$defs/BatchValueId",
"description": "Locates the cell to change (its row and optional column)."
},
"data": {
"description": "The individual changes to apply to that cell.",
"items": {
"$ref": "#/$defs/BatchValuePatchDatum"
},
"title": "Data",
"type": "array"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The lot identifier associated with the change, when applicable.",
"title": "Lotid"
}
},
"required": [
"Id"
],
"title": "BatchValuePatchPayload",
"type": "object"
}
Fields:
-
id(BatchValueId) -
data(list[BatchValuePatchDatum]) -
lot_id(str | None)
Bases: BaseAlbertModel
A single recorded amount within the batch data grid.
Represents the value of one row within one product column (a cell of the grid), such as the amount of an ingredient used in a given batch.
Show JSON schema:
{
"description": "A single recorded amount within the batch data grid.\n\nRepresents the value of one row within one product column (a cell of the\ngrid), such as the amount of an ingredient used in a given batch.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the value.",
"title": "Id"
},
"colId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the product column this value belongs to.",
"title": "Colid"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type of the value.",
"title": "Type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The display name associated with the value.",
"title": "Name"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The recorded amount.",
"title": "Value"
},
"isEditable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the value can be edited.",
"title": "Iseditable"
},
"unitCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of unit the value is expressed in.",
"title": "Unitcategory"
},
"referenceValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference amount the value is compared against.",
"title": "Referencevalue"
}
},
"title": "BatchDataValue",
"type": "object"
}
Fields:
-
id(str | None) -
col_id(str | None) -
type(str | None) -
name(str | None) -
value(str | None) -
is_editable(bool | None) -
unit_category(str | None) -
reference_value(str | None)
reference_value: str | None = None
The reference amount the value is compared against.
Bases: BaseAlbertModel
A row of the batch data grid, typically a formulation component.
Each row represents an ingredient (or a sub-formula) that goes into the batch, together with the amounts recorded for it across the product columns. Sub-formulas expand into nested child rows.
Show JSON schema:
{
"$defs": {
"BatchDataRow": {
"description": "A row of the batch data grid, typically a formulation component.\n\nEach row represents an ingredient (or a sub-formula) that goes into the\nbatch, together with the amounts recorded for it across the product columns.\nSub-formulas expand into nested child rows.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the row.",
"title": "Id"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The row identifier used to locate values (see [`BatchValueId`][albert.resources.batch_data.BatchValueId]).",
"title": "Rowid"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type of the row.",
"title": "Type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the component the row represents.",
"title": "Name"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The manufacturer of the component, when known.",
"title": "Manufacturer"
},
"unitCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of unit the row's amounts are expressed in.",
"title": "Unitcategory"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of the component.",
"title": "Category"
},
"isFormula": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the row represents a formula (as opposed to a raw material).",
"title": "Isformula"
},
"isLotParent": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the row groups lots as a parent row.",
"title": "Islotparent"
},
"Values": {
"description": "The recorded amounts for this row, one per product column.",
"items": {
"$ref": "#/$defs/BatchDataValue"
},
"title": "Values",
"type": "array"
},
"ChildRows": {
"description": "Nested rows, e.g. the components of a sub-formula.",
"items": {
"$ref": "#/$defs/BatchDataRow"
},
"title": "Childrows",
"type": "array"
}
},
"title": "BatchDataRow",
"type": "object"
},
"BatchDataValue": {
"description": "A single recorded amount within the batch data grid.\n\nRepresents the value of one row within one product column (a cell of the\ngrid), such as the amount of an ingredient used in a given batch.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the value.",
"title": "Id"
},
"colId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the product column this value belongs to.",
"title": "Colid"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type of the value.",
"title": "Type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The display name associated with the value.",
"title": "Name"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The recorded amount.",
"title": "Value"
},
"isEditable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the value can be edited.",
"title": "Iseditable"
},
"unitCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of unit the value is expressed in.",
"title": "Unitcategory"
},
"referenceValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference amount the value is compared against.",
"title": "Referencevalue"
}
},
"title": "BatchDataValue",
"type": "object"
}
},
"$ref": "#/$defs/BatchDataRow"
}
Fields:
-
id(str | None) -
row_id(str | None) -
type(str | None) -
name(str | None) -
manufacturer(str | None) -
unit_category(str | None) -
category(str | None) -
is_formula(bool | None) -
is_lot_parent(bool | None) -
values(list[BatchDataValue]) -
child_rows(list[BatchDataRow])
Bases: BaseAlbertModel
A product column of the batch data grid.
Each column represents the batch/product being manufactured, carrying its totals and any breakdown into individual lots.
Show JSON schema:
{
"$defs": {
"BatchDataColumn": {
"description": "A product column of the batch data grid.\n\nEach column represents the batch/product being manufactured, carrying its\ntotals and any breakdown into individual lots.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the column.",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the product/batch.",
"title": "Name"
},
"colId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The column identifier used to locate values (see [`BatchValueId`][albert.resources.batch_data.BatchValueId]).",
"title": "Colid"
},
"batchTotal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The total amount recorded for the batch.",
"title": "Batchtotal"
},
"referenceTotal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference total the batch is compared against.",
"title": "Referencetotal"
},
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null,
"description": "The status of the column."
},
"productTotal": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The total amount of product produced.",
"title": "Producttotal"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the parent column, when this column is a lot.",
"title": "Parentid"
},
"designColId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the corresponding design column.",
"title": "Designcolid"
},
"Lots": {
"description": "The individual lot columns that make up this product column.",
"items": {
"$ref": "#/$defs/BatchDataColumn"
},
"title": "Lots",
"type": "array"
}
},
"title": "BatchDataColumn",
"type": "object"
},
"Status": {
"description": "The status of a resource.\n\nAttributes\n----------\nACTIVE : str\n The resource is fully operational and visible in normal operations.\nINACTIVE : str\n The resource is hidden from normal operations and disabled from use.",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
}
},
"$ref": "#/$defs/BatchDataColumn"
}
Fields:
-
id(str | None) -
name(str | None) -
col_id(str | None) -
batch_total(str | None) -
reference_total(str | None) -
status(Status | None) -
product_total(float | None) -
parent_id(str | None) -
design_col_id(str | None) -
lots(list[BatchDataColumn])
Bases: BaseResource
The tabular record of how a batch of a formulation was made.
Batch Data is the grid behind a Batch Task
(BatchTask). It pairs formulation component
rows with product columns; each cell holds the amount recorded for that
component in that batch. It is retrieved by the owning Task ID via
BatchDataCollection
(client.batch_data) and is not constructed directly.
Show JSON schema:
{
"$defs": {
"AuditFields": {
"description": "The audit fields for a resource",
"properties": {
"by": {
"default": null,
"title": "By",
"type": "string"
},
"byName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Byname"
},
"at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "At"
}
},
"title": "AuditFields",
"type": "object"
},
"BatchDataColumn": {
"description": "A product column of the batch data grid.\n\nEach column represents the batch/product being manufactured, carrying its\ntotals and any breakdown into individual lots.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the column.",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the product/batch.",
"title": "Name"
},
"colId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The column identifier used to locate values (see [`BatchValueId`][albert.resources.batch_data.BatchValueId]).",
"title": "Colid"
},
"batchTotal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The total amount recorded for the batch.",
"title": "Batchtotal"
},
"referenceTotal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference total the batch is compared against.",
"title": "Referencetotal"
},
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null,
"description": "The status of the column."
},
"productTotal": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The total amount of product produced.",
"title": "Producttotal"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the parent column, when this column is a lot.",
"title": "Parentid"
},
"designColId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the corresponding design column.",
"title": "Designcolid"
},
"Lots": {
"description": "The individual lot columns that make up this product column.",
"items": {
"$ref": "#/$defs/BatchDataColumn"
},
"title": "Lots",
"type": "array"
}
},
"title": "BatchDataColumn",
"type": "object"
},
"BatchDataRow": {
"description": "A row of the batch data grid, typically a formulation component.\n\nEach row represents an ingredient (or a sub-formula) that goes into the\nbatch, together with the amounts recorded for it across the product columns.\nSub-formulas expand into nested child rows.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the row.",
"title": "Id"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The row identifier used to locate values (see [`BatchValueId`][albert.resources.batch_data.BatchValueId]).",
"title": "Rowid"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type of the row.",
"title": "Type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the component the row represents.",
"title": "Name"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The manufacturer of the component, when known.",
"title": "Manufacturer"
},
"unitCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of unit the row's amounts are expressed in.",
"title": "Unitcategory"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of the component.",
"title": "Category"
},
"isFormula": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the row represents a formula (as opposed to a raw material).",
"title": "Isformula"
},
"isLotParent": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the row groups lots as a parent row.",
"title": "Islotparent"
},
"Values": {
"description": "The recorded amounts for this row, one per product column.",
"items": {
"$ref": "#/$defs/BatchDataValue"
},
"title": "Values",
"type": "array"
},
"ChildRows": {
"description": "Nested rows, e.g. the components of a sub-formula.",
"items": {
"$ref": "#/$defs/BatchDataRow"
},
"title": "Childrows",
"type": "array"
}
},
"title": "BatchDataRow",
"type": "object"
},
"BatchDataValue": {
"description": "A single recorded amount within the batch data grid.\n\nRepresents the value of one row within one product column (a cell of the\ngrid), such as the amount of an ingredient used in a given batch.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the value.",
"title": "Id"
},
"colId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of the product column this value belongs to.",
"title": "Colid"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type of the value.",
"title": "Type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The display name associated with the value.",
"title": "Name"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The recorded amount.",
"title": "Value"
},
"isEditable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the value can be edited.",
"title": "Iseditable"
},
"unitCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of unit the value is expressed in.",
"title": "Unitcategory"
},
"referenceValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference amount the value is compared against.",
"title": "Referencevalue"
}
},
"title": "BatchDataValue",
"type": "object"
},
"Status": {
"description": "The status of a resource.\n\nAttributes\n----------\nACTIVE : str\n The resource is fully operational and visible in normal operations.\nINACTIVE : str\n The resource is hidden from normal operations and disabled from use.",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
}
},
"description": "The tabular record of how a batch of a formulation was made.\n\nBatch Data is the grid behind a Batch Task\n([`BatchTask`][albert.resources.tasks.BatchTask]). It pairs formulation component\nrows with product columns; each cell holds the amount recorded for that\ncomponent in that batch. It is retrieved by the owning Task ID via\n[`BatchDataCollection`][albert.collections.batch_data.BatchDataCollection]\n(``client.batch_data``) and is not constructed directly.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null,
"description": "The status of the resource, optional."
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null,
"description": "Audit fields for the creation of the resource, optional."
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null,
"description": "Audit fields for the update of the resource, optional."
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The Task ID of the owning batch task (format ``TAS...``).",
"title": "Albertid"
},
"size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of row entries in the batch data.",
"title": "Size"
},
"lastKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Pagination cursor for fetching the next page of rows; pass it back as ``start_key`` to [`get_by_id`][albert.collections.batch_data.BatchDataCollection.get_by_id].",
"title": "Lastkey"
},
"Product": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BatchDataColumn"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The product columns, one per batch/product being manufactured.",
"title": "Product"
},
"Rows": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BatchDataRow"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The formulation component rows.",
"title": "Rows"
}
},
"title": "BatchData",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
id(TaskId | None) -
size(int | None) -
last_key(str | None) -
product(list[BatchDataColumn] | None) -
rows(list[BatchDataRow] | None)
last_key: str | None = None
Pagination cursor for fetching the next page of rows; pass it back as start_key to get_by_id.
product: list[BatchDataColumn] | None = None
The product columns, one per batch/product being manufactured.